Gitiles
Code Review Sign In
gerrit.mcp.mirantis.com / salt-formulas / heka / c6d6df6eb1a2343ccd81bc77616091f9e279f4e6 / . / README.rst
blob: fa84749df572b740b65a5158da20f51cbd1e733c [file] [log] [blame]
Jakub Pavlike7d12cd2015-09-03 19:02:45 +0200[diff] [blame]1
2============
3Heka Formula
4============
5
Ales Komarekc9a3eb12016-10-12 11:17:55 +0200[diff] [blame]6Heka 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 +0200[diff] [blame]7
8Sample pillars
9==============
10
Ales Komarekc9a3eb12016-10-12 11:17:55 +0200[diff] [blame]11Log collector service
jan kaufman1002cd92015-09-16 16:30:48 +0200[diff] [blame]12
Jakub Pavlike7d12cd2015-09-03 19:02:45 +0200[diff] [blame]13.. code-block:: yaml
14
15 heka:
Ales Komarekc9a3eb12016-10-12 11:17:55 +0200[diff] [blame]16 log_collector:
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]17 automatic_starting: true
18 elasticsearch_host: 172.16.10.253
19 elasticsearch_port: 9200
Jakub Pavlike7d12cd2015-09-03 19:02:45 +0200[diff] [blame]20 enabled: true
Éric Lemoinec6d6df62016-12-06 14:19:58 +0000[diff] [blame^]21 metric_collector_host: 127.0.0.1
22 metric_collector_port: 5567
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]23 poolsize: 100
jan kaufman1002cd92015-09-16 16:30:48 +0200[diff] [blame]24
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]25Default values:
26
27* ``automatic_starting: true``
28* ``elastisearch_port: 9200``
29* ``enabled: false``
Éric Lemoinec6d6df62016-12-06 14:19:58 +0000[diff] [blame^]30* ``metric_collector_host: 127.0.0.1``
31* ``metric_collector_port: 5567``
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]32* ``poolsize: 100``
33
34Local Metric collector service
jan kaufman1002cd92015-09-16 16:30:48 +0200[diff] [blame]35
36.. code-block:: yaml
37
jan kaufman1002cd92015-09-16 16:30:48 +0200[diff] [blame]38 heka:
Ales Komarekc9a3eb12016-10-12 11:17:55 +0200[diff] [blame]39 metric_collector:
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]40 aggregator_host: 172.16.20.253
41 aggregator_port: 5565
42 automatic_starting: true
jan kaufman1002cd92015-09-16 16:30:48 +0200[diff] [blame]43 enabled: true
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]44 influxdb_database: lma
45 influxdb_host: 172.16.10.101
46 influxdb_password: lmapass
47 influxdb_port: 8086
48 influxdb_time_precision: ms
49 influxdb_timeout: 500
50 influxdb_username: lma
51 nagios_host: 172.16.20.253
52 nagios_host_dimension_key: nagios_host
53 nagios_password: secret
54 nagios_port: 5601
55 nagios_username: nagiosadmin
56 poolsize: 100
57
58Default values:
59
60* ``aggregator_port: 5565``
61* ``automatic_starting: true``
62* ``enabled: false``
63* ``influxdb_port: 8086``
64* ``influxdb_time_precision: ms``
65* ``influxdb_timeout: 5000``
66* ``nagios_port: 8001``
67* ``poolsize: 100``
68
69Remote Metric Collector service
70
71.. code-block:: yaml
72
73 heka:
74 remote_collector:
75 aggregator_host: 172.16.20.253
76 aggregator_port: 5565
77 amqp_exchange: nova
78 amqp_host: 172.16.10.254
79 amqp_password: workshop
80 amqp_port: 5672
81 amqp_user: openstack
82 amqp_vhost: /openstack
83 automatic_starting: false
84 elasticsearch_host: 172.16.10.253
85 elasticsearch_port: 9200
86 enabled: true
87 influxdb_database: lma
88 influxdb_host: 172.16.10.101
89 influxdb_password: lmapass
90 influxdb_port: 8086
91 influxdb_time_precision: ms
92 influxdb_username: lma
93 poolsize: 100
94
95Default values:
96
97* ``aggregator_port: 5565``
98* ``amqp_exchange: nova``
99* ``automatic_starting: true``
100* ``elastisearch_port: 9200``
101* ``enabled: false``
102* ``influxdb_port: 8086``
103* ``influxdb_time_precision: ms``
104* ``influxdb_timeout: 5000``
105* ``poolsize: 100``
Ales Komarekc9a3eb12016-10-12 11:17:55 +0200[diff] [blame]106
107Aggregator service
108
109.. code-block:: yaml
110
111 heka:
112 aggregator:
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]113 automatic_starting: false
Ales Komarekc9a3eb12016-10-12 11:17:55 +0200[diff] [blame]114 enabled: true
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]115 influxdb_database: lma
116 influxdb_host: 172.16.10.101
117 influxdb_password: lmapass
118 influxdb_port: 8086
119 influxdb_time_precision: ms
120 influxdb_username: lma
121 nagios_default_host_alarm_clusters: 00-clusters
122 nagios_host: 172.16.20.253
123 nagios_host_dimension_key: nagios_host
124 nagios_password: secret
125 nagios_port: 5601
126 nagios_username: nagiosadmin
127 poolsize: 100
Ales Komarekc9a3eb12016-10-12 11:17:55 +0200[diff] [blame]128
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]129Default values:
130
131* ``automatic_starting: true``
132* ``enabled: false``
133* ``influxdb_port: 8086``
134* ``influxdb_time_precision: ms``
135* ``influxdb_timeout: 5000``
136* ``nagios_port: 8001``
137* ``nagios_default_host_alarm_clusters: 00-clusters``
138* ``poolsize: 100``
139
140Ceilometer service
141
142.. code-block:: yaml
143
144 heka:
145 ceilometer_collector:
146 elasticsearch_host: 172.16.10.253
147 elasticsearch_port: 9200
148 enabled: true
149 influxdb_database: lma
150 influxdb_host: 172.16.10.101
151 influxdb_password: lmapass
152 influxdb_port: 8086
153 influxdb_time_precision: ms
154 influxdb_username: lma
155 resource_decoding: false
156 rabbit_host: 172.16.10.253
157 rabbit_port: 5672
158 rabbit_queue: metering.sample
159 rabbit_vhost: /openstack
160
161Default values:
162
163* ``elastisearch_port: 9200``
164* ``enabled: false``
165* ``influxdb_port: 8086``
166* ``influxdb_time_precision: ms``
167* ``influxdb_timeout: 5000``
168* ``rabbit_port: 5672``
169* ``rabbit_vhost: /openstack``
170* ``rabbit_queue: metering.sample``
171* ``resource_decoding: false``
Jakub Pavlike7d12cd2015-09-03 19:02:45 +0200[diff] [blame]172
173Read more
174=========
175
jan kaufman1002cd92015-09-16 16:30:48 +0200[diff] [blame]176* https://hekad.readthedocs.org/en/latest/index.html