blob: e5696354943ad81d905a6cbda00836839f56afe9 [file] [log] [blame]
Aleš Komárek7caca3c2017-02-06 15:45:15 +01001================
2Collectd formula
3================
Filip Pytloun6d4b7a22015-10-06 16:28:31 +02004
Ales Komarek28f26b32015-12-03 22:23:28 +01005Collectd is a daemon which collects system performance statistics periodically and provides mechanisms to store the values in a variety of ways, for example in RRD files.
Filip Pytloun6d4b7a22015-10-06 16:28:31 +02006
7Sample pillars
8==============
9
Ales Komarek2675e842016-10-05 00:10:44 +020010Data writers
11------------
12
Ales Komarek60fe7792015-11-19 09:45:42 +010013Send data over TCP to Graphite Carbon
Filip Pytloun6d4b7a22015-10-06 16:28:31 +020014
15.. code-block:: yaml
16
17 collectd:
18 client:
19 enabled: true
20 read_interval: 60
Ales Komarek60fe7792015-11-19 09:45:42 +010021 backend:
Ales Komarek2675e842016-10-05 00:10:44 +020022 carbon_service:
23 engine: carbon
Ales Komarek60fe7792015-11-19 09:45:42 +010024 host: carbon1.comain.com
25 port: 2003
Filip Pytloun6d4b7a22015-10-06 16:28:31 +020026
27Send data over AMQP
28
29.. code-block:: yaml
30
31 collectd:
32 client:
33 enabled: true
34 read_interval: 60
Ales Komarek60fe7792015-11-19 09:45:42 +010035 backend:
Ales Komarek2675e842016-10-05 00:10:44 +020036 amqp_broker:
37 engine: amqp
Ales Komarek60fe7792015-11-19 09:45:42 +010038 host: broker1.comain.com
39 port: 5672
40 user: monitor
41 password: amqp-pwd
Ales Komarek2675e842016-10-05 00:10:44 +020042 virtual_host: '/monitor'
43
44Send data over HTTP
45
46.. code-block:: yaml
47
48 collectd:
49 client:
50 enabled: true
51 read_interval: 60
52 backend:
53 http_service:
54 engine: http
55 host: service.comain.com
56 port: 8123
57
58
59Data collectors
60---------------
61
Ales Komarek60fe7792015-11-19 09:45:42 +010062Monitor network devices, defined in 'external' dictionary
Filip Pytloun6d4b7a22015-10-06 16:28:31 +020063
64.. code-block:: yaml
65
Ales Komarek60fe7792015-11-19 09:45:42 +010066 external:
67 network_device:
68 MX80-01:
69 community: test
70 model: Juniper_MX80
Pavel Cizinsky8cb06bd2018-12-12 12:01:20 +010071 management:
Ales Komarek60fe7792015-11-19 09:45:42 +010072 address: 10.0.0.254
73 port: fxp01
74 engine: snmp/ssh
75 interface:
76 xe-0/0/0:
77 description: MEMBER-OF-LACP-TO-QFX
78 type: 802.3ad
79 subinterface:
80 xe-0/0/0.0:
81 description: MEMBER-OF-LACP-TO-QFX
Filip Pytloun6d4b7a22015-10-06 16:28:31 +020082 collectd:
83 client:
84 enabled: true
Ales Komarek60fe7792015-11-19 09:45:42 +010085 ...
Filip Pytloun6d4b7a22015-10-06 16:28:31 +020086
Ales Komarek5831a2d2016-06-06 11:54:06 +020087Collecting the SNMP metrics
88
89.. code-block:: yaml
90
91 collectd:
92 client:
93 data:
94 connected_devices:
95 type: devices
96 values:
97 - IF-MIB::ifNumber.0
98 host:
99 ubiquity:
100 address: 10.0.0.1
101 community: public
102 version: 2
103 data:
104 - connected_devices
105
Ales Komarek4550e8c2016-09-28 22:20:28 +0200106Collecting the cURL response times and codes
107
108.. code-block:: yaml
109
110 collectd:
111 client:
112 check:
113 curl:
114 service1:
115 url: "https://service.domain.com:443/"
116 service2:
117 url: "https://service.domain.com:443/"
118
Ales Komarek4550e8c2016-09-28 22:20:28 +0200119Collecting the ping response times
120
121.. code-block:: yaml
122
123 collectd:
124 client:
125 check:
126 ping:
127 host_label1:
128 host: "172.10.31.14"
129 host_label2:
130 host: "172.10.31.12"
131
Aleš Komárek7caca3c2017-02-06 15:45:15 +0100132External links
133==============
Filip Pytloun6d4b7a22015-10-06 16:28:31 +0200134
135* http://collectd.org/documentation.shtml
136* http://www.canopsis.org/2013/02/collectd-graphite/
137* http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_libvirt
138* http://libvirt.org/uri.html#URI_qemu