projects / ceph.git / blame
| Commit | Line | Data |
|---|---|---|
| 224ce89b WB |
1 | Zabbix plugin |
| 2 | ============= | |
| 3 | ||
| 4 | The Zabbix plugin actively sends information to a Zabbix server like: | |
| 5 | ||
| 6 | - Ceph status | |
| 7 | - I/O operations | |
| 8 | - I/O bandwidth | |
| 9 | - OSD status | |
| 10 | - Storage utilization | |
| 11 | ||
| 12 | Requirements | |
| 13 | ============ | |
| 14 | ||
| 15 | The plugin requires that the *zabbix_sender* executable is present on *all* | |
| 16 | machines running ceph-mgr. It can be installed on most distributions using | |
| 17 | the package manager. | |
| 18 | ||
| 19 | Dependencies | |
| 20 | ------------ | |
| 21 | Installing zabbix_sender can be done under Ubuntu or CentOS using either apt | |
| 22 | or dnf. | |
| 23 | ||
| 24 | On Ubuntu Xenial: | |
| 25 | ||
| 26 | :: | |
| 27 | ||
| 28 | apt install zabbix-agent | |
| 29 | ||
| 30 | On Fedora: | |
| 31 | ||
| 32 | :: | |
| 33 | ||
| 34 | dnf install zabbix-sender | |
| 35 | ||
| 36 | ||
| 37 | Enabling | |
| 38 | ======== | |
| 39 | ||
| 40 | Add this to your ceph.conf on nodes where you run ceph-mgr: | |
| 41 | ||
| 42 | :: | |
| 43 | ||
| 44 | [mgr] | |
| 45 | mgr modules = zabbix | |
| 46 | ||
| 47 | If you use any other ceph-mgr modules, make sure they're in the list too. | |
| 48 | ||
| 49 | Restart the ceph-mgr daemon after modifying the setting to load the module. | |
| 50 | ||
| 51 | ||
| 52 | Configuration | |
| 53 | ============= | |
| 54 | ||
| 55 | Two configuration keys are mandatory for the module to work: | |
| 56 | ||
| 57 | - mgr/zabbix/zabbix_host | |
| 58 | - mgr/zabbix/identifier | |
| 59 | ||
| 60 | The parameter *zabbix_host* controls the hostname of the Zabbix server to which | |
| 61 | *zabbix_sender* will send the items. This can be a IP-Address if required by | |
| 62 | your installation. | |
| 63 | ||
| 64 | The *identifier* parameter controls the identifier/hostname to use as source | |
| 65 | when sending items to Zabbix. This should match the name of the *Host* in | |
| 66 | your Zabbix server. | |
| 67 | ||
| 68 | Additional configuration keys which can be configured and their default values: | |
| 69 | ||
| 70 | - mgr/zabbix/zabbix_port: 10051 | |
| 71 | - mgr/zabbix/zabbix_sender: /usr/bin/zabbix_sender | |
| 72 | - mgr/zabbix/interval: 60 | |
| 73 | ||
| 74 | Configurations keys | |
| 75 | ------------------- | |
| 76 | ||
| 77 | Configuration keys can be set on any machine with the proper cephx credentials, | |
| 78 | these are usually Monitors where the *client.admin* key is present. | |
| 79 | ||
| 80 | :: | |
| 81 | ||
| 82 | ceph config-key put <key> <value> | |
| 83 | ||
| 84 | For example: | |
| 85 | ||
| 86 | :: | |
| 87 | ||
| 88 | ceph config-key put mgr/zabbix/zabbix_host zabbix.localdomain | |
| 89 | ceph config-key put mgr/zabbix/identifier ceph.eu-ams02.local | |
| 90 | ||
| 91 | Debugging | |
| 92 | ========= | |
| 93 | ||
| 94 | Should you want to debug the Zabbix module increase the logging level for | |
| 95 | ceph-mgr and check the logs. | |
| 96 | ||
| 97 | :: | |
| 98 | ||
| 99 | [mgr] | |
| 100 | debug mgr = 20 | |
| 101 | ||
| 102 | With logging set to debug for the manager the plugin will print various logging | |
| 103 | lines prefixed with *mgr[zabbix]* for easy filtering. | |
| 104 |