Skip to content

Conversation

BenoitZugmeyer
Copy link
Member

@BenoitZugmeyer BenoitZugmeyer commented Sep 18, 2025

Motivation

Adjust RUM and Logs Public API and init params categories to make things more discoverable.

This is in preparation for DataDog/documentation#31777

Changes

New hierarchy:

@datadog/browser-logs
  • API
    • Init
      • getInitConfiguration
      • init
    • Privacy
      • setTrackingConsent
    • Context - Account
      • clearAccount
      • getAccount
      • removeAccountProperty
      • setAccount
      • setAccountProperty
    • Context - Global Context
      • clearGlobalContext
      • getGlobalContext
      • removeGlobalContextProperty
      • setGlobalContext
      • setGlobalContextProperty
    • Context - User
      • clearUser
      • getUser
      • removeUserProperty
      • setUserProperty
      • setUser
    • Logger
      • createLogger
      • getLogger
      • logger
    • Other
      • onReady
      • version
  • Configuration
    • Authentication
      • clientToken
    • Privacy
      • trackingConsent
      • usePciIntake
    • Data Collection
      • beforeSend
      • env
      • forwardConsoleLogs
      • forwardErrorsToLogs
      • forwardReports
      • service
      • sessionSampleRate
      • telemetrySampleRate
      • trackAnonymousUser
      • version
    • Session Persistence
      • allowFallbackToLocalStorage
      • sessionPersistence
      • trackSessionAcrossSubdomains
      • usePartitionedCrossSiteSessionCookie
      • useSecureSessionCookie
    • Transport
      • proxy
      • site
    • Other
      • allowedTrackingOrigins
      • allowUntrustedEvents
      • silentMultipleInit
      • storeContextsAcrossPages
@datadog/browser-rum
  • API
    • Init
      • getInitConfiguration
      • init
    • Privacy
      • setTrackingConsent
    • Data Collection
      • addAction
      • addError
      • addFeatureFlagEvaluation
      • addTiming
      • startView
    • Session Replay
      • getSessionReplayLink
      • startSessionReplayRecording
      • stopSessionReplayRecording
    • Context - Account
      • clearAccount
      • getAccount
      • removeAccountProperty
      • setAccount
      • setAccountProperty
    • Context - Global Context
      • getGlobalContext
      • removeGlobalContextProperty
      • setGlobalContext
      • setGlobalContextProperty
      • clearGlobalContext
    • Context - User
      • clearUser
      • getUser
      • removeUserProperty
      • setUserProperty
      • setUser
    • Context - View
      • setViewContext
      • setViewContextProperty
      • setViewName
      • getViewContext
    • Session
      • stopSession
    • Vital - Duration
      • addDurationVital
      • startDurationVital
      • stopDurationVital
    • Vital - Feature Operation
      • failFeatureOperation
      • startFeatureOperation
      • succeedFeatureOperation
    • Other
      • onReady
      • version
  • Configuration
    • Authentication
      • applicationId
      • clientToken
    • Privacy
      • defaultPrivacyLevel
      • enablePrivacyForActionName
      • trackingConsent
    • Data Collection
      • actionNameAttribute
      • allowedGraphQlUrls
      • beforeSend
      • env
      • service
      • sessionSampleRate
      • telemetrySampleRate
      • trackAnonymousUser
      • trackBfcacheViews
      • trackFeatureFlagsForEvents
      • trackLongTasks
      • trackResources
      • trackUserInteractions
      • trackViewsManually
      • version
    • Session Replay
      • sessionReplaySampleRate
      • startSessionReplayRecordingManually
    • Tracing
      • allowedTracingUrls
      • propagateTraceBaggage
      • traceContextInjection
      • traceSampleRate
    • Profiling
      • profilingSampleRate
    • Session Persistence
      • allowFallbackToLocalStorage
      • sessionPersistence
      • trackSessionAcrossSubdomains
      • usePartitionedCrossSiteSessionCookie
      • useSecureSessionCookie
    • Transport
      • compressIntakeRequests
      • proxy
      • site
      • workerUrl
    • Other
      • allowedTrackingOrigins
      • allowUntrustedEvents
      • excludedActivityUrls
      • plugins
      • silentMultipleInit
      • storeContextsAcrossPages
      • subdomain

Test instructions

Checklist

  • Tested locally
  • Tested on staging
  • Added unit tests for this change.
  • Added e2e/integration tests for this change.

@BenoitZugmeyer BenoitZugmeyer requested a review from a team as a code owner September 18, 2025 15:30
@BenoitZugmeyer BenoitZugmeyer force-pushed the benoit/push-qxrvlsqmllvq branch from 6363832 to 7409f06 Compare September 18, 2025 16:11
@datadog-datadog-prod-us1
Copy link

✅ Tests

🎉 All green!

❄️ No new flaky tests detected
🧪 All tests passed

🎯 Code Coverage
Patch Coverage: 100.00%
Total Coverage: 92.50% (+0.02%)

View detailed report

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 7409f06 | Docs | Was this helpful? Give us feedback!

* The percentage of users profiled. A value between 0 and 100.
*
* @category Profiling
* @experimental Not ready for production.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: I removed this because somehow it is displayed in the category title and screws the ordering? Anyway, I guess it is ready for production.

@BenoitZugmeyer BenoitZugmeyer merged commit 740f39f into main Sep 23, 2025
20 checks passed
@BenoitZugmeyer BenoitZugmeyer deleted the benoit/push-qxrvlsqmllvq branch September 23, 2025 10:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants