mirror of
https://github.com/ceph/ceph
synced 2025-01-04 02:02:36 +00:00
c3149421bc
The documentation currently refers to Ceph Manager Modules as "plugins" in many places, while the command line interface uses "module" to enable/disable modules. Replaced all occurences of "plugin" with "module" in the docs, to avoid confusion and to be in alignment with the CLI. Also fixed the capitalizations of some module chapters. Fixes: https://tracker.ceph.com/issues/38481 Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
128 lines
2.9 KiB
ReStructuredText
128 lines
2.9 KiB
ReStructuredText
Zabbix Module
|
|
=============
|
|
|
|
The Zabbix module actively sends information to a Zabbix server like:
|
|
|
|
- Ceph status
|
|
- I/O operations
|
|
- I/O bandwidth
|
|
- OSD status
|
|
- Storage utilization
|
|
|
|
Requirements
|
|
------------
|
|
|
|
The module 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
|
|
|
|
|
|
Template
|
|
^^^^^^^^
|
|
A `template <https://raw.githubusercontent.com/ceph/ceph/9c54334b615362e0a60442c2f41849ed630598ab/src/pybind/mgr/zabbix/zabbix_template.xml>`_.
|
|
(XML) to be used on the Zabbix server can be found in the source directory of the module.
|
|
|
|
This template contains all items and a few triggers. You can customize the triggers afterwards to fit your needs.
|
|
|
|
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 module will print various logging
|
|
lines prefixed with *mgr[zabbix]* for easy filtering. |