blob: 8b71fdd616ec97d4e143a0b86f2b2812d21931d0 [file] [log] [blame]
Jakub Pavlike7d12cd2015-09-03 19:02:45 +02001
2============
3Heka Formula
4============
5
Ales Komarekc9a3eb12016-10-12 11:17:55 +02006Heka is an open source stream processing software system developed by Mozilla. Heka is a Swiss Army Knife type tool for data processing.
Jakub Pavlike7d12cd2015-09-03 19:02:45 +02007
8Sample pillars
9==============
10
Ales Komarekc9a3eb12016-10-12 11:17:55 +020011Log collector service
jan kaufman1002cd92015-09-16 16:30:48 +020012
Jakub Pavlike7d12cd2015-09-03 19:02:45 +020013.. code-block:: yaml
14
15 heka:
Ales Komarekc9a3eb12016-10-12 11:17:55 +020016 log_collector:
Éric Lemoine0aba3fd2016-12-06 10:36:39 +000017 automatic_starting: true
18 elasticsearch_host: 172.16.10.253
19 elasticsearch_port: 9200
Jakub Pavlike7d12cd2015-09-03 19:02:45 +020020 enabled: true
Éric Lemoine0aba3fd2016-12-06 10:36:39 +000021 poolsize: 100
jan kaufman1002cd92015-09-16 16:30:48 +020022
Éric Lemoine0aba3fd2016-12-06 10:36:39 +000023Default values:
24
25* ``automatic_starting: true``
26* ``elastisearch_port: 9200``
27* ``enabled: false``
28* ``poolsize: 100``
29
30Local Metric collector service
jan kaufman1002cd92015-09-16 16:30:48 +020031
32.. code-block:: yaml
33
jan kaufman1002cd92015-09-16 16:30:48 +020034 heka:
Ales Komarekc9a3eb12016-10-12 11:17:55 +020035 metric_collector:
Éric Lemoine0aba3fd2016-12-06 10:36:39 +000036 aggregator_host: 172.16.20.253
37 aggregator_port: 5565
38 automatic_starting: true
jan kaufman1002cd92015-09-16 16:30:48 +020039 enabled: true
Éric Lemoine0aba3fd2016-12-06 10:36:39 +000040 influxdb_database: lma
41 influxdb_host: 172.16.10.101
42 influxdb_password: lmapass
43 influxdb_port: 8086
44 influxdb_time_precision: ms
45 influxdb_timeout: 500
46 influxdb_username: lma
47 nagios_host: 172.16.20.253
48 nagios_host_dimension_key: nagios_host
49 nagios_password: secret
50 nagios_port: 5601
51 nagios_username: nagiosadmin
52 poolsize: 100
53
54Default values:
55
56* ``aggregator_port: 5565``
57* ``automatic_starting: true``
58* ``enabled: false``
59* ``influxdb_port: 8086``
60* ``influxdb_time_precision: ms``
61* ``influxdb_timeout: 5000``
62* ``nagios_port: 8001``
63* ``poolsize: 100``
64
65Remote Metric Collector service
66
67.. code-block:: yaml
68
69 heka:
70 remote_collector:
71 aggregator_host: 172.16.20.253
72 aggregator_port: 5565
73 amqp_exchange: nova
74 amqp_host: 172.16.10.254
75 amqp_password: workshop
76 amqp_port: 5672
77 amqp_user: openstack
78 amqp_vhost: /openstack
79 automatic_starting: false
80 elasticsearch_host: 172.16.10.253
81 elasticsearch_port: 9200
82 enabled: true
83 influxdb_database: lma
84 influxdb_host: 172.16.10.101
85 influxdb_password: lmapass
86 influxdb_port: 8086
87 influxdb_time_precision: ms
88 influxdb_username: lma
89 poolsize: 100
90
91Default values:
92
93* ``aggregator_port: 5565``
94* ``amqp_exchange: nova``
Éric Lemoined1be7c92016-12-06 13:18:29 +000095* ``amqp_port: 5672``
96* ``amqp_vhost: ''``
Éric Lemoine0aba3fd2016-12-06 10:36:39 +000097* ``automatic_starting: true``
98* ``elastisearch_port: 9200``
99* ``enabled: false``
100* ``influxdb_port: 8086``
101* ``influxdb_time_precision: ms``
102* ``influxdb_timeout: 5000``
103* ``poolsize: 100``
Ales Komarekc9a3eb12016-10-12 11:17:55 +0200104
105Aggregator service
106
107.. code-block:: yaml
108
109 heka:
110 aggregator:
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000111 automatic_starting: false
Ales Komarekc9a3eb12016-10-12 11:17:55 +0200112 enabled: true
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000113 influxdb_database: lma
114 influxdb_host: 172.16.10.101
115 influxdb_password: lmapass
116 influxdb_port: 8086
117 influxdb_time_precision: ms
118 influxdb_username: lma
119 nagios_default_host_alarm_clusters: 00-clusters
120 nagios_host: 172.16.20.253
121 nagios_host_dimension_key: nagios_host
122 nagios_password: secret
123 nagios_port: 5601
124 nagios_username: nagiosadmin
125 poolsize: 100
Ales Komarekc9a3eb12016-10-12 11:17:55 +0200126
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000127Default values:
128
129* ``automatic_starting: true``
130* ``enabled: false``
131* ``influxdb_port: 8086``
132* ``influxdb_time_precision: ms``
133* ``influxdb_timeout: 5000``
134* ``nagios_port: 8001``
135* ``nagios_default_host_alarm_clusters: 00-clusters``
136* ``poolsize: 100``
137
138Ceilometer service
139
140.. code-block:: yaml
141
142 heka:
143 ceilometer_collector:
144 elasticsearch_host: 172.16.10.253
145 elasticsearch_port: 9200
146 enabled: true
147 influxdb_database: lma
148 influxdb_host: 172.16.10.101
149 influxdb_password: lmapass
150 influxdb_port: 8086
151 influxdb_time_precision: ms
152 influxdb_username: lma
153 resource_decoding: false
154 rabbit_host: 172.16.10.253
155 rabbit_port: 5672
156 rabbit_queue: metering.sample
157 rabbit_vhost: /openstack
158
159Default values:
160
Éric Lemoined1be7c92016-12-06 13:18:29 +0000161* ``automatic_starting: true``
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000162* ``elastisearch_port: 9200``
163* ``enabled: false``
164* ``influxdb_port: 8086``
165* ``influxdb_time_precision: ms``
166* ``influxdb_timeout: 5000``
Éric Lemoined1be7c92016-12-06 13:18:29 +0000167* ``poolsize: 100``
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000168* ``rabbit_port: 5672``
169* ``rabbit_vhost: /openstack``
170* ``rabbit_queue: metering.sample``
171* ``resource_decoding: false``
Jakub Pavlike7d12cd2015-09-03 19:02:45 +0200172
173Read more
174=========
175
jan kaufman1002cd92015-09-16 16:30:48 +0200176* https://hekad.readthedocs.org/en/latest/index.html