view mod_http_host_status_check/README.markdown @ 4976:75b6e5df65f9

various: Improve error reporting if missing file server module on 0.12 If there is some error loading net.http.files then it would be swallowed by the pcall and then it would proceed to trying mod_http_files, which might cause unexpected behavior on 0.12 Ref #1765
author Kim Alvefur <zash@zash.se>
date Mon, 18 Jul 2022 22:47:54 +0200
parents 2a16a6c67288
children 694b62d8a82f
line wrap: on
line source

---
labels: Stage-Beta
summary: HTTP Host Status Check
...

Introduction
============

This module exposes serves over HTTP the information collected by [mod\_host\_status\_check] and
[mod\_host\_status\_heartbeat] in a convenient format for automated monitoring tools.

Configuration
=============

[mod\_http\_status\_check] relies on Prosodys HTTP server and mod\_http for
serving HTTP requests. See [Prosodys HTTP server
documentation][doc:http] for information about how to
configure ports, HTTP Host names etc.

Simply add this module to modules\_enabled for the host you would like to serve it from.

There is a single configuration option:

``` {.lua}
    -- The maximum number of seconds that a host can go without sending a heartbeat,
    -- before we mark it as TIMEOUT (default: 5)
    status_check_heartbeat_threshold = 5;
```

Compatibility
=============

Works with Prosody 0.9.x and later.