mirror of
https://github.com/zulip/zulip.git
synced 2025-11-09 16:37:23 +00:00
Migrate integrations/nagios.html to markdown.
This commit is contained in:
committed by
Tim Abbott
parent
a712a789fc
commit
ee53f80de9
@@ -1,80 +0,0 @@
|
|||||||
<p>
|
|
||||||
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 <code>nagios</code> if no stream is supplied in the
|
|
||||||
configuration; you still need to create the stream even if you are using
|
|
||||||
this default.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
Next, download and install our
|
|
||||||
<a href="/api">Python bindings and example scripts</a>
|
|
||||||
on your Nagios server.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
Next, open <code>integrations/nagios/zuliprc.example</code>
|
|
||||||
in your favorite editor, and change the following lines to
|
|
||||||
specify the email address and API key for your Nagios bot,
|
|
||||||
saving it to <code>/etc/nagios3/zuliprc</code> on your Nagios
|
|
||||||
server:
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<div class="codehilite"><pre>[api]
|
|
||||||
email = NAGIOS_BOT_EMAIL_ADDRESS
|
|
||||||
key = NAGIOS_BOT_API_KEY
|
|
||||||
{% if api_site_required %}site = {{ external_api_uri_subdomain }}{% endif %}</pre>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
Copy <code>integrations/nagios/zulip_nagios.cfg</code>
|
|
||||||
to <code>/etc/nagios3/conf.d</code> on your Nagios server.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
Finally, add <code>zulip</code> to the <code>members</code>
|
|
||||||
list for one or more of the contact groups in the
|
|
||||||
<code>CONTACT GROUPS</code> section
|
|
||||||
of <code>/etc/nagios3/conf.d/contacts.cfg</code>, doing
|
|
||||||
something like:
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<div class="codehilite"><pre>define contactgroup {
|
|
||||||
contactgroup_name admins
|
|
||||||
alias Nagios Administrators
|
|
||||||
members monitoring<span class="na">, zulip</span>
|
|
||||||
}
|
|
||||||
</pre>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
Once you've done that, reload your Nagios configuration
|
|
||||||
using <code>/etc/init.d/nagios3 reload</code>.
|
|
||||||
|
|
||||||
<p>
|
|
||||||
<b>Congratulations! You're done!</b><br/> When your Nagios
|
|
||||||
system makes an alert, you'll see a message like the following,
|
|
||||||
to the stream <code>nagios</code> (to change this, edit the
|
|
||||||
arguments to <code>nagios-notify-zulip</code>
|
|
||||||
in <code>/etc/nagios3/conf.d/zulip_nagios.cfg</code>) with a
|
|
||||||
topic indicating the service with an issue:
|
|
||||||
</p>
|
|
||||||
<img class="screenshot" src="/static/images/integrations/nagios/001.png"/>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
<b>Testing</b><br/>If you have
|
|
||||||
<a href="http://nagios.sourceforge.net/docs/3_0/extcommands.html">external commands enabled in Nagios</a>,
|
|
||||||
you can generate a test notice from your Nagios instance by visiting using the
|
|
||||||
<code>Send custom service notification</code> command in
|
|
||||||
the <code>Service Commands</code> section of any individual
|
|
||||||
service's page on your Nagios instance.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
<b>Troubleshooting</b><br/>You can confirm whether you've
|
|
||||||
correctly configured Nagios to run the Zulip plugin by looking
|
|
||||||
for <code>SERVICE NOTIFICATION</code> lines mentioning zulip
|
|
||||||
in <code>/var/log/nagios3/nagios.log</code>. You can confirm
|
|
||||||
whether you've configured the Zulip plugin code correctly by
|
|
||||||
running <code>/usr/local/share/zulip/integrations/nagios/nagios-notify-zulip</code>
|
|
||||||
directly.
|
|
||||||
</p>
|
|
||||||
64
templates/zerver/integrations/nagios.md
Normal file
64
templates/zerver/integrations/nagios.md
Normal file
@@ -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 !}
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
**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.
|
||||||
@@ -246,7 +246,7 @@ INTEGRATIONS = {
|
|||||||
display_name='Mercurial (hg)',
|
display_name='Mercurial (hg)',
|
||||||
doc='zerver/integrations/mercurial.md'
|
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': Integration(
|
||||||
'openshift',
|
'openshift',
|
||||||
'openshift',
|
'openshift',
|
||||||
|
|||||||
Reference in New Issue
Block a user