blob: 8ba150397295b8f31ff4f799d02a9059a2c343db [file] [log] [blame]
Filip Pytloun818f5e12015-10-06 16:28:32 +02001
2=====
3Sensu
4=====
5
6Sample pillars
7==============
8
9Sensu Server with API
10
11.. code-block:: yaml
12
13 sensu:
14 server:
15 enabled: true
16 keepalive_warning: 20
jan kaufman2af39ed2016-02-25 11:02:19 +010017 keepalive_critical: 60
Filip Pytloun818f5e12015-10-06 16:28:32 +020018 mine_checks: true
19 database:
20 engine: redis
21 host: localhost
22 port: 6379
23 message_queue:
24 engine: rabbitmq
25 host: rabbitmq
26 port: 5672
27 user: monitor
28 password: pwd
29 virtual_host: '/monitor'
30 bind:
31 address: 0.0.0.0
32 port: 4567
33 handler:
34 default:
35 enabled: true
36 set:
37 - mail
jan kaufman2af39ed2016-02-25 11:02:19 +010038 - pipe
Filip Pytloun818f5e12015-10-06 16:28:32 +020039 stdout:
40 enabled: true
41 mail:
42 mail_to: 'mail@domain.cz'
43 host: smtp1.domain.cz
44 port: 465
45 user: 'mail@domain.cz'
46 password: 'pwd'
47 authentication: cram_md5
48 encryption: ssl
49 domain: 'domain.cz'
jan kaufman2af39ed2016-02-25 11:02:19 +010050 pipe:
51 enabled: true
52 command: /usr/bin/tee /tmp/debug
Filip Pytloun818f5e12015-10-06 16:28:32 +020053
54Sensu Dashboard (now uchiwa)
55
56.. code-block:: yaml
57
58 sensu:
59 dashboard:
60 enabled: true
61 bind:
62 address: 0.0.0.0
63 port: 8080
64 admin:
65 username: admin
66 password: pass
67
68Sensu Client
69
70.. code-block:: yaml
71
72 sensu:
73 client:
74 enabled: true
75 message_queue:
76 engine: rabbitmq
77 host: rabbitmq
78 port: 5672
79 user: monitor
80 password: pwd
81 virtual_host: '/monitor'
82
Adam Tenglera143f362016-10-31 19:40:35 +010083Sensu Client with check explicitly disabled
84
85.. code-block:: yaml
86
87 sensu:
88 client:
89 enabled: true
90 message_queue:
91 engine: rabbitmq
92 host: rabbitmq
93 port: 5672
94 user: monitor
95 password: pwd
96 virtual_host: '/monitor'
97 check:
98 local_linux_storage_swap_usage:
99 enabled: False
100
Guillaume Thouvenin63423cf2017-03-02 10:29:33 +0100101Sensu Client with subscriptions explicitly disabled
102
103.. code-block:: yaml
104
105 sensu:
106 client:
107 enabled: true
108 message_queue:
109 engine: rabbitmq
110 host: rabbitmq
111 port: 5672
112 user: monitor
113 password: pwd
114 virtual_host: '/monitor'
115 unsubscribe:
116 - collectd.client
117 - git.client
118
Filip Pytloun818f5e12015-10-06 16:28:32 +0200119Sensu Client with community plugins
120
121.. code-block:: yaml
122
123 sensu:
124 client:
125 enabled: true
126 plugin:
127 sensu_community_plugins:
128 enabled: true
129 monitoring_for_openstack:
130 enabled: true
vmikes299f9af2016-09-06 16:04:22 +0200131 ruby_gems:
132 enabled: True
133 name:
134 bunny:
Filip Pytloun818f5e12015-10-06 16:28:32 +0200135 message_queue:
136 engine: rabbitmq
137 host: rabbitmq
138 port: 5672
139 user: monitor
140 password: pwd
141 virtual_host: '/monitor'
142
Jakub Pavlikcca98e92016-09-06 18:08:22 +0200143Sensu SalesForce handler
144
145.. code-block:: yaml
146
147 sensu:
148 server:
149 enabled: true
150 handler:
151 default:
152 enabled: true
153 set:
154 - sfdc
155 stdout:
156 enabled: true
157 sfdc:
158 enabled: true
159 sfdc_client_id: "3MVG9Oe7T3Ol0ea4MKj"
160 sfdc_client_secret: 11482216293059
161 sfdc_username: test@test1.test
162 sfdc_password: passTemp
163 sfdc_auth_url: https://mysite--scloudqa.cs12.my.salesforce.com
164 environment: a2XV0000001
165 sfdc_organization_id: 00DV00000
Pavel Cizinsky8db8b742017-07-27 11:54:01 +0200166 sfdc_http_proxy: 'http://10.10.10.10:8888'
167 token_cache_file: "/path/to/cache/token"
168
169Sensu Slack handler
170
171.. code-block:: yaml
172
173 sensu:
174 server:
175 enabled: true
176 handler:
177 default:
178 enabled: true
179 set:
180 - slack
181 stdout:
182 enabled: true
183 slack:
184 enabled: True
185 channel: '#channel_name'
186 webhook_url: 'https://hooks.slack.com/services/kastan12T/B57X3SDQA/fasfsaf0632hjkl3dsccLn9v'
187 proxy_address: '10.10.10.10'
188 proxy_port: '8888'
Jakub Pavlikcca98e92016-09-06 18:08:22 +0200189
Filip Pytloun818f5e12015-10-06 16:28:32 +0200190Read more
191=========
192
193* http://docs.sensuapp.org/0.9/installing_sensu.html
194* https://speakerdeck.com/joemiller/practical-examples-with-sensu-monitoring-framework
195* https://github.com/fridim/nagios-plugin-check_galera_cluster
196* http://www.reimann.sh/2011/06/30/nagios-check-pacemaker-failed-actions/
197* http://sys4.de/en/blog/2014/01/23/montoring-pacemaker-nagios/
198* https://raw.githubusercontent.com/sensu/sensu-community-plugins/master/plugins/openstack/neutron/neutron-agent-status.py
199* https://github.com/sensu/sensu-community-plugins/blob/master/plugins/openstack/keystone/check_keystone-api.sh
200* http://openstack.prov12n.com/monitoring-openstack-nagios-3/
201* https://raw.githubusercontent.com/drewkerrigan/nagios-http-json/master/check_http_json.py
202* https://github.com/opinkerfi/nagios-plugins/tree/master/check_ibm_bladecenter
203* https://github.com/opinkerfi/nagios-plugins/tree/master/check_storwize
204* https://github.com/ehazlett/sensu-py/
205* https://github.com/Level-Up/Supervisord-Nagios-Plugin/blob/master/check_supv.py
Filip Pytlouncf8a8f62017-02-02 13:02:03 +0100206
207Documentation and Bugs
208======================
209
210To learn how to install and update salt-formulas, consult the documentation
211available online at:
212
213 http://salt-formulas.readthedocs.io/
214
215In the unfortunate event that bugs are discovered, they should be reported to
216the appropriate issue tracker. Use Github issue tracker for specific salt
217formula:
218
219 https://github.com/salt-formulas/salt-formula-sensu/issues
220
221For feature requests, bug reports or blueprints affecting entire ecosystem,
222use Launchpad salt-formulas project:
223
224 https://launchpad.net/salt-formulas
225
226You can also join salt-formulas-users team and subscribe to mailing list:
227
228 https://launchpad.net/~salt-formulas-users
229
230Developers wishing to work on the salt-formulas projects should always base
231their work on master branch and submit pull request against specific formula.
232
233 https://github.com/salt-formulas/salt-formula-sensu
234
235Any questions or feedback is always welcome so feel free to join our IRC
236channel:
237
238 #salt-formulas @ irc.freenode.net