ceph/doc/mgr/zabbix.rst
Wido den Hollander 2281bfd54d
mgr/zabbix: Use fsid as identifier with Zabbix if none is set
Users can still override this parameter, but by default the fsid
of the cluster will be used to send data to Zabbix.

This makes it even easier to use the Zabbix module.

Signed-off-by: Wido den Hollander <wido@42on.com>
2017-12-19 13:53:48 +01:00

121 lines
2.5 KiB
ReStructuredText

Zabbix plugin
=============
The Zabbix plugin actively sends information to a Zabbix server like:
- Ceph status
- I/O operations
- I/O bandwidth
- OSD status
- Storage utilization
Requirements
------------
The plugin requires that the *zabbix_sender* executable is present on *all*
machines running ceph-mgr. It can be installed on most distributions using
the package manager.
Dependencies
^^^^^^^^^^^^
Installing zabbix_sender can be done under Ubuntu or CentOS using either apt
or dnf.
On Ubuntu Xenial:
::
apt install zabbix-agent
On Fedora:
::
dnf install zabbix-sender
Enabling
--------
You can enable the *zabbix* module with:
::
ceph mgr module enable zabbix
Configuration
-------------
Two configuration keys are vital for the module to work:
- zabbix_host
- identifier (optional)
The parameter *zabbix_host* controls the hostname of the Zabbix server to which
*zabbix_sender* will send the items. This can be a IP-Address if required by
your installation.
The *identifier* parameter controls the identifier/hostname to use as source
when sending items to Zabbix. This should match the name of the *Host* in
your Zabbix server.
When the *identifier* parameter is not configured the ceph-<fsid> of the cluster
will be used when sending data to Zabbix.
This would for example be *ceph-c4d32a99-9e80-490f-bd3a-1d22d8a7d354*
Additional configuration keys which can be configured and their default values:
- zabbix_port: 10051
- zabbix_sender: /usr/bin/zabbix_sender
- interval: 60
Configuration keys
^^^^^^^^^^^^^^^^^^^
Configuration keys can be set on any machine with the proper cephx credentials,
these are usually Monitors where the *client.admin* key is present.
::
ceph zabbix config-set <key> <value>
For example:
::
ceph zabbix config-set zabbix_host zabbix.localdomain
ceph zabbix config-set identifier ceph.eu-ams02.local
The current configuration of the module can also be shown:
::
ceph zabbix config-show
Manually sending data
---------------------
If needed the module can be asked to send data immediately instead of waiting for
the interval.
This can be done with this command:
::
ceph zabbix send
The module will now send its latest data to the Zabbix server.
Debugging
---------
Should you want to debug the Zabbix module increase the logging level for
ceph-mgr and check the logs.
::
[mgr]
debug mgr = 20
With logging set to debug for the manager the plugin will print various logging
lines prefixed with *mgr[zabbix]* for easy filtering.