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

Commit ea2169b

Browse files
authored
Merge pull request #2695 from splunk/adasplunk-DOCGUILD-28874
[DOCGUILD-28874] Bugfix to match DEMRUM-1675
2 parents df8166b + 8137cf2 commit ea2169b

File tree

1 file changed

+35
-18
lines changed

1 file changed

+35
-18
lines changed

rum/rum-session-replay.rst

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ Replay a session to take a look at exactly what a user experienced and make info
1212

1313

1414
Use cases
15-
===================
15+
======================================================================
16+
1617
There are many reasons why you might want to replay sessions. Here are a few:
1718

1819
* 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.
@@ -21,19 +22,20 @@ There are many reasons why you might want to replay sessions. Here are a few:
2122

2223

2324
Prerequisite
24-
=================
25+
======================================================================
2526

2627
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>`.
2728

2829

2930
Set up session replay
30-
=====================
31-
There are two ways to set up session replay: CDN or NPM.
31+
======================================================================
3232

33-
.. admonition:: Note
34-
33+
There are three ways to set up session replay: CDN, self-hosted, or NPM.
34+
35+
.. note::
3536
Initialize Splunk Browser RUM before you initialize the session recorder package.
3637

38+
3739
This example shows the order in which to initialize the scripts:
3840

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

7274

7375

74-
NPM
76+
Self-hosted
7577
--------------------------------------------
7678

77-
Use the following command to set up session replay with NPM through a package named ``@splunk/otel-web-session-recorder``.
79+
#. 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>`.
80+
#. Deploy the file in a location accessible by the users of your application.
81+
#. Add the following session replay snippet after the ``SplunkRum.init`` snippet:
7882

83+
.. code-block:: javascript
7984
80-
.. code-block:: html
85+
<script src="<your-self-hosted-path>/splunk-otel-web-session-recorder.js" crossorigin="anonymous"></script>
8186
82-
npm install @splunk/otel-web-session-recorder
8387
84-
Next, initialize this code snippet:
88+
To avoid gaps in your data, load and initialize the Splunk JavaScript Agent asynchronously and as early as possible.
8589

86-
.. code-block:: html
8790

88-
import SplunkSessionRecorder from '@splunk/otel-web-session-recorder'
91+
NPM
92+
--------------------------------------------
8993

90-
SplunkSessionRecorder.init({
91-
realm: '<realm>',
92-
rumAccessToken: '<your_rum_token>'
93-
});
94+
#. Use the following command to set up session replay with NPM through a package named ``@splunk/otel-web-session-recorder``.
95+
96+
.. code-block:: html
97+
98+
npm install @splunk/otel-web-session-recorder
99+
100+
#. Next, initialize this code snippet:
101+
102+
.. code-block:: html
103+
104+
import SplunkSessionRecorder from '@splunk/otel-web-session-recorder'
105+
106+
SplunkSessionRecorder.init({
107+
realm: '<realm>',
108+
rumAccessToken: '<your_rum_token>'
109+
});
94110

95111

96112
Deactivate session replay
97113
--------------------------------------------
114+
98115
To deactivate session replay you can either:
99116

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

103120

104121
Additional instrumentation settings
105-
------------------------------------
122+
--------------------------------------------
106123

107124
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.
108125

0 commit comments

Comments
 (0)