diff --git a/templates/zerver/integrations/nagios.html b/templates/zerver/integrations/nagios.html deleted file mode 100644 index fc6f620be8..0000000000 --- a/templates/zerver/integrations/nagios.html +++ /dev/null @@ -1,80 +0,0 @@ -

- First, create the stream you'd like to use for Nagios notifications, - and subscribe all interested parties to this stream. The integration will - use the default stream nagios if no stream is supplied in the - configuration; you still need to create the stream even if you are using - this default. -

- -

- Next, download and install our - Python bindings and example scripts - on your Nagios server. -

- -

- Next, open integrations/nagios/zuliprc.example - in your favorite editor, and change the following lines to - specify the email address and API key for your Nagios bot, - saving it to /etc/nagios3/zuliprc on your Nagios - server: -

- -
[api]
-email = NAGIOS_BOT_EMAIL_ADDRESS
-key = NAGIOS_BOT_API_KEY
-{% if api_site_required %}site = {{ external_api_uri_subdomain }}{% endif %}
-
- -

- Copy integrations/nagios/zulip_nagios.cfg - to /etc/nagios3/conf.d on your Nagios server. -

- -

- Finally, add zulip to the members - list for one or more of the contact groups in the - CONTACT GROUPS section - of /etc/nagios3/conf.d/contacts.cfg, doing - something like: -

- -
define contactgroup {
-    contactgroup_name       admins
-    alias                   Nagios Administrators
-    members                 monitoring, zulip
-}
-
-
- -Once you've done that, reload your Nagios configuration -using /etc/init.d/nagios3 reload. - -

- Congratulations! You're done!
When your Nagios - system makes an alert, you'll see a message like the following, - to the stream nagios (to change this, edit the - arguments to nagios-notify-zulip - in /etc/nagios3/conf.d/zulip_nagios.cfg) with a - topic indicating the service with an issue: -

- - -

- Testing
If you have - external commands enabled in Nagios, - you can generate a test notice from your Nagios instance by visiting using the - Send custom service notification command in - the Service Commands section of any individual - service's page on your Nagios instance. -

- -

- Troubleshooting
You can confirm whether you've - correctly configured Nagios to run the Zulip plugin by looking - for SERVICE NOTIFICATION lines mentioning zulip - in /var/log/nagios3/nagios.log. You can confirm - whether you've configured the Zulip plugin code correctly by - running /usr/local/share/zulip/integrations/nagios/nagios-notify-zulip - directly. -

diff --git a/templates/zerver/integrations/nagios.md b/templates/zerver/integrations/nagios.md new file mode 100644 index 0000000000..ddaea198c6 --- /dev/null +++ b/templates/zerver/integrations/nagios.md @@ -0,0 +1,64 @@ +First, create the stream you’d like to use for Nagios notifications, +and subscribe all interested parties to this stream. The integration +will use the default stream `nagios` if no stream is supplied in the +configuration; you still need to create the stream even if you are +using this default. + +{! download-python-bindings.md !} + +Next, open `integrations/nagios/zuliprc.example` in your favorite +editor, and change the following lines to specify the email address +and API key for your Nagios bot, saving it to `/etc/nagios3/zuliprc` +on your Nagios server: + +``` +[api] +email = NAGIOS_BOT_EMAIL_ADDRESS +key = NAGIOS_BOT_API_KEY +{% if api_site_required %}site = {{ external_api_uri_subdomain }}{% endif %} +``` + +Copy `integrations/nagios/zulip_nagios.cfg` to `/etc/nagios3/conf.d` +on your Nagios server. + +Finally, add `zulip` to the `members` list for one or more of the +contact groups in the `CONTACT GROUPS` section of +`/etc/nagios3/conf.d/contacts.cfg`, doing something like: + +``` +define contactgroup { + contactgroup_name admins + alias Nagios Administrators + members monitoring, zulip +} +``` + +Once you’ve done that, reload your Nagios configuration using +`/etc/init.d/nagios3 reload`. + +When your Nagios system makes an alert, you’ll see a message like the +following, to the stream `nagios` (to change this, edit the arguments +to `nagios-notify-zulip` in `/etc/nagios3/conf.d/zulip_nagios.cfg`) +with a topic indicating the service with an issue. + +{! congrats.md !} + +![](/static/images/integrations/nagios/001.png) + +**Testing** + +If you have +[external commands enabled in Nagios](http://nagios.sourceforge.net/docs/3_0/extcommands.html), +you can generate a test notice from your Nagios instance by visiting +using the `Send custom service notification` command in the `Service +Commands` section of any individual service’s page on your Nagios +instance. + +**Troubleshooting** + +You can confirm whether you’ve correctly configured Nagios to run the +Zulip plugin by looking for `SERVICE NOTIFICATION` lines mentioning +zulip in `/var/log/nagios3/nagios.log`. You can confirm whether you’ve +configured the Zulip plugin code correctly by running +`/usr/local/share/zulip/integrations/nagios/nagios-notify-zulip` +directly. diff --git a/zerver/lib/integrations.py b/zerver/lib/integrations.py index b5770ce782..8dbf4652ed 100644 --- a/zerver/lib/integrations.py +++ b/zerver/lib/integrations.py @@ -246,7 +246,7 @@ INTEGRATIONS = { display_name='Mercurial (hg)', doc='zerver/integrations/mercurial.md' ), - 'nagios': Integration('nagios', 'nagios', doc='zerver/integrations/nagios.html'), + 'nagios': Integration('nagios', 'nagios', doc='zerver/integrations/nagios.md'), 'openshift': Integration( 'openshift', 'openshift',