Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📄 [RUMF-1075] add missing initialization parameters #1152

Merged
merged 3 commits into from
Nov 8, 2021
Merged

📄 [RUMF-1075] add missing initialization parameters #1152

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e8ac8e7
📄 add `replaySampleRate`
bcaudan Nov 4, 2021
83ee029
📄 add apm link
bcaudan Nov 4, 2021
43adaf1
📄 add `defaultPrivacyLevel`
bcaudan Nov 4, 2021
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
17 changes: 16 additions & 1 deletion packages/rum/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,12 @@ Allows you to control RUM views creation. See [override default RUM view names][
**Default**: `false` <br/>
Enables [automatic collection of users actions][6].

`defaultPrivacyLevel`
: Optional<br/>
**Type**: String<br/>
**Default**: `mask-user-input` <br/>
See [Session Replay Privacy Options][13].

`actionNameAttribute`
: Optional<br/>
**Type**: String<br/>
Expand All @@ -183,6 +189,12 @@ Specify your own attribute to be used to [name actions][9].
**Default**: `100`<br/>
The percentage of sessions to track: `100` for all, `0` for none. Only tracked sessions send rum events.

`replaySampleRate`
: Optional<br/>
**Type**: Number<br/>
**Default**: `100`<br/>
The percentage of tracked sessions with session replay pricing features: `100` for all, `0` for none. See [rum pricing][11] for more information.

`silentMultipleInit`
: Optional<br/>
**Type**: Boolean <br/>
Expand All @@ -197,7 +209,7 @@ Optional proxy URL (ex: https://www.proxy.com/path), see the full [proxy setup g
`allowedTracingOrigins`
: Optional<br/>
**Type**: List<br/>
A list of request origins used to inject tracing headers.
A list of request origins used to inject tracing headers. See [Connect RUM and Traces][12].

Options that must have matching configuration when also using `logs` SDK:

Expand Down Expand Up @@ -251,3 +263,6 @@ init(configuration: {
[8]: https://github.com/DataDog/browser-sdk/blob/main/packages/rum/BROWSER_SUPPORT.md
[9]: https://docs.datadoghq.com/real_user_monitoring/browser/tracking_user_actions#declaring-a-name-for-click-actions
[10]: https://docs.datadoghq.com/real_user_monitoring/browser/modifying_data_and_context/?tab=npm#override-default-rum-view-names
[11]: https://www.datadoghq.com/pricing/?product=real-user-monitoring#real-user-monitoring
[12]: https://docs.datadoghq.com/real_user_monitoring/connect_rum_and_traces?tab=browserrum
[13]: https://docs.datadoghq.com/real_user_monitoring/session_replay/privacy_options?tab=maskuserinput