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

Commit b8b606b

Browse files
authored
Merge pull request #1651 from isekzlysic/update-rum-session-replay.rst
Update rum-session-replay.rst
2 parents c1450b5 + 8dc9fcf commit b8b606b

File tree

1 file changed

+46
-5
lines changed

1 file changed

+46
-5
lines changed

rum/rum-session-replay.rst

Lines changed: 46 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@
55
Session replay in Splunk RUM
66
**********************************************************************
77

8-
Replay a session to take a look at exactly what the user experienced and make informed decisions about what to do next. Sessions have a maximum duration of four hours.
8+
Replay a session to take a look at exactly what a user experienced and make informed decisions about what to do next. Sessions have a maximum duration of four hours.
99

10-
.. note:: Customer is responsible for using Splunk Observability Cloud in compliance with applicable laws, including but not limited to providing notice to and obtaining any necessary consent form individuals whose data will be collected by Customer's use of the services.
10+
.. note::
11+
You are responsible for using Splunk Observability Cloud in compliance with applicable laws, including but not limited to providing notice to and obtaining any necessary consent from individuals whose data will be collected by Customer's use of the services.
1112

1213

1314
Use cases
@@ -103,24 +104,64 @@ To deactivate session replay you can either:
103104
Additional instrumentation settings
104105
------------------------------------
105106

106-
For more information on configuration options, see :new-page:`rrweb guide <https://github.com/rrweb-io/rrweb/blob/master/guide.md#guide>` on GitHub.
107+
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.
107108

108109
Redact information
109110
==============================
110-
Text is redacted by default, you can optionally configure image redaction as well. The following image shows how the Splunk RUM homepage looks with text redaction enabled. All text is replaced by * symbols.
111+
Text and inputs are redacted by default. You can optionally configure image redaction as well. The following image illustrates what the Splunk RUM homepage looks with text redaction enabled. All text is replaced by ``*`` characters.
111112

112113
.. image:: /_images/rum/SR-text-redaction.png
113114
:alt: Example home screen of a website with the text replaced by the star symbol to show redacted text.
114115
:width: 70%
115116

116117

118+
To disable all text redaction, set ``maskTextSelector: false``. To customize which elements are redacted, you can use the ``rr-mask`` class. Any element with this class will have its text redacted. Additionally, you can customize the class name by setting ``maskTextClass`` or ``maskTextSelector`` to a custom value. The custom value can be a regular expression.
119+
120+
Input redaction is handled separately. To disable all input redaction, set ``maskAllInputs: false``. To customize which inputs are redacted use the ``maskInputOptions`` option.
121+
122+
.. note::
123+
In the rrweb documentation, the default value of ``maskTextSelector`` is ``null`` and the default value of ``maskAllInputs`` is ``false``. However, Splunk RUM changes these default values in our configuration to ensure that all text and inputs are redacted by default. As a result, you must explicitly set ``maskTextSelector`` or ``maskAllInputs`` to ``false`` when no redaction is desired.
124+
125+
Examples:
126+
127+
.. code-block:: javascript
128+
129+
// Will disable text redaction on all elements except elements with default 'rr-mask' class
130+
SplunkSessionRecorder.init({
131+
// ... other configuration options
132+
maskTextSelector: false
133+
});
134+
135+
// Will redact only elements with 'my-custom-mask-class' class
136+
SplunkSessionRecorder.init({
137+
// ...
138+
maskTextClass: 'my-custom-mask-class',
139+
maskTextSelector: false
140+
});
141+
142+
// Redacts elements with class names starting with "sensitive-" or with specified IDs
143+
SplunkSessionRecorder.init({
144+
// ...
145+
maskTextClass: /^sensitive-.*$/,
146+
maskTextSelector: '#private-info, #hidden-section'
147+
});
148+
149+
// Will disable input redaction on all elements except password inputs
150+
SplunkSessionRecorder.init({
151+
// ...
152+
maskAllInputs: false,
153+
maskInputOptions: {
154+
password: true
155+
}
156+
});
157+
117158
118159
Image redaction
119160
----------------
120161

121162
To redact images, set ``inlineImages: false`` in the ``splunksessionrecorder.init`` function.
122163

123-
For more information on how to customize your instrumentation, see the Privacy section of the :new-page:`rrweb guide <https://github.com/rrweb-io/rrweb/blob/master/guide.md#privacy>` on GitHub.
164+
For more information on how to customize your instrumentation, see the Privacy section of the :new-page:`rrweb guide <https://github.com/rrweb-io/rrweb/blob/rrweb%401.1.3/guide.md#privacy>` on GitHub.
124165

125166

126167
Replay a session

0 commit comments

Comments
 (0)