-
public final class TelemetryConfigurationEvent.ConfigurationConfiguration properties
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classTelemetryConfigurationEvent.Configuration.Companion
-
Field Summary
-
Constructor Summary
Constructors Constructor Description TelemetryConfigurationEvent.Configuration(Long sessionSampleRate, Long telemetrySampleRate, Long telemetryConfigurationSampleRate, Long telemetryUsageSampleRate, Long traceSampleRate, TelemetryConfigurationEvent.TraceContextInjection traceContextInjection, Long premiumSampleRate, Long replaySampleRate, Long sessionReplaySampleRate, TelemetryConfigurationEvent.TrackingConsent trackingConsent, Boolean startSessionReplayRecordingManually, Boolean startRecordingImmediately, Boolean useProxy, Boolean useBeforeSend, Boolean silentMultipleInit, Boolean trackSessionAcrossSubdomains, Boolean trackResources, Boolean trackLongTask, Boolean useCrossSiteSessionCookie, Boolean usePartitionedCrossSiteSessionCookie, Boolean useSecureSessionCookie, Boolean allowFallbackToLocalStorage, Boolean storeContextsAcrossPages, Boolean allowUntrustedEvents, String actionNameAttribute, Boolean useAllowedTracingOrigins, Boolean useAllowedTracingUrls, List<TelemetryConfigurationEvent.SelectedTracingPropagator> selectedTracingPropagators, String defaultPrivacyLevel, String textAndInputPrivacyLevel, String imagePrivacyLevel, String touchPrivacyLevel, Boolean enablePrivacyForActionName, Boolean useExcludedActivityUrls, Boolean useWorkerUrl, Boolean compressIntakeRequests, Boolean trackFrustrations, Boolean trackViewsManually, Boolean trackInteractions, Boolean trackUserInteractions, Boolean forwardErrorsToLogs, List<String> forwardConsoleLogs, List<String> forwardReports, Boolean useLocalEncryption, TelemetryConfigurationEvent.ViewTrackingStrategy viewTrackingStrategy, Boolean trackBackgroundEvents, Long mobileVitalsUpdatePeriod, Boolean trackErrors, Boolean trackNetworkRequests, Boolean useTracing, Boolean trackNativeViews, Boolean trackNativeErrors, Boolean trackNativeLongTasks, Boolean trackCrossPlatformLongTasks, Boolean useFirstPartyHosts, String initializationType, Boolean trackFlutterPerformance, Long batchSize, Long batchUploadFrequency, Long batchProcessingLevel, Boolean backgroundTasksEnabled, String reactVersion, String reactNativeVersion, String dartVersion, String unityVersion, Long appHangThreshold, Boolean usePciIntake, String tracerApi, String tracerApiVersion, Boolean sendLogsAfterSessionExpiration, List<TelemetryConfigurationEvent.Plugin> plugins, Boolean isMainProcess, List<TelemetryConfigurationEvent.CollectFeatureFlagsOn> collectFeatureFlagsOn)
-
Method Summary
-
-
Constructor Detail
-
TelemetryConfigurationEvent.Configuration
TelemetryConfigurationEvent.Configuration(Long sessionSampleRate, Long telemetrySampleRate, Long telemetryConfigurationSampleRate, Long telemetryUsageSampleRate, Long traceSampleRate, TelemetryConfigurationEvent.TraceContextInjection traceContextInjection, Long premiumSampleRate, Long replaySampleRate, Long sessionReplaySampleRate, TelemetryConfigurationEvent.TrackingConsent trackingConsent, Boolean startSessionReplayRecordingManually, Boolean startRecordingImmediately, Boolean useProxy, Boolean useBeforeSend, Boolean silentMultipleInit, Boolean trackSessionAcrossSubdomains, Boolean trackResources, Boolean trackLongTask, Boolean useCrossSiteSessionCookie, Boolean usePartitionedCrossSiteSessionCookie, Boolean useSecureSessionCookie, Boolean allowFallbackToLocalStorage, Boolean storeContextsAcrossPages, Boolean allowUntrustedEvents, String actionNameAttribute, Boolean useAllowedTracingOrigins, Boolean useAllowedTracingUrls, List<TelemetryConfigurationEvent.SelectedTracingPropagator> selectedTracingPropagators, String defaultPrivacyLevel, String textAndInputPrivacyLevel, String imagePrivacyLevel, String touchPrivacyLevel, Boolean enablePrivacyForActionName, Boolean useExcludedActivityUrls, Boolean useWorkerUrl, Boolean compressIntakeRequests, Boolean trackFrustrations, Boolean trackViewsManually, Boolean trackInteractions, Boolean trackUserInteractions, Boolean forwardErrorsToLogs, List<String> forwardConsoleLogs, List<String> forwardReports, Boolean useLocalEncryption, TelemetryConfigurationEvent.ViewTrackingStrategy viewTrackingStrategy, Boolean trackBackgroundEvents, Long mobileVitalsUpdatePeriod, Boolean trackErrors, Boolean trackNetworkRequests, Boolean useTracing, Boolean trackNativeViews, Boolean trackNativeErrors, Boolean trackNativeLongTasks, Boolean trackCrossPlatformLongTasks, Boolean useFirstPartyHosts, String initializationType, Boolean trackFlutterPerformance, Long batchSize, Long batchUploadFrequency, Long batchProcessingLevel, Boolean backgroundTasksEnabled, String reactVersion, String reactNativeVersion, String dartVersion, String unityVersion, Long appHangThreshold, Boolean usePciIntake, String tracerApi, String tracerApiVersion, Boolean sendLogsAfterSessionExpiration, List<TelemetryConfigurationEvent.Plugin> plugins, Boolean isMainProcess, List<TelemetryConfigurationEvent.CollectFeatureFlagsOn> collectFeatureFlagsOn)
- Parameters:
sessionSampleRate- The percentage of sessions trackedtelemetrySampleRate- The percentage of telemetry events senttelemetryConfigurationSampleRate- The percentage of telemetry configuration events sent after being sampled by telemetry_sample_ratetelemetryUsageSampleRate- The percentage of telemetry usage events sent after being sampled by telemetry_sample_ratetraceSampleRate- The percentage of requests tracedtraceContextInjection- The opt-in configuration to add trace contextpremiumSampleRate- The percentage of sessions with Browser RUM & Session Replay pricing tracked (deprecated in favor of session_replay_sample_rate)replaySampleRate- The percentage of sessions with Browser RUM & Session Replay pricing tracked (deprecated in favor of session_replay_sample_rate)sessionReplaySampleRate- The percentage of sessions with RUM & Session Replay pricing trackedtrackingConsent- The initial tracking consent valuestartSessionReplayRecordingManually- Whether the session replay start is handled manuallystartRecordingImmediately- Whether Session Replay should automatically start a recording when enableduseProxy- Whether a proxy is useduseBeforeSend- Whether beforeSend callback function is usedsilentMultipleInit- Whether initialization fails silently if the SDK is already initializedtrackSessionAcrossSubdomains- Whether sessions across subdomains for the same site are trackedtrackResources- Whether resources are trackedtrackLongTask- Whether long tasks are trackeduseCrossSiteSessionCookie- Whether a secure cross-site session cookie is used (deprecated)usePartitionedCrossSiteSessionCookie- Whether a partitioned secure cross-site session cookie is useduseSecureSessionCookie- Whether a secure session cookie is usedallowFallbackToLocalStorage- Whether it is allowed to use LocalStorage when cookies are not availablestoreContextsAcrossPages- Whether contexts are stored in local storageallowUntrustedEvents- Whether untrusted events are allowedactionNameAttribute- Attribute to be used to name actionsuseAllowedTracingOrigins- Whether the allowed tracing origins list is used (deprecated in favor of use_allowed_tracing_urls)useAllowedTracingUrls- Whether the allowed tracing urls list is usedselectedTracingPropagators- A list of selected tracing propagatorsdefaultPrivacyLevel- Session replay default privacy leveltextAndInputPrivacyLevel- Session replay text and input privacy levelimagePrivacyLevel- Session replay image privacy leveltouchPrivacyLevel- Session replay touch privacy levelenablePrivacyForActionName- Privacy control for action nameuseExcludedActivityUrls- Whether the request origins list to ignore when computing the page activity is useduseWorkerUrl- Whether the Worker is loaded from an external URLcompressIntakeRequests- Whether intake requests are compressedtrackFrustrations- Whether user frustrations are trackedtrackViewsManually- Whether the RUM views creation is handled manuallytrackInteractions- Whether user actions are tracked (deprecated in favor of track_user_interactions)trackUserInteractions- Whether user actions are trackedforwardErrorsToLogs- Whether console.useLocalEncryption- Whether local encryption is usedviewTrackingStrategy- View tracking strategytrackBackgroundEvents- Whether RUM events are tracked when the application is in BackgroundmobileVitalsUpdatePeriod- The period between each Mobile Vital sample (in milliseconds)trackErrors- Whether error monitoring & crash reporting is enabled for the source platformtrackNetworkRequests- Whether automatic collection of network requests is enableduseTracing- Whether tracing features are enabledtrackNativeViews- Whether native views are tracked (for cross platform SDKs)trackNativeErrors- Whether native error monitoring & crash reporting is enabled (for cross platform SDKs)trackNativeLongTasks- Whether long task tracking is performed automaticallytrackCrossPlatformLongTasks- Whether long task tracking is performed automatically for cross platform SDKsuseFirstPartyHosts- Whether the client has provided a list of first party hostsinitializationType- The type of initialization the SDK used, in case multiple are supportedtrackFlutterPerformance- Whether Flutter build and raster time tracking is enabledbatchSize- The window duration for batches sent by the SDK (in milliseconds)batchUploadFrequency- The upload frequency of batches (in milliseconds)batchProcessingLevel- Maximum number of batches processed sequentially without a delaybackgroundTasksEnabled- Whether UIApplication background tasks are enabledreactVersion- The version of React used in a ReactNative applicationreactNativeVersion- The version of ReactNative used in a ReactNative applicationdartVersion- The version of Dart used in a Flutter applicationunityVersion- The version of Unity used in a Unity applicationappHangThreshold- The threshold used for iOS App Hangs monitoring (in milliseconds)usePciIntake- Whether logs are sent to the PCI-compliant intaketracerApi- The tracer API used by the SDK.tracerApiVersion- The version of the tracer API used by the SDK.sendLogsAfterSessionExpiration- Whether logs are sent after the session expirationplugins- The list of plugins enabledisMainProcess- Whether the SDK is initialised on the application's main or a secondary processcollectFeatureFlagsOn- The list of events that include feature flags collection
-
-
Method Detail
-
getSessionSampleRate
final Long getSessionSampleRate()
-
getTelemetrySampleRate
final Long getTelemetrySampleRate()
-
getTelemetryConfigurationSampleRate
final Long getTelemetryConfigurationSampleRate()
-
getTelemetryUsageSampleRate
final Long getTelemetryUsageSampleRate()
-
getTraceSampleRate
final Long getTraceSampleRate()
-
getTraceContextInjection
final TelemetryConfigurationEvent.TraceContextInjection getTraceContextInjection()
-
setTraceContextInjection
final Unit setTraceContextInjection(TelemetryConfigurationEvent.TraceContextInjection traceContextInjection)
- Parameters:
traceContextInjection- The opt-in configuration to add trace context
-
getPremiumSampleRate
final Long getPremiumSampleRate()
-
getReplaySampleRate
final Long getReplaySampleRate()
-
getSessionReplaySampleRate
final Long getSessionReplaySampleRate()
-
setSessionReplaySampleRate
final Unit setSessionReplaySampleRate(Long sessionReplaySampleRate)
- Parameters:
sessionReplaySampleRate- The percentage of sessions with RUM & Session Replay pricing tracked
-
getTrackingConsent
final TelemetryConfigurationEvent.TrackingConsent getTrackingConsent()
-
getStartSessionReplayRecordingManually
final Boolean getStartSessionReplayRecordingManually()
-
setStartSessionReplayRecordingManually
final Unit setStartSessionReplayRecordingManually(Boolean startSessionReplayRecordingManually)
- Parameters:
startSessionReplayRecordingManually- Whether the session replay start is handled manually
-
getStartRecordingImmediately
final Boolean getStartRecordingImmediately()
-
setStartRecordingImmediately
final Unit setStartRecordingImmediately(Boolean startRecordingImmediately)
- Parameters:
startRecordingImmediately- Whether Session Replay should automatically start a recording when enabled
-
getUseProxy
final Boolean getUseProxy()
-
setUseProxy
final Unit setUseProxy(Boolean useProxy)
- Parameters:
useProxy- Whether a proxy is used
-
getUseBeforeSend
final Boolean getUseBeforeSend()
-
getSilentMultipleInit
final Boolean getSilentMultipleInit()
-
getTrackSessionAcrossSubdomains
final Boolean getTrackSessionAcrossSubdomains()
-
getTrackResources
final Boolean getTrackResources()
-
setTrackResources
final Unit setTrackResources(Boolean trackResources)
- Parameters:
trackResources- Whether resources are tracked
-
getTrackLongTask
final Boolean getTrackLongTask()
-
setTrackLongTask
final Unit setTrackLongTask(Boolean trackLongTask)
- Parameters:
trackLongTask- Whether long tasks are tracked
-
getUseCrossSiteSessionCookie
final Boolean getUseCrossSiteSessionCookie()
-
getUsePartitionedCrossSiteSessionCookie
final Boolean getUsePartitionedCrossSiteSessionCookie()
-
getUseSecureSessionCookie
final Boolean getUseSecureSessionCookie()
-
getAllowFallbackToLocalStorage
final Boolean getAllowFallbackToLocalStorage()
-
getStoreContextsAcrossPages
final Boolean getStoreContextsAcrossPages()
-
getAllowUntrustedEvents
final Boolean getAllowUntrustedEvents()
-
getActionNameAttribute
final String getActionNameAttribute()
-
getUseAllowedTracingOrigins
final Boolean getUseAllowedTracingOrigins()
-
getUseAllowedTracingUrls
final Boolean getUseAllowedTracingUrls()
-
getSelectedTracingPropagators
final List<TelemetryConfigurationEvent.SelectedTracingPropagator> getSelectedTracingPropagators()
-
getDefaultPrivacyLevel
final String getDefaultPrivacyLevel()
-
setDefaultPrivacyLevel
final Unit setDefaultPrivacyLevel(String defaultPrivacyLevel)
- Parameters:
defaultPrivacyLevel- Session replay default privacy level
-
getTextAndInputPrivacyLevel
final String getTextAndInputPrivacyLevel()
-
setTextAndInputPrivacyLevel
final Unit setTextAndInputPrivacyLevel(String textAndInputPrivacyLevel)
- Parameters:
textAndInputPrivacyLevel- Session replay text and input privacy level
-
getImagePrivacyLevel
final String getImagePrivacyLevel()
-
setImagePrivacyLevel
final Unit setImagePrivacyLevel(String imagePrivacyLevel)
- Parameters:
imagePrivacyLevel- Session replay image privacy level
-
getTouchPrivacyLevel
final String getTouchPrivacyLevel()
-
setTouchPrivacyLevel
final Unit setTouchPrivacyLevel(String touchPrivacyLevel)
- Parameters:
touchPrivacyLevel- Session replay touch privacy level
-
getEnablePrivacyForActionName
final Boolean getEnablePrivacyForActionName()
-
setEnablePrivacyForActionName
final Unit setEnablePrivacyForActionName(Boolean enablePrivacyForActionName)
- Parameters:
enablePrivacyForActionName- Privacy control for action name
-
getUseExcludedActivityUrls
final Boolean getUseExcludedActivityUrls()
-
getUseWorkerUrl
final Boolean getUseWorkerUrl()
-
getCompressIntakeRequests
final Boolean getCompressIntakeRequests()
-
getTrackFrustrations
final Boolean getTrackFrustrations()
-
setTrackFrustrations
final Unit setTrackFrustrations(Boolean trackFrustrations)
- Parameters:
trackFrustrations- Whether user frustrations are tracked
-
getTrackViewsManually
final Boolean getTrackViewsManually()
-
setTrackViewsManually
final Unit setTrackViewsManually(Boolean trackViewsManually)
- Parameters:
trackViewsManually- Whether the RUM views creation is handled manually
-
getTrackInteractions
final Boolean getTrackInteractions()
-
setTrackInteractions
final Unit setTrackInteractions(Boolean trackInteractions)
- Parameters:
trackInteractions- Whether user actions are tracked (deprecated in favor of track_user_interactions)
-
getTrackUserInteractions
final Boolean getTrackUserInteractions()
-
setTrackUserInteractions
final Unit setTrackUserInteractions(Boolean trackUserInteractions)
- Parameters:
trackUserInteractions- Whether user actions are tracked
-
getForwardErrorsToLogs
final Boolean getForwardErrorsToLogs()
-
getForwardConsoleLogs
final List<String> getForwardConsoleLogs()
-
getForwardReports
final List<String> getForwardReports()
-
getUseLocalEncryption
final Boolean getUseLocalEncryption()
-
getViewTrackingStrategy
final TelemetryConfigurationEvent.ViewTrackingStrategy getViewTrackingStrategy()
-
getTrackBackgroundEvents
final Boolean getTrackBackgroundEvents()
-
setTrackBackgroundEvents
final Unit setTrackBackgroundEvents(Boolean trackBackgroundEvents)
- Parameters:
trackBackgroundEvents- Whether RUM events are tracked when the application is in Background
-
getMobileVitalsUpdatePeriod
final Long getMobileVitalsUpdatePeriod()
-
setMobileVitalsUpdatePeriod
final Unit setMobileVitalsUpdatePeriod(Long mobileVitalsUpdatePeriod)
- Parameters:
mobileVitalsUpdatePeriod- The period between each Mobile Vital sample (in milliseconds)
-
getTrackErrors
final Boolean getTrackErrors()
-
setTrackErrors
final Unit setTrackErrors(Boolean trackErrors)
- Parameters:
trackErrors- Whether error monitoring & crash reporting is enabled for the source platform
-
getTrackNetworkRequests
final Boolean getTrackNetworkRequests()
-
setTrackNetworkRequests
final Unit setTrackNetworkRequests(Boolean trackNetworkRequests)
- Parameters:
trackNetworkRequests- Whether automatic collection of network requests is enabled
-
getUseTracing
final Boolean getUseTracing()
-
getTrackNativeViews
final Boolean getTrackNativeViews()
-
setTrackNativeViews
final Unit setTrackNativeViews(Boolean trackNativeViews)
- Parameters:
trackNativeViews- Whether native views are tracked (for cross platform SDKs)
-
getTrackNativeErrors
final Boolean getTrackNativeErrors()
-
setTrackNativeErrors
final Unit setTrackNativeErrors(Boolean trackNativeErrors)
- Parameters:
trackNativeErrors- Whether native error monitoring & crash reporting is enabled (for cross platform SDKs)
-
getTrackNativeLongTasks
final Boolean getTrackNativeLongTasks()
-
setTrackNativeLongTasks
final Unit setTrackNativeLongTasks(Boolean trackNativeLongTasks)
- Parameters:
trackNativeLongTasks- Whether long task tracking is performed automatically
-
getTrackCrossPlatformLongTasks
final Boolean getTrackCrossPlatformLongTasks()
-
setTrackCrossPlatformLongTasks
final Unit setTrackCrossPlatformLongTasks(Boolean trackCrossPlatformLongTasks)
- Parameters:
trackCrossPlatformLongTasks- Whether long task tracking is performed automatically for cross platform SDKs
-
getUseFirstPartyHosts
final Boolean getUseFirstPartyHosts()
-
setUseFirstPartyHosts
final Unit setUseFirstPartyHosts(Boolean useFirstPartyHosts)
- Parameters:
useFirstPartyHosts- Whether the client has provided a list of first party hosts
-
getInitializationType
final String getInitializationType()
-
setInitializationType
final Unit setInitializationType(String initializationType)
- Parameters:
initializationType- The type of initialization the SDK used, in case multiple are supported
-
getTrackFlutterPerformance
final Boolean getTrackFlutterPerformance()
-
setTrackFlutterPerformance
final Unit setTrackFlutterPerformance(Boolean trackFlutterPerformance)
- Parameters:
trackFlutterPerformance- Whether Flutter build and raster time tracking is enabled
-
getBatchSize
final Long getBatchSize()
-
getBatchUploadFrequency
final Long getBatchUploadFrequency()
-
getBatchProcessingLevel
final Long getBatchProcessingLevel()
-
getBackgroundTasksEnabled
final Boolean getBackgroundTasksEnabled()
-
getReactVersion
final String getReactVersion()
-
setReactVersion
final Unit setReactVersion(String reactVersion)
- Parameters:
reactVersion- The version of React used in a ReactNative application
-
getReactNativeVersion
final String getReactNativeVersion()
-
setReactNativeVersion
final Unit setReactNativeVersion(String reactNativeVersion)
- Parameters:
reactNativeVersion- The version of ReactNative used in a ReactNative application
-
getDartVersion
final String getDartVersion()
-
setDartVersion
final Unit setDartVersion(String dartVersion)
- Parameters:
dartVersion- The version of Dart used in a Flutter application
-
getUnityVersion
final String getUnityVersion()
-
setUnityVersion
final Unit setUnityVersion(String unityVersion)
- Parameters:
unityVersion- The version of Unity used in a Unity application
-
getAppHangThreshold
final Long getAppHangThreshold()
-
getUsePciIntake
final Boolean getUsePciIntake()
-
setUsePciIntake
final Unit setUsePciIntake(Boolean usePciIntake)
- Parameters:
usePciIntake- Whether logs are sent to the PCI-compliant intake
-
getTracerApi
final String getTracerApi()
-
setTracerApi
final Unit setTracerApi(String tracerApi)
- Parameters:
tracerApi- The tracer API used by the SDK.
-
getTracerApiVersion
final String getTracerApiVersion()
-
setTracerApiVersion
final Unit setTracerApiVersion(String tracerApiVersion)
- Parameters:
tracerApiVersion- The version of the tracer API used by the SDK.
-
getSendLogsAfterSessionExpiration
final Boolean getSendLogsAfterSessionExpiration()
-
setSendLogsAfterSessionExpiration
final Unit setSendLogsAfterSessionExpiration(Boolean sendLogsAfterSessionExpiration)
- Parameters:
sendLogsAfterSessionExpiration- Whether logs are sent after the session expiration
-
getPlugins
final List<TelemetryConfigurationEvent.Plugin> getPlugins()
-
getIsMainProcess
final Boolean getIsMainProcess()
-
getCollectFeatureFlagsOn
final List<TelemetryConfigurationEvent.CollectFeatureFlagsOn> getCollectFeatureFlagsOn()
-
toJson
final JsonElement toJson()
-
-
-
-