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 | |
| c07f9fc5 | 13 | ------------ |
| 224ce89b WB |
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 | |
| c07f9fc5 | 20 | ^^^^^^^^^^^^ |
| 224ce89b WB |
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 | |
| c07f9fc5 | 38 | -------- |
| 224ce89b WB |
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 | |
| c07f9fc5 | 53 | ------------- |
| 224ce89b | 54 | |
| 94b18763 | 55 | Two configuration keys are vital for the module to work: |
| 224ce89b | 56 | |
| 94b18763 FG |
57 | - zabbix_host |
| 58 | - identifier (optional) | |
| 224ce89b WB |
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 | ||
| 94b18763 FG |
68 | When the *identifier* parameter is not configured the ceph-<fsid> of the cluster |
| 69 | will be used when sending data to Zabbix. | |
| 70 | ||
| 71 | This would for example be *ceph-c4d32a99-9e80-490f-bd3a-1d22d8a7d354* | |
| 72 | ||
| 224ce89b WB |
73 | Additional configuration keys which can be configured and their default values: |
| 74 | ||
| 75 | - mgr/zabbix/zabbix_port: 10051 | |
| 76 | - mgr/zabbix/zabbix_sender: /usr/bin/zabbix_sender | |
| 77 | - mgr/zabbix/interval: 60 | |
| 78 | ||
| c07f9fc5 FG |
79 | Configuration keys |
| 80 | ^^^^^^^^^^^^^^^^^^^ | |
| 224ce89b WB |
81 | |
| 82 | Configuration keys can be set on any machine with the proper cephx credentials, | |
| 83 | these are usually Monitors where the *client.admin* key is present. | |
| 84 | ||
| 85 | :: | |
| 86 | ||
| c07f9fc5 | 87 | ceph config-key set <key> <value> |
| 224ce89b WB |
88 | |
| 89 | For example: | |
| 90 | ||
| 91 | :: | |
| 92 | ||
| c07f9fc5 FG |
93 | ceph config-key set mgr/zabbix/zabbix_host zabbix.localdomain |
| 94 | ceph config-key set mgr/zabbix/identifier ceph.eu-ams02.local | |
| 224ce89b WB |
95 | |
| 96 | Debugging | |
| c07f9fc5 | 97 | --------- |
| 224ce89b WB |
98 | |
| 99 | Should you want to debug the Zabbix module increase the logging level for | |
| 100 | ceph-mgr and check the logs. | |
| 101 | ||
| 102 | :: | |
| 103 | ||
| 104 | [mgr] | |
| 105 | debug mgr = 20 | |
| 106 | ||
| 107 | With logging set to debug for the manager the plugin will print various logging | |
| 108 | lines prefixed with *mgr[zabbix]* for easy filtering. | |
| 109 |