view mod_http_host_status_check/README.markdown @ 5963:c61a82f80e57 default tip

mod_pubsub_serverinfo: Reference workaround for issue #1841
author Guus der Kinderen <guus.der.kinderen@gmail.com>
date Wed, 11 Sep 2024 14:02:39 +0200
parents 694b62d8a82f
children
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.