Installation

The SDK is currently distributed as an NPM package. We are considering adding more distribution formats in the future. Should you need a currently unavailable format, let us know by creating a GitHub issue or via support@dash0.com.

Before you begin

You'll need the following before you can start with the Dash0 Web SDK:

• An active Dash0 account. Sign Up
• An Auth Token; auth tokens for client monitoring will be public as part of your website, please make sure to:
  • Use a separate token, exclusively for website monitoring; if you want to monitor multiple websites, it is best to use a dedicated token for each
  • Limit the dataset permissions on the auth token to the dataset you want to ingest Website Monitoring data with
  • Limit permissions on the auth token to IngestingCopy
• The Endpoint url for your dash0 region. You can find it via Organization Settings > Endpoints > OTLP via HTTPCopy.

Documentation

Once you have the prerequisites above, follow these guides:

• Setup — add the SDK via modules or script tags and initialize it, including Content Security Policy configuration.
• Configuration — all initCopy options: backend correlation and propagators, configuration auto-detection (Vercel, VCS context), website attributes, telemetry transmission, session tracking, error tracking, HTTP request and page-view instrumentation.
• API — runtime API functions: addSignalAttributeCopy, removeSignalAttributeCopy, identifyCopy, sendEventCopy, reportErrorCopy, terminateSessionCopy, and setActiveLogLevelCopy.