Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 99c1e39

Browse files
committed
additional clean up
1 parent 11790ed commit 99c1e39

13 files changed

+63
-149
lines changed

sp-oncall/admin/get-started/api.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
2-
31
.. _spoc-api:
42

53
************************************************************************

sp-oncall/admin/sso/sp-sso-google.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ To configure SSO for Splunk On-Call using Google Apps:
2727
:width: 100%
2828
:alt: Splunk On-Call SSO Google Apps Setup 3
2929

30-
#. Save the Splunk On-Call logo file found `HERE <https://help.victorops.com/wp-content/uploads/2016/11/256x256-VictorOps-Oakleaf.png>`__.
30+
#. Save the Splunk On-Call logo file found `HERE <https://help.victorops.com/wp-content/uploads/2016/11/256x256-VictorOps-Oakleaf.png>`__.
3131
#. Enter a name for the application (Splunk On-Call) and upload the logo file.
3232

3333
.. image:: /_images/spoc/sso-google4.png

sp-oncall/incidents/incident-pane.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Incident Pane
3030
Versions Supported: N/A (SaaS)
3131
VictorOps Version Required: Standard andEnterprise
3232

33-
The Incident Pane serves as a repository for recent activities in your Timeline. The Incident Pane, located to the right of the Timeline, houses alerts that come into Splunk On-Call. We currently store seven days or 1,000 events worth of timeline alert history, whichever comes first. Historical data that fall outside of the aforementioned storage parameters of the Incident Pane may be obtained through the use of the :new-page:`VictorOps API <https://help.victorops.com/knowledge-base/api/>`.
33+
The Incident Pane serves as a repository for recent activities in your Timeline. The Incident Pane, located to the right of the Timeline, houses alerts that come into Splunk On-Call. We currently store seven days or 1,000 events worth of timeline alert history, whichever comes first. Historical data that fall outside of the aforementioned storage parameters of the Incident Pane may be obtained through the use of the :ref:`spoc-api`.
3434

3535
.. raw:: html
3636

Lines changed: 19 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,35 @@
1-
2-
31
.. _call-notif:
42

53
************************************************************************
64
Splunk On-Call notification phone numbers
75
************************************************************************
86

97
.. meta::
10-
:description: Splunk On-Call will contact you for triggered incidents using the below phone numbers and short code. You may add these numbers to your contacts in the Mobile App for both `Android <https://help.victorops.com/knowledge-base/android-devices-victorops/>`__ and `iOS <https://help.victorops.com/knowledge-base/ios-application/>`__ devices by navigating to *Settings >> Help and Support >>* *Add VictorOps to Your Contacts:*
8+
:description: Splunk On-Call contacts you for triggered incidents using the following phone numbers and short code.
9+
10+
Splunk On-Call contacts you for triggered incidents using the following phone numbers and short code. To add these numbers to your contacts in the Splunk On-Call mobile app, go to :guilabel:`Settings` then :guilabel:`Help and Support` then :guilabel:`Add VictorOps to Your Contacts`. For more information about the Splunk On-Call mobile app, see :ref:`spoc-mobile-main`
1111

1212
.. image:: /_images/spoc/Add-Contacts-Android-1.png
1313

14-
**Short Code (US and Canada SMS only):**
15-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14+
Short code (US and Canada SMS only)
15+
======================================
1616

1717
842867
1818

19-
**Long Codes:**
20-
^^^^^^^^^^^^^^^
21-
22-
303.653.9527
23-
24-
303.653.9644
25-
26-
303.653.9674
27-
28-
303.578.1340
29-
30-
303.835.0913
31-
32-
**International Numbers:**
33-
^^^^^^^^^^^^^^^^^^^^^^^^^^
34-
35-
Czech Republic (SMS only): +420 736352147
36-
37-
Poland (Phone & SMS): +48 799448785
19+
Long codes
20+
=============
3821

39-
Singapore (SMS only): +65 82410345
22+
* 303.653.9527
23+
* 303.653.9644
24+
* 303.653.9674
25+
* 303.578.1340
26+
* 303.835.0913
4027

41-
Australia (Phone only): +61 2 6190 1305
28+
International numbers
29+
========================
4230

43-
Australia (SMS only): +61 476 857 069
31+
* Czech Republic (SMS only): +420 736352147
32+
* Poland (Phone & SMS): +48 799448785
33+
* Singapore (SMS only): +65 82410345
34+
* Australia (Phone only): +61 2 6190 1305
35+
* Australia (SMS only): +61 476 857 069

sp-oncall/reports/incident-frequency-report.rst

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
1-
21
.. _incident-frequency:
32

43
************************************************************************
5-
Splunk On-Call Incident Frequency Report
4+
Splunk On-Call incident frequency report
65
************************************************************************
76

87
.. meta::
98
:description: About the user roll in Splunk On-Call.
109

11-
12-
1310
The goal of our Incident Frequency Report is to give your team the data and context around incidents to be proactive in your incident management response.
1411

1512

@@ -20,16 +17,12 @@ This integration is compatible with the following versions of Splunk On-Call:
2017

2118
- Enterprise
2219

23-
All users have the ability to reach out to Splunk On-Call support at any time with questions.
24-
25-
Live Chat: If you are logged into your Splunk On-Call instance, you will have the ability to Live Chat with the Splunk On-Call Support team.
2620

27-
While the Splunk On-Call Timeline gives you the real-time firehose to give your team full context during a firefight, our Incident Frequency Report allows your team to analyze the flow of incidents after the fact. Allowing you to go upstream to solve the incident causing the problem in your system.
21+
While the Splunk On-Call Timeline gives you the real-time information to give your team full context during a firefight, use the incident frequency report to analyze the flow of incidents after the fact.
2822

29-
To access the Incident Frequency Report navigate to :guilabel:`Reports`, then :guilabel:`Incident Frequency`.
23+
To access the Incident Frequency Report go to :guilabel:`Reports` then :guilabel:`Incident Frequency`.
3024

31-
32-
Team Filtering
25+
Team filtering
3326
========================
3427

3528
Get a holistic overview of all incidents coming into Splunk On-Call by selecting the :guilabel:`All`, or take a deep dive into individual teams to uncover specific problem areas affecting your team.
@@ -48,9 +41,7 @@ Identifying the problem causing area is hard to pin down, so we give you the abi
4841
:width: 100%
4942
:alt: There are four options to segment your incidents: integrations, host, service, or route key.
5043

51-
52-
53-
Date Range & Bucketing
44+
Date range and bucketing
5445
--------------------------
5546

5647
See how incident trends impact your team on a daily, weekly, or monthly basis. It's up to you how granular your scope can be.
@@ -59,8 +50,6 @@ See how incident trends impact your team on a daily, weekly, or monthly basis. I
5950
:width: 100%
6051
:alt: Segment reports by date range.
6152

62-
63-
6453
Table view and hover state
6554
-------------------------------
6655

@@ -83,7 +72,7 @@ Things to note about the CSV:
8372
- Timestamps are at millisecond granularity
8473
- CSV is sorted by Incident ID in descending order
8574

86-
CSV File Column Headings
75+
CSV file column headings
8776
----------------------------------
8877

8978
When downloading the Incident Frequency CSV file you can expect to find the following columns to include the unit of time/timezone that the incident is recorded in. Time related column headings will appear in these formats:
@@ -94,8 +83,8 @@ Incident Start Time (UTC)
9483
Acknowledge Time (UTC)
9584
Resolve Time (UTC)
9685

97-
Incident Frequency Report: CSV field definitions
98-
=======================================================
86+
Incident frequency report: CSV field definitions
87+
-----------------------------------------------------
9988

10089
The following is a quick glossary to define fields in the IFR CSV download. These definitions sometimes differ from the Glossary of Incident Fields.
10190

@@ -152,9 +141,4 @@ The following is a quick glossary to define fields in the IFR CSV download. Thes
152141
* - Last alert time
153142
- The time of the last alert.
154143
* - Current phase
155-
- The state of incident: Triggered, Ack'd, Resolved
156-
157-
158-
159-
160-
https://help.victorops.com/knowledge-base/incident-fields-glossary/#glossary-of-fields
144+
- The state of incident: Triggered, Ack'd, Resolved

sp-oncall/spoc-integrations/alertsite-integration.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,12 @@ To enable the AlertSite integration in Splunk OnCall to be able to trigger and r
3232

3333
db212e48-……8669\:strong:`+databaseteam`\ @alert.victorops.com
3434

35-
Team routing keys are configured at the bottom of the Settings > Integrations page. For details, see `Routing Keys <http://help.victorops.com/knowledge-base/routing-keys/>`.
35+
Team routing keys are configured at the bottom of the :guilabel:`Settings` then :guilabel:`Integrations`` page. For details, see :ref:`spoc-routing-keys`.
3636

3737
#. If you do not use routing, remove the *+$routing_key* part, including the plus sign, so that the email looks like this:
3838

3939
``db212e48-……[email protected]``
4040

41-
42-
4341
Configuring AlertSite
4442
==============================
4543

Lines changed: 16 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,24 @@
1-
Bugsnag integration for Splunk On-Call
1+
BugSnag integration for Splunk On-Call
22
**********************************************************
33

4-
[ht_toggle title=“Requirements” id=“” class=“” style=“” ]
4+
Use this guide to send your BugSnag team notifications to the Splunk On-Call timeline.
55

6-
**Versions Supported: N/A (SaaS)**
6+
Requirements
7+
================
78

8-
**VictorOps Version Required:** Starter, Growth, or Enterprise
9+
Splunk On-Call required version: Starter, Growth, or Enterprise
910

10-
[/ht_toggle]
11+
In Splunk On-Call
12+
====================
1113

12-
Bugsnag's cross platform error monitoring automatically detects crashes
13-
in your applications, letting you ship with confidence.
14+
#. From the main timeline select :guilabel:`Integrations` then :guilabel:`BugSnag`.
15+
#. If the integration has not yet been enabled, select :guilabel:`Enable Integration`. Copy the :guilabel:`Service API Key` to your clipboard.
16+
#. Once you have copied the API key to your clipboard, select :guilabel:`Settings` then :guilabel:`Routing Keys` to find your routing key configuration. Decide which routing_key will be used with this integration and make sure it is associated to the correct teams. You might need to create a new key.Routing keys are case sensitive.
1417

15-
The following will guide you through the steps needed to send you
16-
bugsnag “Team Notifications” into the Splunk On-Call timeline.
18+
In BugSnag
19+
==================
1720

18-
**In Splunk On-Call**
19-
---------------------
20-
21-
From the main timeline select **Integrations** *>>* **BugSnag**
22-
23-
If the integration has not yet been enabled, click the “Enable Integration” button.  Copy the “Service API Key” to your clipboard.
24-
.. image1
25-
26-
Once you have copied the API key to your clipboard, click on *Settings
27-
>> Routing Keys* page to find your routing key configuration.  Decide
28-
which routing_key will be used with this integration and make sure it is
29-
associated to the correct team/s.  (You may need to create a new key)
30-
 Routing keys are case sensitive.
31-
32-
.. image:: /_images/spoc/atatus2.png
33-
:alt: atatus2
34-
35-
atatus2
36-
37-
**In Bugsnag**
38-
--------------
39-
40-
From the main web client, go into Settings.
41-
42-
.. image:: /_images/spoc/bugsnag2.png
43-
:alt: bugsnag2
44-
45-
bugsnag2
46-
47-
In settings, select **Team Notifications** and then **VictorOps**.
48-
49-
.. image:: /_images/spoc/bugsnag3.png
50-
:alt: bugsnag3
51-
52-
bugsnag3
53-
54-
Setup the alert to notify based on the options provided, and then drop
55-
in your “VictorOps API Key” and the appropriate
56-
`Routing <https://help.victorops.com/knowledge-base/routing-keys/>`__ key.
57-
Hit **save** and you are done!
58-
59-
.. image:: /_images/spoc/bugsnag4.png
60-
:alt: bugsnag4
61-
62-
bugsnag4
63-
64-
.. |image1| image:: /_images/spoc/Integration-Bugsnag-final.png
21+
#. From the main web client, go into :guilabel:`Settings`.
22+
#. In settings, select :guilabel:`Team Notifications` then :guilabel:`VictorOps`.
23+
#. Set up the alert to notify based on the options provided, and then paste in your :guilabel:`VictorOps API Key` and the routing key.
24+
#. Select :guilabel:`Save`.

sp-oncall/spoc-integrations/hipchat-integration.rst

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,22 @@
11
HipChat integration for Splunk On-Call
22
**********************************************************
33

4-
[ht_toggle title=“Requirements” id=“” class=“” style=“” ]
4+
Use the bi-directional integration between HipChat and Splunk On-Call to fight fires from either platform and never miss a beat. All messages entered in the Splunk On-Call timeline, including alerts, on-call changes, escalations and chats appear in the HipChat room, and vice versa.
55

6-
**Splunk On-Call Version Required: Starter / Growth** for **Single Room,
7-
Enterprise** for **Multi-Room**
8-
9-
**What you need to know: Multi-Room requires the Rules Engine and
10-
Webhooks i.e. Splunk On-Call Enterprise**
11-
12-
[/ht_toggle]
13-
14-
This bi-directional integration between HipChat and Splunk On-Call
15-
(formerly called VictorOps) allows you to fight fires from either
16-
platform and never miss a beat. All messages entered in the Splunk
17-
On-Call timeline, including alerts, on-call changes, escalations and
18-
chats will appear in the HipChat room, and vice versa.
6+
Requirements
7+
==============
198

20-
This article provides step by step instructions for setting up the
21-
integration for a Single Room or Multi-Room configuration.
9+
* Splunk On-Call required version: Starter or Growth for Single Room, Enterprise for Multi-Room
2210

23-
--------------
11+
Use these step by step instructions to set up the integration for a Single Room or Multi-Room configuration.
2412

25-
**Single Room**
13+
Single Room
2614
===============
2715

28-
**In Splunk On-Call**
16+
In Splunk On-Call
2917
---------------------
3018

31-
In Splunk On-Call, select *Integrations >> Hipchat*\ **.**
19+
#. In Splunk On-Call, select :guilabel:`Integrations` then :guilabel:`Hipchat`.
3220

3321
If the integration has not yet been enabled, click the *Enable
3422
Integration* button to generate your endpoint URL.  Be sure to replace
@@ -143,9 +131,8 @@ This will allow you to change the room_id and auth_token depending on
143131
the type of alert. In the example we match on the routing key “devops”
144132
but you can match on any alert field.
145133

146-
Next we will need to set up an `Outbound
147-
Webhook <https://help.victorops.com/knowledge-base/custom-outbound-webhooks/>`__
148-
to send Splunk On-Call information to your HipChat room(s).
134+
Next we will need to set up an Outbound
135+
Webhook to send Splunk On-Call information to your HipChat room(s). See :ref:`custom-outbound-webhooks` for steps.
149136

150137
From the Splunk On-Call timeline select Integrations *>> Outgoing
151138
Webhooks >>* *Add Webhook*.

sp-oncall/spoc-integrations/icinga-integration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ You need to link the timeout command to a directory that is in the path.
277277
Icinga version 2 configuration
278278
===================================
279279

280-
After going through the preceeding installation instructions for Icinga (or `Nagios <https://help.victorops.com/knowledge-base/victorops-nagios-integration/>`__), use the following steps to add the VictorOps plugin to your Icinga 2 instance.
280+
After going through the preceding installation instructions for Icinga (or Nagios see :ref:`nagios-spoc`), use the following steps to add the VictorOps plugin to your Icinga 2 instance.
281281

282282
You can find these steps in the README.md file in /opt/victorops/nagios_plugin/icinga2_conf
283283

sp-oncall/spoc-integrations/jenkins-integration.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ This integration is compatible with the following versions of Splunk On-Call:
2525
The remainder of this topic walks you through the Jenkins integration with Splunk On-Call.
2626

2727
.. note::
28-
There are two Jenkins integrations, this one with Splunk On-Call, and the :new-page:`Jenkins Delivery Insights Integration <https://help.victorops.com/knowledge-base/victorops-jenkins2-integration/>`,
29-
which sends notifications to the Timeline about build status.
28+
There are two Jenkins integrations, this one with Splunk On-Call, and the Jenkins Delivery Insights Integration which sends notifications to the Timeline about build status. See :ref:`jenkins-delivery-spoc` to learn more.
3029

3130
Splunk On-Call configuration
3231
------------------------------

0 commit comments

Comments
 (0)