Class RumSdkConfigRumAttributes

The RUM SDK settings for a configuration.

Hierarchy

  • RumSdkConfigRumAttributes

Constructors

constructor

Properties

additionalProperties? allowedTracingUrls? allowedTrackingOrigins? applicationId context? defaultPrivacyLevel enablePrivacyForActionName env? service? sessionReplaySampleRate sessionSampleRate traceSampleRate? trackSessionAcrossSubdomains? user? version?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional allowedTracingUrls

allowedTracingUrls?: RumSdkConfigTracingUrlConfig[]

A list of URL configurations for distributed tracing.

Optional allowedTrackingOrigins

allowedTrackingOrigins?: RumSdkConfigMatchOption[]

A list of origin patterns allowed for cross-origin session tracking.

applicationId

applicationId: string

The ID of the RUM application this configuration belongs to.

Optional context

context?: RumSdkConfigDynamicOptionPair[]

A list of dynamic option key-value pairs.

defaultPrivacyLevel

defaultPrivacyLevel: string

The default privacy masking level applied to all RUM data.

enablePrivacyForActionName

enablePrivacyForActionName: boolean

Whether to mask user-interaction action names for privacy.

Optional env

env?: string

The environment tag for the RUM application.

Optional service

service?: string

The service name tag for the RUM application.

sessionReplaySampleRate

sessionReplaySampleRate: number

The percentage of collected sessions for which a replay is captured (0–100).

sessionSampleRate

sessionSampleRate: number

The percentage of user sessions to collect (0–100).

Optional traceSampleRate

traceSampleRate?: number

The percentage of requests to forward as APM traces (0–100).

Optional trackSessionAcrossSubdomains

trackSessionAcrossSubdomains?: boolean

Whether to share a session across subdomains of the same site.

Optional user

user?: RumSdkConfigDynamicOptionPair[]

A list of dynamic option key-value pairs.

Optional version

version?: RumSdkConfigDynamicOption

A dynamic configuration option that extracts a value at runtime using a specified strategy.

Settings

Member Visibility

Theme

Generated using TypeDoc