ejabberd-contrib/ejabberd_observer_cli
Badlop 04f4489427 Convert modules README.txt to markdown syntax 2022-08-12 10:45:09 +02:00
..
src Fix compilation and Xref warnings 2022-07-27 18:14:29 +02:00
COPYING New ejabberd_observer_cli, provides plugins for observer_cli 2022-07-13 11:42:31 +02:00
README.md Convert modules README.txt to markdown syntax 2022-08-12 10:45:09 +02:00
ejabberd_observer_cli.spec New ejabberd_observer_cli, provides plugins for observer_cli 2022-07-13 11:42:31 +02:00
rebar.config New ejabberd_observer_cli, provides plugins for observer_cli 2022-07-13 11:42:31 +02:00

README.md

ejabberd observer_cli plugins

observer_cli is an erlang tool to visualize Erlang node statistics on the command line.

This directory contains several plugins specifically written to view statistics of ejabberd.

To install this, just run:

ejabberdctl module_install ejabberd_observer_cli

It will automatically download, compile and install the required dependencies: observer_cli, recon, and the additional plugin os_stats.

Then, start an erlang shell attached to your ejabberd node, for example:

ejabberdctl debug

in that erlang shell execute:

ejabberd_observer_cli:start().

If using Elixir (for example when started with ejabberdctl iexdebug, run:

:ejabberd_observer_cli.start()

To sort columns or change between the different pages, type the corresponding letter and hit Enter. For example, to view MUC statistics, type: M and then Enter.

There is no configuration required.