Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

webhooks/splunk: Migrate docs to Markdown.

This commit is contained in:
Eeshan Garg 2017-06-13 01:34:45 -02:30 committed by Tim Abbott
parent df28bb40f2
commit b741f45408
2 changed files with 36 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
zerver/webhooks/splunk/doc.html
View File

@ -1,56 +0,0 @@
<p>
See your Splunk Search alerts in Zulip!
</p>
<p>
First, create the stream you'd like to use for Splunk notifications,
and subscribe all interested parties to this stream. We recommend the
stream name <code>splunk</code>, although you may choose another stream
if you prefer.
</p>
<p>
Next, in the Splunk search app, execute the search you'd like to alert on
and then save it as an alert:
</p>
<p>
<img src="/static/images/integrations/splunk/splunk_save_as_alert.png"/>
</p>
<p>
Name and configure your search in the "Settings" and "Trigger Conditions"
sections of the "Save As Alert" dialog box. In the "Trigger Actions" section,
click "Add Actions" and select "Webhook" to add a webhook action. Put the
Zulip Splunk webhook URL and your API key in the "URL" field, along with
your desired stream and (optional) topic name. If you do not specify a stream,
your messages will use the default stream `splunk`. If you do not specify a topic,
the name of the search is used (truncated to fit if needed.)
</p>
<p>
Example:
<code>{{ external_api_uri_subdomain }}/v1/external/splunk?api_key=abcde&stream=splunk&topic=alerts</code>
</p>
<p>
When you are done, it should look like this:
</p>
<p>
<img src="/static/images/integrations/splunk/splunk_configure_url.png"/>
</p>
<p>
Click Save to save the alert. You can create as many searches with alert
actions as you like, with whatever stream and topic you choose. Update your
webhook URL as appropriate for each one, and make sure the stream exists.
</p>
<p>
<b>Congratulations! You're done!</b><br/> When your search triggers an
alert, you'll see a notification like this:
</p>
<p>
<img class="screenshot" src="/static/images/integrations/splunk/splunk_message.png"/>
</p>

36
zerver/webhooks/splunk/doc.md Normal file
View File

@ -0,0 +1,36 @@
See your Splunk Search alerts in Zulip!
{!create-stream.md!}
{!create-bot-construct-url.md!}
{!append-topic.md!}
Next, in the Splunk search app, execute the search you'd like to be
alerted on and then save it as an alert:
![](/static/images/integrations/splunk/splunk_save_as_alert.png)
Name and configure your search in the **Settings** and **Trigger Conditions**
sections of the **Save As Alert** dialog box.
In the **Trigger Actions** section, click **Add Actions** and select
**Webhook** to add a webhook action. Put the Zulip Splunk webhook URL
we created earlier.
If you do not specify a stream in the URL, your messages will use
the default stream `splunk`. If you do not specify a topic,
the name of the search is used (truncated to fit if needed.)
When you are done, it should look like this:
![](/static/images/integrations/splunk/splunk_configure_url.png)
Click **Save** to save the alert. You can create as many searches with
alert actions as you like, with whatever stream and topic you choose.
Update your webhook URL as appropriate for each one, and make sure the
stream exists.
{!congrats.md!}
![](/static/images/integrations/splunk/splunk_message.png)