diff --git a/docs/platforms/javascript/common/configuration/options.mdx b/docs/platforms/javascript/common/configuration/options.mdx index 00747954306fd..f3522b68359a1 100644 --- a/docs/platforms/javascript/common/configuration/options.mdx +++ b/docs/platforms/javascript/common/configuration/options.mdx @@ -805,13 +805,6 @@ This function is called with a log object, and can return a modified log object, are set. - - -Set this option to `false` to disable metric capturing in Sentry (enabled by default). -Only when this option is enabled will the `metrics` APIs actually send metrics to Sentry. - - - This function is called with a metric object, and can return a modified metric object, or `null` to skip sending this metric to Sentry. diff --git a/platform-includes/metrics/options/javascript.mdx b/platform-includes/metrics/options/javascript.mdx index 08c7a4247bed3..2f34ab3ee2b8a 100644 --- a/platform-includes/metrics/options/javascript.mdx +++ b/platform-includes/metrics/options/javascript.mdx @@ -37,7 +37,12 @@ Sentry.init({ ### Disable Metrics -Set `enableMetrics: false` to disable metrics collection entirely. +Metrics are only captured when you call `Sentry.metrics.*`, so there is no option to turn them on or off. To stop sending metrics without removing those calls, return `null` from `beforeSendMetric`. + + + On SDK versions below `11.0.0`, set `enableMetrics: false` in your + `Sentry.init` to disable metrics instead. + ### Flush Metrics @@ -47,10 +52,10 @@ Metrics are buffered and sent periodically. Use this snippet to flush immediatel ```javascript -// Disable metrics +// Drop all metrics Sentry.init({ dsn: "___PUBLIC_DSN___", - enableMetrics: false, + beforeSendMetric: () => null, }); // Flush all pending metrics diff --git a/platform-includes/metrics/requirements/javascript.mdx b/platform-includes/metrics/requirements/javascript.mdx index a7404ef7f43db..f15b9be3c6c56 100644 --- a/platform-includes/metrics/requirements/javascript.mdx +++ b/platform-includes/metrics/requirements/javascript.mdx @@ -1,3 +1,9 @@ Metrics are supported in all Sentry JavaScript SDKs version `10.25.0` and above. Make sure you have the SDK set up before proceeding. + + + +Metrics are also supported via [CDN bundles and the Loader Script](/platforms/javascript/install/loader/). Use a bundle that includes metrics, such as `bundle.logs.metrics.min.js`. On other bundles, `Sentry.metrics.*` calls are a no-op that only warns when `debug` is enabled. + + diff --git a/platform-includes/metrics/usage/javascript.mdx b/platform-includes/metrics/usage/javascript.mdx index 2743757f8af70..a70fa09f78a87 100644 --- a/platform-includes/metrics/usage/javascript.mdx +++ b/platform-includes/metrics/usage/javascript.mdx @@ -10,7 +10,7 @@ | `gauge` | Current values (queue depth, connections) | | `distribution` | Value ranges (response times, payload sizes) | -No setup required beyond SDK initialization. +No setup required beyond SDK initialization. Metrics are captured whenever you call `Sentry.metrics.*`.