Skip to content

feat(js): Document scope attributes on metrics #15934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Lms24 merged 1 commit into from
Jan 14, 2026
+18 −0
Merged

feat(js): Document scope attributes on metrics #15934

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions platform-includes/metrics/usage/javascript.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,24 @@ Sentry.metrics.count(
);
```

With version `10.33.0` and above, you can use scope APIs to set attributes on the SDK's scopes which will be applied to all metrics as long as the respective scopes are active. For the time being, only `string`, `number` and `boolean` attribute values are supported.


```js
Sentry.getGlobalScope().setAttributes({ is_admin: true, auth_provider: 'google' });

Sentry.withScope(scope => {
scope.setAttribute('step', 'authentication');

// scope attributes `is_admin`, `auth_provider` and `step` are added
Sentry.metrics.count('clicks', 1, { attributes: { activeSince: 100 } });
Sentry.metrics.gauge('time_since_refresh', 4, { unit: 'hour' });
});

// scope attributes `is_admin` and `auth_provider` are added
Sentry.metrics.distribution('response_time', 283.33, { unit: 'millisecond' });
```

### Specifying Units

For `gauge` and `distribution` metrics, you can specify a unit using the `unit` option. This helps Sentry display the metric value in a human-readable format.
Expand Down
Loading