Gitiles
Code Review Sign In
gerrit.mcp.mirantis.com / salt-formulas / heka / e6de2ddb7f9cef33f9a0d44908c8317747733239 / . / README.rst
blob: 355c68f2cb8a36ad09b9fb8071e73a7265d8952c [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
Ildar Svetlov07de4412017-08-21 18:26:47 +0400[diff] [blame]24 max_message_size: 262144
jan kaufman1002cd92015-09-16 16:30:48 +0200[diff] [blame]25
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]26Default values:
27
28* ``automatic_starting: true``
29* ``elastisearch_port: 9200``
30* ``enabled: false``
Éric Lemoinec6d6df62016-12-06 14:19:58 +0000[diff] [blame]31* ``metric_collector_host: 127.0.0.1``
32* ``metric_collector_port: 5567``
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]33* ``poolsize: 100``
Ildar Svetlov07de4412017-08-21 18:26:47 +0400[diff] [blame]34* ``max_message_size: 262144``
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]35
36Local Metric collector service
jan kaufman1002cd92015-09-16 16:30:48 +0200[diff] [blame]37
38.. code-block:: yaml
39
jan kaufman1002cd92015-09-16 16:30:48 +0200[diff] [blame]40 heka:
Ales Komarekc9a3eb12016-10-12 11:17:55 +0200[diff] [blame]41 metric_collector:
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]42 aggregator_host: 172.16.20.253
43 aggregator_port: 5565
44 automatic_starting: true
jan kaufman1002cd92015-09-16 16:30:48 +0200[diff] [blame]45 enabled: true
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]46 influxdb_database: lma
47 influxdb_host: 172.16.10.101
48 influxdb_password: lmapass
49 influxdb_port: 8086
50 influxdb_time_precision: ms
51 influxdb_timeout: 500
52 influxdb_username: lma
53 nagios_host: 172.16.20.253
54 nagios_host_dimension_key: nagios_host
55 nagios_password: secret
56 nagios_port: 5601
57 nagios_username: nagiosadmin
58 poolsize: 100
Ildar Svetlov07de4412017-08-21 18:26:47 +0400[diff] [blame]59 max_message_size: 262144
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]60
61Default values:
62
63* ``aggregator_port: 5565``
64* ``automatic_starting: true``
65* ``enabled: false``
66* ``influxdb_port: 8086``
67* ``influxdb_time_precision: ms``
68* ``influxdb_timeout: 5000``
69* ``nagios_port: 8001``
70* ``poolsize: 100``
Ildar Svetlov07de4412017-08-21 18:26:47 +0400[diff] [blame]71* ``max_message_size: 262144``
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]72
73Remote Metric Collector service
74
75.. code-block:: yaml
76
77 heka:
78 remote_collector:
79 aggregator_host: 172.16.20.253
80 aggregator_port: 5565
81 amqp_exchange: nova
82 amqp_host: 172.16.10.254
83 amqp_password: workshop
84 amqp_port: 5672
85 amqp_user: openstack
86 amqp_vhost: /openstack
87 automatic_starting: false
88 elasticsearch_host: 172.16.10.253
89 elasticsearch_port: 9200
90 enabled: true
91 influxdb_database: lma
92 influxdb_host: 172.16.10.101
93 influxdb_password: lmapass
94 influxdb_port: 8086
95 influxdb_time_precision: ms
96 influxdb_username: lma
97 poolsize: 100
Ildar Svetlov07de4412017-08-21 18:26:47 +0400[diff] [blame]98 max_message_size: 262144
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]99
100Default values:
101
102* ``aggregator_port: 5565``
103* ``amqp_exchange: nova``
Éric Lemoined1be7c92016-12-06 13:18:29 +0000[diff] [blame]104* ``amqp_port: 5672``
105* ``amqp_vhost: ''``
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]106* ``automatic_starting: true``
107* ``elastisearch_port: 9200``
108* ``enabled: false``
109* ``influxdb_port: 8086``
110* ``influxdb_time_precision: ms``
111* ``influxdb_timeout: 5000``
112* ``poolsize: 100``
Ildar Svetlov07de4412017-08-21 18:26:47 +0400[diff] [blame]113* ``max_message_size: 262144``
Ales Komarekc9a3eb12016-10-12 11:17:55 +0200[diff] [blame]114
115Aggregator service
116
117.. code-block:: yaml
118
119 heka:
120 aggregator:
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]121 automatic_starting: false
Ales Komarekc9a3eb12016-10-12 11:17:55 +0200[diff] [blame]122 enabled: true
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]123 influxdb_database: lma
124 influxdb_host: 172.16.10.101
125 influxdb_password: lmapass
126 influxdb_port: 8086
127 influxdb_time_precision: ms
128 influxdb_username: lma
129 nagios_default_host_alarm_clusters: 00-clusters
130 nagios_host: 172.16.20.253
131 nagios_host_dimension_key: nagios_host
132 nagios_password: secret
133 nagios_port: 5601
134 nagios_username: nagiosadmin
135 poolsize: 100
Ildar Svetlov07de4412017-08-21 18:26:47 +0400[diff] [blame]136 max_message_size: 262144
Ales Komarekc9a3eb12016-10-12 11:17:55 +0200[diff] [blame]137
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]138Default values:
139
140* ``automatic_starting: true``
141* ``enabled: false``
142* ``influxdb_port: 8086``
143* ``influxdb_time_precision: ms``
144* ``influxdb_timeout: 5000``
145* ``nagios_port: 8001``
146* ``nagios_default_host_alarm_clusters: 00-clusters``
147* ``poolsize: 100``
Ildar Svetlov07de4412017-08-21 18:26:47 +0400[diff] [blame]148* ``max_message_size: 262144``
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]149
150Ceilometer service
151
152.. code-block:: yaml
153
154 heka:
155 ceilometer_collector:
156 elasticsearch_host: 172.16.10.253
157 elasticsearch_port: 9200
158 enabled: true
159 influxdb_database: lma
160 influxdb_host: 172.16.10.101
161 influxdb_password: lmapass
162 influxdb_port: 8086
163 influxdb_time_precision: ms
164 influxdb_username: lma
165 resource_decoding: false
Éric Lemoine381d73c2016-12-06 12:28:04 +0000[diff] [blame]166 amqp_exchange: ceilometer
167 amqp_host: 172.16.10.253
168 amqp_port: 5672
169 amqp_queue: metering.sample
170 amqp_vhost: /openstack
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]171
172Default values:
173
Éric Lemoined1be7c92016-12-06 13:18:29 +0000[diff] [blame]174* ``automatic_starting: true``
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]175* ``elastisearch_port: 9200``
176* ``enabled: false``
177* ``influxdb_port: 8086``
178* ``influxdb_time_precision: ms``
179* ``influxdb_timeout: 5000``
Éric Lemoined1be7c92016-12-06 13:18:29 +0000[diff] [blame]180* ``poolsize: 100``
Éric Lemoine381d73c2016-12-06 12:28:04 +0000[diff] [blame]181* ``amqp_exchange: ceilometer``
182* ``amqp_port: 5672``
183* ``amqp_queue: metering.sample``
184* ``amqp_vhost: /openstack``
Éric Lemoine0aba3fd2016-12-06 10:36:39 +0000[diff] [blame]185* ``resource_decoding: false``
Jakub Pavlike7d12cd2015-09-03 19:02:45 +0200[diff] [blame]186
187Read more
188=========
189
jan kaufman1002cd92015-09-16 16:30:48 +0200[diff] [blame]190* https://hekad.readthedocs.org/en/latest/index.html
Filip Pytloun9612dac2017-02-02 13:02:03 +0100[diff] [blame]191
192Documentation and Bugs
193======================
194
195To learn how to install and update salt-formulas, consult the documentation
196available online at:
197
198 http://salt-formulas.readthedocs.io/
199
200In the unfortunate event that bugs are discovered, they should be reported to
201the appropriate issue tracker. Use Github issue tracker for specific salt
202formula:
203
204 https://github.com/salt-formulas/salt-formula-heka/issues
205
206For feature requests, bug reports or blueprints affecting entire ecosystem,
207use Launchpad salt-formulas project:
208
209 https://launchpad.net/salt-formulas
210
211You can also join salt-formulas-users team and subscribe to mailing list:
212
213 https://launchpad.net/~salt-formulas-users
214
215Developers wishing to work on the salt-formulas projects should always base
216their work on master branch and submit pull request against specific formula.
217
218 https://github.com/salt-formulas/salt-formula-heka
219
220Any questions or feedback is always welcome so feel free to join our IRC
221channel:
222
223 #salt-formulas @ irc.freenode.net