Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions apm/db-query-perf/turn-on-db-perf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ Follow these steps to turn on Database Query Performance and begin indexing data
:width: 25%
:alt: Screenshot of the APM Configuration menu on the APM landing page.

.. note:: Before proceeding, ensure that you have configured the instrumentation for your specific programming language:
* Java, see :ref:`instrument-java-applications`.
* .NET, see :ref:`configure-otel-dotnet`.
* Python, see :ref:`instrument-python-applications`.
* Node.js, see :ref:`instrument-nodejs-applications-3x`.

2. In the Database Query Performance section, check that the :guilabel:`Status` is Active. If it is, skip to the next step. If it's not, select :guilabel:`Resume Indexing` to initiate cardinality analysis, and then wait for the cardinality analysis to run in the Pending MetricSet section at the top of the table.

.. image:: /_images/apm/db-query-perf/db-cardinality-success.png
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,8 @@ SQL statements might contain sensitive information. To configure this behavior,
* ``OTEL_DOTNET_AUTO_ENTITYFRAMEWORKCORE_SET_DBSTATEMENT_FOR_TEXT``
* ``OTEL_DOTNET_AUTO_ORACLEMDA_SET_DBSTATEMENT_FOR_TEXT``

For more details on enabling Database Query Performance, visit :ref:`turn-on-db-perf`.

.. _docker-install-otel-dotnet:

Instrument an application running within a Docker container
Expand Down
5 changes: 2 additions & 3 deletions gdi/get-data-in/connect/aws/get-awstoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,7 @@ You can deactivate this check by setting the ``enableCheckLargeVolume`` field in
<h4>Tag filtering<a name="tag-filtering-aws" class="headerlink" href="#tag-filtering-aws" title="Permalink to this headline">¶</a></h4>
</embed>

If you filter data based on tags, your costs for Amazon CloudWatch and Splunk Infrastructure Monitoring might decrease. Read more at :ref:`specify-data-metadata`.

If you filter data based on tags, your costs for Amazon CloudWatch and Splunk Observability Cloud might decrease. Read more at :ref:`specify-data-metadata`.


.. raw:: html
Expand All @@ -126,7 +125,7 @@ If you filter data based on tags, your costs for Amazon CloudWatch and Splunk In
<div class="include-stop" id="gdi/aws-unsupported-chars.rst"></div>



For more information on tagging see :ref:`aws-data-in-splunk`.

.. raw:: html

Expand Down
12 changes: 8 additions & 4 deletions infrastructure/monitor/aws-infra-import.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,20 @@ AWS provides a CloudWatch agent that lets you import metrics, logs, and metadata

By default, Splunk Observability Cloud brings in data from all :ref:`supported AWS services <aws-integrations>` associated with your account, with :ref:`certain limitations <aws-data-limits>`.

.. _aws-data-in-splunk:

AWS data in Splunk Observability Cloud
--------------------------------------------------------------------------------

During import, Splunk Observability Cloud gives the metrics special names so you can identify them as coming from AWS:
During import, Splunk Observability Cloud gives metrics special names so you can identify them as coming from AWS:

- AWS metadata becomes dimensions and custom properties.
- AWS tags are key-value pairs, so Infrastructure Monitoring converts them into custom properties.

Splunk Observability Cloud adds the prefix ``aws_tag_`` to the names of tags imported from AWS, which indicates their origin. For example, the AWS tag ``version:canary`` is converted to ``aws_tag_version:canary``.

.. caution:: For target groups Splunk Observability Cloud adds the prefix ``aws_tag_tg_`` to avoid conflicts with load balancer tags.

To learn more, see :ref:`aws-oc-metrics`, or refer to the AWS documentation site.

.. _aws-namespaces:
Expand Down Expand Up @@ -235,9 +241,7 @@ To create these specifications, follow these steps:
* Use :guilabel:`Import some` if you want a filter that only imports data.
* Use :guilabel:`Exclude some` if you want a filter that only excludes data.

#. To use AWS tags to limit the data Infrastructure Monitoring imports, filter by tag. For this example, specify a filter that excludes data from resources that have the AWS tag ``version:canary``.

Infrastructure Monitoring adds the prefix ``aws_tag_`` to the names of tags imported from AWS, which indicates their origin. For example, the AWS tag ``version:canary`` appears in Infrastructure Monitoring as ``aws_tag_version:canary``. When you filter an AWS integration by tag, enter the name of the tag as it appears in AWS.
#. To use AWS tags to limit the data Infrastructure Monitoring imports, filter by tag. For this example, specify a filter that excludes data from resources that have the AWS tag ``version:canary``. Infrastructure Monitoring adds the prefix ``aws_tag_`` to the names of tags imported from AWS, which indicates their origin. For example, the AWS tag ``version:canary`` appears in Infrastructure Monitoring as ``aws_tag_version:canary``. When you filter an AWS integration by tag, enter the name of the tag as it appears in AWS.

You can also choose specific metrics to include or exclude. For example, consider the following conditions.

Expand Down
2 changes: 1 addition & 1 deletion infrastructure/monitor/aws-infra-metadata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ For example, `DBClusterIdentifier` becomes `aws_db_cluster_identifier`.
Common properties
=============================================================================

For all services, the system imports the following common properties:
For all services, Splunk Observability Cloud imports the following common properties:

.. list-table::
:header-rows: 1
Expand Down
53 changes: 35 additions & 18 deletions rum/rum-session-replay.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ Replay a session to take a look at exactly what a user experienced and make info


Use cases
===================
======================================================================

There are many reasons why you might want to replay sessions. Here are a few:

* Reduce the amount of time support teams take to troubleshoot a problem. By seeing errors from the perspective of an actual user, support teams can quickly identify what happened, and take action. Without session replay, support teams could spend a long time investigating a variety of possible causes based on an incomplete description of the problem.
Expand All @@ -21,19 +22,20 @@ There are many reasons why you might want to replay sessions. Here are a few:


Prerequisite
=================
======================================================================

Session replay is available for enterprise customers only. For more information on each type of subscription, see :new-page:`Splunk RUM Pricing <https://www.splunk.com/en_us/products/pricing/faqs/observability.html#splunk-rum>`.


Set up session replay
=====================
There are two ways to set up session replay: CDN or NPM.
======================================================================

.. admonition:: Note

There are three ways to set up session replay: CDN, self-hosted, or NPM.

.. note::
Initialize Splunk Browser RUM before you initialize the session recorder package.


This example shows the order in which to initialize the scripts:

.. code-block:: html
Expand Down Expand Up @@ -71,38 +73,53 @@ Initialize this code snippet to set up session replay through Splunk CDN.



NPM
Self-hosted
--------------------------------------------

Use the following command to set up session replay with NPM through a package named ``@splunk/otel-web-session-recorder``.
#. Download the desired version of :new-page:`splunk-otel-web-session-recorder.js <https://github.com/signalfx/splunk-otel-js-web/releases/latest/download/splunk-otel-web-session-recorder.js>`.
#. Deploy the file in a location accessible by the users of your application.
#. Add the following session replay snippet after the ``SplunkRum.init`` snippet:

.. code-block:: javascript

.. code-block:: html
<script src="<your-self-hosted-path>/splunk-otel-web-session-recorder.js" crossorigin="anonymous"></script>

npm install @splunk/otel-web-session-recorder

Next, initialize this code snippet:
To avoid gaps in your data, load and initialize the Splunk JavaScript Agent asynchronously and as early as possible.

.. code-block:: html

import SplunkSessionRecorder from '@splunk/otel-web-session-recorder'
NPM
--------------------------------------------

SplunkSessionRecorder.init({
realm: '<realm>',
rumAccessToken: '<your_rum_token>'
});
#. Use the following command to set up session replay with NPM through a package named ``@splunk/otel-web-session-recorder``.

.. code-block:: html

npm install @splunk/otel-web-session-recorder

#. Next, initialize this code snippet:

.. code-block:: html

import SplunkSessionRecorder from '@splunk/otel-web-session-recorder'

SplunkSessionRecorder.init({
realm: '<realm>',
rumAccessToken: '<your_rum_token>'
});


Deactivate session replay
--------------------------------------------

To deactivate session replay you can either:

* Turn it off for the particular session replay.
* Remove the instrumentation if you want to deactivate it completely.


Additional instrumentation settings
------------------------------------
--------------------------------------------

For more information on configuration options, see :new-page:`rrweb guide <https://github.com/rrweb-io/rrweb/blob/rrweb%401.1.3/guide.md#guide>` on GitHub.

Expand Down
4 changes: 2 additions & 2 deletions synthetics/test-config/private-locations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -502,7 +502,7 @@ Automatic upgrades
###################################

You can automate the upgrade of the private location Docker images by using an automated upgrade solution such as
`Watchtower <https://github.com/v2tec/watchtower>`, a third party open source Docker container that connects to remote Docker repositories on a schedule and checks for updates. This section explains how to use Watchtower, but if your operations team already has a mechanism established for deploying updates to Docker images you can use your existing mechanism without making any configuration changes to the private runner. The best practice is to run your upgrade automation at least once every 24 hours. Failing to update the private runner to the latest available image may result in inconsistent data and loss of functionality.
:new-page:`Watchtower <https://github.com/v2tec/watchtower>`, a third-party open source Docker container that connects to remote Docker repositories on a schedule and checks for updates. This section explains how to use Watchtower, but if your operations team already has a mechanism established for deploying updates to Docker images, you can use your existing mechanism without making any configuration changes to the private runner. The best practice is to run your upgrade automation at least once every 24 hours. Failing to update the private runner to the latest available image may result in inconsistent data and loss of functionality.

When Watchtower finds an updated image, it instructs your Docker host to pull the newest image from the repository, stop the container, and start it again. It also ensures that environment variables, network settings, and links between containers are intact.

Expand All @@ -517,7 +517,7 @@ On your Docker host, launch the Watchtower container from the command line:

Using the ``label-enable`` flag ensures that only containers with the correct label, like the Splunk private runner, are be auto-updated.

There are additional options available in the `Watchtower documentation <https://github.com/v2tec/watchtower#options>` that you can explore, including auto-cleanup of old images to ensure that your Docker host does not hold onto outdated images.
There are additional options available in the :new-page:`Watchtower documentation <https://github.com/v2tec/watchtower#options>` that you can explore, including auto-cleanup of old images to ensure that your Docker host does not hold onto outdated images.

.. note::
In order for Watchtower to issue commands to the Docker host, it requires the ``docker.sock`` volume or TCP connection, which provides Watchtower with full administrative access to your Docker host. If you are unable to provide Watchtower with this level of access you can explore other options for automating updates.
Expand Down