Skip to content

ref(develop/scopes): Clarify unit type for attributes #15546

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
merged 4 commits into from
Nov 19, 2025
Merged

ref(develop/scopes): Clarify unit type for attributes #15546

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ed7fa9f
ref(develop/scopes): Clarify unit type for attributes
Lms24 Nov 18, 2025
3ad6d5f
clarify custom unit
Lms24 Nov 18, 2025
f665f83
shorten
Lms24 Nov 18, 2025
1444f27
Update develop-docs/sdk/telemetry/scopes.mdx
Lms24 Nov 18, 2025
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
4 changes: 3 additions & 1 deletion develop-docs/sdk/telemetry/scopes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,9 @@ Users MUST be able to attach attributes to any scope using a dedicated method (e
Attributes are key-value pairs where each value is either a an attribute value or an object containing:

- `value`: The actual attribute value, which MUST match the specified type
- `unit` (optional): The unit of measurement (e.g., `"ms"`, `"s"`, `"bytes"`, `"count"`, `"percent"` or any other string value). SDKs MAY NOT add support for units for the moment, but MUST be able to do so at a later date without a breaking change.
- `unit` (optional): The unit of measurement (e.g., `"millisecond"`, `"second"`, `"byte"`, `"ratio"`).
- SDKs MAY delay adding support for units for the moment, but MUST be able to do so at a later date without a breaking change.
- SDKS MUST allow setting all units supported by Relay's [`MetricUnit` enum](https://getsentry.github.io/relay/relay_metrics/enum.MetricUnit.html) but MUST NOT allow custom units (i.e. arbitrary strings, defined in [`CustomUnit`](https://getsentry.github.io/relay/relay_metrics/struct.CustomUnit.html)) or "none" units (`''` or `'none'`).
- `type` (optional): The type of the attribute. SDKs SHOULD NOT expose this to users if they can reliably infer the type from the value. If not, SDKs MAY allow or require users to set the `type` explicitly.

#### Example Usage
Expand Down
Loading