Merge pull request #254 from ceph/bz1842390
[cephmetrics.git] / README
1 On the ceph node install collectd
2 - tested with collectd-5.7.0-4.el7ost.x86_64
3
4 Interval is set to 10 in collectd.conf
5
6 write_graphite plugin configured as follows;
7
8 LoadPlugin "write_graphite"
9 <Plugin write_graphite>
10   <Node "local">
11     Host "192.168.1.52"
12     Port "2003"
13     Protocol "tcp"
14     LogSendErrors true
15     Prefix "collectd."
16     StoreRates true
17     AlwaysAppendDS false
18     EscapeCharacter "_"
19     PreserveSeparator true
20     SeparateInstances true
21   </Node>
22 </Plugin>
23
24 5.7 introduces the PreserveSeparator parm, allowing the type instance name to
25 contain '.'. At the moment I used .'s in the metric name since the same plugin
26 provides all metrics.
27
28 Comments welcome!
29
30 This is what an entry looks like as seen in influx
31 collectd.obj-mon-1.storage.lab.cephmetrics.gauge.ceph.pools._rgw_root.num_bytes_recovered
32         |                     |            \     \    \     \
33         |                     |             \     \    \     \
34         |                     |              |     \    \      \
35 prefix  | hostname            |  plugin name | type |ceph|metric| metric name
36                                                      name  group
37
38 In the case of pools, the metric name is prefixed by the pool name
39
40 Added cephmetrics.conf to /etc/collectd.d dir
41
42 mkdir -p /usr/lib64/collectd/python-plugins
43
44 to the plugin dir, I copied
45  - cephmetrics.py
46  - collectors dir
47
48
49 Known Issues
50 1. Singlestat panels don't track the graph panel values 100% of the time
51
52
53
54
55 Container Configuration - pulled from docker.io registry
56 - grafana - grafana/grafana (official image)
57 - graphite - nickstenning/graphite - https://hub.docker.com/r/nickstenning/graphite/
58