Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
Merged
2 changes: 1 addition & 1 deletion apm/apm-spans-traces/trace-analyzer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The following table presents what each APM tool is best suited for:
Explore your trace data
=========================

To open Trace Analyzer, select :guilabel:`Traces` in Splunk APM and select :guilabel:`Switch to Trace Analyzer`. To switch back to the classic Traces page, select :guilabel:`Switch to Classic View`. See :ref:`trace-search` for more info about the classic traces view.
To open Trace Analyzer, select :guilabel:`Traces` in Splunk APM and select :guilabel:`Switch to Trace Analyzer`.

To explore your trace data, use the following controls, which are numbered as callouts in the image. Additional details for each callout follow the image:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,39 @@ Release Notes for the Splunk Add-On for the OpenTelemetry Collector
:hidden:

.. list-table::
:widths: 30 35 35
:widths: 20 20 20 40
:header-rows: 1
:width: 100%

* - Splunk Add-on version
- Release date
- Collector version
- Details

* - 1.4.1
- April 2, 2025
- :new-page:`version 0.120 <https://github.com/signalfx/splunk-otel-collector/releases/tag/v0.120.0>`
-

* - 1.4.0
- February 27, 2025
- :new-page:`version 0.118 <https://github.com/signalfx/splunk-otel-collector/releases/tag/v0.118.0>`
- * Linux: Adds support for discovery mode flags
* Linux: Fixes an issue affecting the setting of the gomemlimit environment variable
* Windows: Fixes an issue affecting the setting of the gateway environment variable

* - 1.3.3
- November 7, 2024
- :new-page:`version 0.111 <https://github.com/signalfx/splunk-otel-collector/releases/tag/v0.111.0>`
-

* - 1.3.2
- September 20, 2024
- :new-page:`version 0.104 <https://github.com/signalfx/splunk-otel-collector/releases/tag/v0.104.0>`
-

* - 1.3.1
- August 6, 2024
- :new-page:`version 0.104 <https://github.com/signalfx/splunk-otel-collector/releases/tag/v0.104.0>`

-

159 changes: 61 additions & 98 deletions sp-oncall/spoc-integrations/jira-app-integration-guide-victorops.rst
Original file line number Diff line number Diff line change
@@ -1,127 +1,90 @@
Jira integration for Splunk On-Call
Jira App integration for Splunk On-Call
**********************************************************

[ht_toggle title=“Requirements” id=“” class=“” style=“” ]
Requirements
================

**Jira Version Required**: Jira Server 7.7.0 - 8.22.6, Jira Cloud
(versionless)
* Jira Version Required: Jira Server 7.7.0 - 8.22.6, Jira Cloud
* Splunk On-Call Version Required: Starter, Growth, or Enterprise
* Global Admin privileges are required for the Splunk On-Call configuration.

**Splunk On-Call Version Required:** Starter, Growth, or Enterprise
Configure in Splunk On-Call
=====================================

[/ht_toggle]
#. In Splunk On-Call, go to :guilabel:`Integrations` then :guilabel:`API`.
#. Select :guilabel:`New Key`.
#. Give the key a description and copy the resulting API key and API ID.

**Configuration in Splunk On-Call**
-----------------------------------
Install the Splunk On-Call Add-On in Jira
==========================================

**NOTE**\ *: Global Admin privileges are required for the Splunk On-Call
portion of the configuration.*
#. Log in as a Jira administrator, then select the Jira administration gear icon then select :guilabel:`Manage apps` to go to the Atlassian Marketplace.
#. In the sidebar, select :guilabel:`Find new apps` under the Atlassian Marketplace header.
#. If you are on Jira Server, search for the app "Splunk On-Call for Jira Server". If you are on Jira Cloud, search for "VictorOps for Jira Cloud". After you've located the right app, select :guilabel:`Install`.
#. After installation completes, select :guilabel:`Configure`.

In Splunk On-Call, navigate to **Integrations >> API**.

Click the **New Key** button. Give the key a description. Note the
resulting **API key** and existing **API ID**.

**Installing the Splunk On-Call Add-On**
----------------------------------------
Configuring application settings
--------------------------------

1. Log in as a Jira administrator, then navigate to the Atlassian
Marketplace by clicking on **Jira administration gear** **icon >
Manage apps**.
2. In the left-hand sidebar, click **Find new apps** under the Atlassian
Marketplace header.
3. If on Jira Server, search for the app \_Splunk On-Call for Jira
Server\_\_.\_ If on Jira Cloud, search for the app *VictorOps for
Jira Cloud*.  Once you've located the right app, click *Install*.
#. Enter the API key you generated in VictorOps in the :guilabel:`API Key` field under :guilabel:`Connect to your VictorOps Organization` on the VictorOps for Jira Server Configuration page.
#. In the :guilabel:`API ID` field in the same section, insert the API ID you coped in the preceding Configure Splunk On-Call step.
#. Copy the Splunk On-Call org ID displayed in your VictorOps URL. The org ID is at the end of the URL you use to log in: ``https://portal.victorops.com/client/<Org_ID>``. Paste the org ID in Jira's :guilabel:`Organization ID` field.
#. Select :guilabel:`Connect`.

Once installation completes, click on **Configure**.
A new entry appears in the Connected VictorOps Organizations section with a green VALID flag.

Configuring Application Settings
--------------------------------
.. image:: /_images/spoc/1jira.png

1. Insert the API key you generated in VictorOps into the **API Key**
field under the *Connect to your VictorOps Organization* section of
Jira's *VictorOps for Jira Server Configuration* page.
2. In the **API ID** field in the same section, insert the API ID you
noted in the Splunk On-Call step above.
3. Copy the Splunk On-Call Org ID displayed in your VictorOps URL
(for example :samp:`https://portal.victorops.com/client/%7BOrg_ID`) and paste it in
Jira's **Organization ID** field. This is appended to the incident
link within Jira tickets.
4. Once all three fields have been populated, click **Connect**.  On
success, a new entry will appear in the *Connected VictorOps
Organizations* section, and display a green “VALID” flag.

/_images/spoc/1jira.png

**Configuring Jira Project Settings**
Configure Jira project settings
-------------------------------------

The Splunk On-Call add-on must be enabled and configured for each Jira
project you wish to associate.  Note that while multiple projects can
connect to the same Splunk On-Call organization, projects cannot share
the same *Default Team Escalation Policy*.
The Splunk On-Call add-on must be activated and configured for each Jira project you want to associate. While multiple projects can
connect to the same Splunk On-Call organization, projects cannot share the same Default Team Escalation Policy.

1. In Jira, click **Projects**
2. Navigate to **Project settings** of the project **you wish to enable
for the Splunk On-Call add-on**, then click **VictorOps Settings**.
3. Click **Enable VictorOps for this Project**.  This will expand the
page to display a list of configurable fields.
#. In Jira, select :guilabel:`Projects`.
#. Go to :guilabel:`Project settings` of the project you want to activate for the Splunk On-Call add-on.
#. Select :guilabel:`VictorOps Settings`.
#. Select :guilabel:`Enable VictorOps for this Project`.

Default Incident Settings
The page displays a list of configurable fields.

Default incident settings
~~~~~~~~~~~~~~~~~~~~~~~~~

1. Under *VictorOps Instance*, select the Splunk On-Call organization
you wish to associate with this project.
2. Under *Default Team Escalation Policy*, select the Splunk On-Call
Escalation Policy you would like to page when Jira issues create
incidents in Splunk On-Call.  NOTE:  Incoming VictorOps incidents
assigned to this Escalation Policy will be the only ones allowed to
create issues in your Jira project.
3. Under *Default User*, select the Jira user you wish to designate as
Reporter for issues generated by incoming Splunk On-Call incidents.

Incoming Issue Settings
#. Under :guilabel:`VictorOps Instance`, select the Splunk On-Call organization you want to associate with this project.
#. Under :guilabel:`Default Team Escalation Policy`, select the Splunk On-Call Escalation Policy you want to page when Jira issues create incidents in Splunk On-Call. Incoming VictorOps incidents assigned to this Escalation Policy are the only incidents allowed to create issues in your Jira project.
#. Under :guilabel:`Default User`, select the Jira user you want to designate as reporter for issues generated by incoming Splunk On-Call incidents.

Incoming issue settings
~~~~~~~~~~~~~~~~~~~~~~~

Splunk On-Call incidents created for a project's *Default Team
Escalation Policy* will automatically generate Jira issues.  The default
type for such issues (Bug, Epic, Story, or Task) is set by selecting the
desired option from the **Issue type to use for incoming VictorOps
incidents** dropdown.
Splunk On-Call incidents created for a project's Default Team Escalation Policy automatically generate Jira issues. The default type for such issues (Bug, Epic, Story, or Task) is set by selecting the desired option from the :guilabel:`Issue type to use for incoming VictorOps incidents` dropdown menu.

If you wish to disable such issue creation, deselect the **Allow issues
to be created from incidents via the REST API** checkbox.
If you want to disable such issue creation, deselect the :guilabel:`Allow issues to be created from incidents via the REST API` checkbox.

/_images/spoc/2jira.png
.. image:: /_images/spoc/2jira.png
:width: 50%

Jira State Configuration
Jira state configuration
~~~~~~~~~~~~~~~~~~~~~~~~

Defining state mapping allows Jira issues to remain synchronized as
incidents move through their life cycle in VictorOps.
Define state mapping to allows Jira issues to remain synchronized as incidents move through their life cycle in VictorOps.

/_images/spoc/3jira.png
.. image:: /_images/spoc/3jira.png
:alt:
:width: 50%

**Creating a Splunk On-Call Incident Within Jira**
Create a Splunk On-Call incident in Jira
--------------------------------------------------

Currently, Splunk On-Call incidents can only be created from the Jira
issue view.

1. Click **More** > **Create VictorOps Incident**.  A preview of the
Splunk On-Call incident card will display, using the project's
*Default Team Escalation Policy*. Note: For Jira Cloud, the More
button is an ellipsis button.
2. You may select a different escalation policy from the *VictorOps Team
Escalation Policy* dropdown.  You may also use the *Additional Users*
dropdown to optionally include additional users for response.  Note
that adding users to an incident will *not* create a “Multi-Responder
incident” in Splunk On-Call. 
3. Click **Create Incident** to generate a Splunk On-Call incident. 
This will then display a *Triggered* Splunk On-Call incident card
under the *VictorOps* section in the lower right frame of the issue
view.
4. Click the incident card's **Incident Details** link to display the
incident in Splunk On-Call in a new browser tab.

/_images/spoc/4jira.png
Splunk On-Call incidents can only be created from the Jira issue view.

#. Select :guilabel:`More` then :guilabel:`Create VictorOps Incident`.
#. A preview of the Splunk On-Call incident card displays using the project's Default Team Escalation Policy.
#. (Optional) Select a different escalation policy from the :guilabel:`VictorOps Team Escalation Policy` dropdown menu.
#. (Optional) Use the :guilabel:`Additional Users` dropdown menu to include additional users for response. Adding users to an incident does not create a multi-responder incident in Splunk On-Call.
#. Select :guilabel:`Create Incident` to generate a Splunk On-Call incident. A triggered Splunk On-Call incident card displays under the VictorOps section in the issue view.
#. Select the :guilabel:`Incident Details` in the incident card in Splunk On-Call to display the incident in a new browser tab.

.. image:: /_images/spoc/4jira.png
:alt:
15 changes: 13 additions & 2 deletions sp-oncall/spoc-integrations/jira-integration-guide.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _Jira-spoc:

Jira integration for Splunk On-Call
***************************************************
Jira webhook, service desk, and URL integrations for Splunk On-Call
**********************************************************************

.. meta::
:description: Configure the Jira integration for Splunk On-Call.
Expand Down Expand Up @@ -36,23 +36,27 @@ From the main web interface, select the cog in the upper right hand corner and t

.. image:: /_images/spoc/Jnew1.png
:alt: Select webhooks in Jira
:width: 35%

In the left side bar under “Advanced” select :guilabel:`WebHooks`.

.. image:: /_images/spoc/jnew2.png
:alt: Select webhooks in Jira
:width: 20%

Select :guilabel:`+ Create a Webhook`. Give the WebHook a name, set the status to :guilabel:`Enabled`, and paste in the Splunk On-Call Jira URL.

.. image:: /_images/spoc/jnew3.png
:alt: Select + Create a Webhook
:width: 75%

You have the options to use specific JQL queries to send only certain issues.

Next select the events you want to send to Splunk On-Call for. The example sends a webhook whenever an issue is created, updated or deleted.

.. image:: /_images/spoc/jnew4.png
:alt: Select the events you would like to have a webhook sent to SPoC
:width: 85%

Deselect :guilabel:`Exclude body` so that Jira sends JSON, then select :guilabel:`Create`.

Expand All @@ -68,6 +72,7 @@ For example you might want to adjust the severity level of an alert based on the

.. image:: /_images/spoc/Screen-Shot-2019-08-14-at-11.00.20-AM.png
:alt: Sample rule
:width: 75%

To send information based on actions in Splunk On-Call back into Jira you need to configure outbound webhooks. You can do things such as update the status of a ticket when the incident is acknowledged in Splunk On-Call, or add a
comment or assignee to the Jira ticket. The following example walks you through how to add a comment to a Jira ticket when someone writes in the associated incident timeline in Splunk On-Call.
Expand All @@ -91,6 +96,7 @@ The final result looks like so:

.. image:: /_images/spoc/Jira-Webhook-Example2.png
:alt: Jira webhook example
:width: 85%

Now every time a chat is entered into the timeline a comment is added to the issue in Jira.

Expand Down Expand Up @@ -118,26 +124,31 @@ Set up an incoming mail handler for the project you want to receive issues from

.. image:: /_images/spoc/Jira1.png
:alt: Set up an Incoming mail handler
:width: 35%

In the sidebar select :guilabel:`Incoming Mail`.

.. image:: /_images/spoc/Jira2.png
:alt: Select Incoming Mail
:width: 25%

Select :guilabel:`Add Incoming mail handler`.

.. image:: /_images/spoc/Jira3.png
:alt: Add incoming mail handler
:width: 75%

Give it a name and select the appropriate handler you want to use for this integration, like :guilabel:`Create a new issue or add a comment to an existing issue`. Then select :guilabel:`Next`.

.. image:: /_images/spoc/Jira4.png
:alt: Create a new issue or add a comment to an existing issue
:width: 75%

Select the project you want to associate this integration with, then select :guilabel:`Add`. In this example you select the :guilabel:`Splunk On-Call Critical Incidents`.

.. image:: /_images/spoc/Jira5.png
:alt: Adding VictorOps Critical Incidents project
:width: 75%

Retrieve the email address associated to the project. To do this go into your projects administration page and select :guilabel:`Email requests`. Copy the email you want to use to your clipboard.

Expand Down