view mod_http_stats_stream/README.markdown @ 4491:35381608d323

mod_s2s_auth_dane: Fix traceback in DANE-TA check because unpack() moved It moved into the table package in Lua 5.2, error happens when compat is disabled or gone (ie 5.3+). This happened in DANE-TA, which is disabled by default.
author Kim Alvefur <zash@zash.se>
date Wed, 03 Mar 2021 11:51:39 +0100
parents 740870196b97
children bac3dae031ee
line wrap: on
line source

---
depends:
- 'mod\_http'
provides:
- http
---

# Introduction

This module provides a streaming interface to [Prosodys internal statistics][doc:statistics] via
[Server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events).

## Example

```js
var evtSource = new EventSource("/stats_stream");

/*
 * An event with all current statistics in the form of a JSON object.
 * Normally sent only once, when first connected to the stream.
 */
evtSource.addEventListener("stats-full", function(e) {
	var initial_stats = JSON.parse(e.data);
	console.log(initial_stats);
}, false);

/*
 * An event containing only statistics that have changed since the last
 * 'stats-full' or 'stats-updated' event.
 */
evtSource.addEventListener("stats-updated", function(e) {
	var updated_stats = JSON.parse(e.data);
	console.log(updated_stats);
}, false);
```

# Compatibility

Prosody \>= 0.11.0