ejabberd-contrib/mod_statsdx
Badlop 04f4489427 Convert modules README.txt to markdown syntax 2022-08-12 10:45:09 +02:00
..
conf Enable some modules when installed, if they work with reasonable default config 2022-07-26 15:41:21 +02:00
src Add mod_status/0 to show its current status in WebAdmin 2022-07-26 15:41:23 +02:00
COPYING Update FSF address (solves #73) 2015-02-25 15:17:31 +01:00
ChangeLog Initial import from ejabberd-modules SVN 2013-04-15 12:03:14 +02:00
README.md Convert modules README.txt to markdown syntax 2022-08-12 10:45:09 +02:00
mod_statsdx.spec Cleanup for module packaging support in ejabberd 2015-03-11 14:19:35 +01:00

README.md

mod_statsdx - Calculates and gathers statistics actively

Measures several statistics. It provides a new section in ejabberd Web Admin and two ejabberd commands to view the information.

Configuration

Enable the module in ejabberd.yml for example with a basic configuration:

modules:
  mod_statsdx: {}

Configurable options:

  • hooks:

    Set to true to enable hooks and related statistics. This option by default false because it is expected to consume many resources in very populated servers. If set to traffic, it will also keep counters of traffic stanzas.

Example Configuration

modules:
  mod_statsdx:
    hooks: true

Feature Requests

  • fix the problem with plain/ssl/tlsusers, it crashes ejabberd
  • traffic: send bytes per second, received bps
  • connections to a transport
  • traffic: send presence per second, received mps
  • Number of SASL c2s connections
  • improve to work in distributed server

mod_stats2file

Generates files with all kind of statistics

This module writes a file with all kind of statistics every few minutes. Available output formats are html (example), text file with descriptions and raw text file (for MRTG, RRDTool...).

Configuration

This module requires mod_statsdx.

Enable the module in ejabberd.yml for example with a basic configuration:

modules:
  mod_stats2file: {}

Configurable options:

  • interval: Time between updates, in minutes (default: 5)
  • type: Type of output. Allowed values: html, txt, dat (default: html)
  • basefilename: Base filename including absolute path (default: "/tmp/ejasta")
  • split: If split the statistics in several files (default: false)
  • hosts: List of virtual hosts that will be checked. By default all

Example Configuration

modules:
  mod_stats2file:
    interval: 60
    type: txt
    split: true
    basefilename: "/var/www/stats"
    hosts: ["localhost", "server3.com"]