feat(core): Add scope attribute APIs #18165
Merged
+695
−9
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Lms24
commented
Nov 11, 2025
Member
Author
There was a problem hiding this comment.
In contrast to logs and metrics attribute definitions and helper functions, this one already handles array attributes as well as attributes with units. My thinking is, we introduce this here then unify logs, metrics (+ spans eventually) to use the types and APIs here. While we'll have to change the used types for logs and metrics, I don't think this is breaking as theoretically logs and metrics support unknown for attribute values.
Lms24
force-pushed
the
lms/feat-core-scope-setAttributes
branch
from
3209923 to
c94bcd6
Compare
Contributor
size-limit report 📦
|
Contributor
node-overhead report 🧳Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.
|
Lms24
changed the title
Scope::setAttribute(s) APIs![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
logaretm
reviewed
Nov 14, 2025
logaretm
reviewed
Nov 14, 2025
logaretm
approved these changes
Nov 17, 2025
AbhiPrasad
reviewed
Nov 17, 2025
Lms24
force-pushed
the
lms/feat-core-scope-setAttributes
branch
2 times, most recently
from
a3e204d to
205752c
Compare
Member
Author
|
Converting to draft because we learned yesterday that Relay doesn't yet support array attributes. So either we wait for support in Relay or we strip out the Array-related code. Units seem to get passed through but are not yet shown in the UI. |
Lms24
force-pushed
the
lms/feat-core-scope-setAttributes
branch
from
205752c to
fbbd768
Compare
Member
Author
|
So for now, we decided to just ship this, despite Relay still filtering out array values. Units are accepted but not shown in the UI. Which is fine. We're just future-proofing at this point. |
chargome
approved these changes
Nov 20, 2025
…ype (#18201) Uses a conditional type to infer whether an attribute object has the type of an official attribute by checking if it has a `value` or a `unit`: ```ts export type ValidatedAttributes<T> = { [K in keyof T]: T[K] extends { value: any } | { unit: any } ? ValidAttributeObject : unknown; }; ``` That way, TS can show an error when people attempt to use the attribute type while still allowing non-official types. <img width="673" height="250" alt="image" src="https://github.com/user-attachments/assets/f635f46d-6c3f-49cb-b31f-a02a6ebf91d3" /> --- I also added a small helper type to generate the very long attribute type object, so it can generate a type like this: ```ts /* | { value: string; type: 'string' } | { value: number; type: 'integer' } | { value: number; type: 'double' } */ ```
Lms24
force-pushed
the
lms/feat-core-scope-setAttributes
branch
from
fbbd768 to
04d75b1
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds
scope.setAttribute,scope.setAttributesandscope.removeAttributemethods, as specified in our develop docs.This intial PR only enables setting the attributes (including attributes with units) as well as the usual scope data operations (clone(), update(), clear(), getSpanData()). These attributes are not yet applied to any of the telemetry we eventually want them to apply to. I'll take care of this in a follow-up PR.
closes #18140
ref https://linear.app/getsentry/project/implement-global-attributes-api-javascript-02c3c74184fc/issues