Skip to content

Commit f25be24

Browse files
authored
Merge pull request #8078 from segmentio/auto-instrumentation-web-obfuscation
Document signal value obfuscation in web setup
2 parents 134d935 + f259250 commit f25be24

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

src/connections/auto-instrumentation/web-setup.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,35 @@ https://my-website.com?segment_signals_debug=false
232232

233233
### Advanced
234234

235+
#### Signal redaction and debug visibility
236+
237+
The Signals SDK automatically hides sensitive values in user interactions before sending them to Segment.
238+
239+
To protect user data, the SDK replaces real values with safe, generic placeholders: strings become `"XXX"`, numbers become `999`, and booleans become `true`.
240+
241+
Redaction applies to everything the SDK collects, including:
242+
243+
- Form submissions and text inputs
244+
- Clickable elements and their text content
245+
- Request bodies for tracked network calls
246+
- Certain DOM attributes observed by mutation listeners
247+
248+
If you’re troubleshooting and want to see real values while debugging, you can disable redaction temporarily by adding this to your site URL:
249+
250+
```bash
251+
?segment_signals_debug=true&segment_signals_disable_redaction=true
252+
```
253+
254+
Use this only in a safe testing environment: **disabling redaction can expose real user information (PII)**.
255+
256+
For persistent setups or automated testing, you can also control this behavior in code with:
257+
258+
```ts
259+
new SignalsPlugin({ disableSignalRedaction: true })
260+
```
261+
262+
For more information, see the [configuration options table](#configuration-options).
263+
235264
#### Emitting custom signals
236265

237266
If you need to listen for data that is unavailable to the Signals plugin by default, you can create and emit a custom signal:

0 commit comments

Comments
 (0)