Gitiles
Code Review Sign In
gerrit.mcp.mirantis.com / salt-formulas / heka / fe6e8ba318af20a29c658e9e0079a6ab23864436 / . / README.rst
blob: 33a3bf4073acf22833ffbd47b137e6f72afad55e [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``
Éric Lemoined1be7c92016-12-06 13:18:29 +0000[diff] [blame]99* ``amqp_port: 5672``
100* ``amqp_vhost: ''``
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]101* ``automatic_starting: true``
102* ``elastisearch_port: 9200``
103* ``enabled: false``
104* ``influxdb_port: 8086``
105* ``influxdb_time_precision: ms``
106* ``influxdb_timeout: 5000``
107* ``poolsize: 100``
Ales Komarekc9a3eb12016-10-12 11:17:55 +0200[diff] [blame]108
109Aggregator service
110
111.. code-block:: yaml
112
113 heka:
114 aggregator:
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]115 automatic_starting: false
Ales Komarekc9a3eb12016-10-12 11:17:55 +0200[diff] [blame]116 enabled: true
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]117 influxdb_database: lma
118 influxdb_host: 172.16.10.101
119 influxdb_password: lmapass
120 influxdb_port: 8086
121 influxdb_time_precision: ms
122 influxdb_username: lma
123 nagios_default_host_alarm_clusters: 00-clusters
124 nagios_host: 172.16.20.253
125 nagios_host_dimension_key: nagios_host
126 nagios_password: secret
127 nagios_port: 5601
128 nagios_username: nagiosadmin
129 poolsize: 100
Ales Komarekc9a3eb12016-10-12 11:17:55 +0200[diff] [blame]130
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]131Default values:
132
133* ``automatic_starting: true``
134* ``enabled: false``
135* ``influxdb_port: 8086``
136* ``influxdb_time_precision: ms``
137* ``influxdb_timeout: 5000``
138* ``nagios_port: 8001``
139* ``nagios_default_host_alarm_clusters: 00-clusters``
140* ``poolsize: 100``
141
142Ceilometer service
143
144.. code-block:: yaml
145
146 heka:
147 ceilometer_collector:
148 elasticsearch_host: 172.16.10.253
149 elasticsearch_port: 9200
150 enabled: true
151 influxdb_database: lma
152 influxdb_host: 172.16.10.101
153 influxdb_password: lmapass
154 influxdb_port: 8086
155 influxdb_time_precision: ms
156 influxdb_username: lma
157 resource_decoding: false
Éric Lemoine381d73c2016-12-06 12:28:04 +0000[diff] [blame]158 amqp_exchange: ceilometer
159 amqp_host: 172.16.10.253
160 amqp_port: 5672
161 amqp_queue: metering.sample
162 amqp_vhost: /openstack
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]163
164Default values:
165
Éric Lemoined1be7c92016-12-06 13:18:29 +0000[diff] [blame]166* ``automatic_starting: true``
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]167* ``elastisearch_port: 9200``
168* ``enabled: false``
169* ``influxdb_port: 8086``
170* ``influxdb_time_precision: ms``
171* ``influxdb_timeout: 5000``
Éric Lemoined1be7c92016-12-06 13:18:29 +0000[diff] [blame]172* ``poolsize: 100``
Éric Lemoine381d73c2016-12-06 12:28:04 +0000[diff] [blame]173* ``amqp_exchange: ceilometer``
174* ``amqp_port: 5672``
175* ``amqp_queue: metering.sample``
176* ``amqp_vhost: /openstack``
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]177* ``resource_decoding: false``
Jakub Pavlike7d12cd2015-09-03 19:02:45 +0200[diff] [blame]178
179Read more
180=========
181
jan kaufman1002cd92015-09-16 16:30:48 +0200[diff] [blame]182* https://hekad.readthedocs.org/en/latest/index.html
Filip Pytloun9612dac2017-02-02 13:02:03 +0100[diff] [blame]183
184Documentation and Bugs
185======================
186
187To learn how to install and update salt-formulas, consult the documentation
188available online at:
189
190 http://salt-formulas.readthedocs.io/
191
192In the unfortunate event that bugs are discovered, they should be reported to
193the appropriate issue tracker. Use Github issue tracker for specific salt
194formula:
195
196 https://github.com/salt-formulas/salt-formula-heka/issues
197
198For feature requests, bug reports or blueprints affecting entire ecosystem,
199use Launchpad salt-formulas project:
200
201 https://launchpad.net/salt-formulas
202
203You can also join salt-formulas-users team and subscribe to mailing list:
204
205 https://launchpad.net/~salt-formulas-users
206
207Developers wishing to work on the salt-formulas projects should always base
208their work on master branch and submit pull request against specific formula.
209
210 https://github.com/salt-formulas/salt-formula-heka
211
212Any questions or feedback is always welcome so feel free to join our IRC
213channel:
214
215 #salt-formulas @ irc.freenode.net