Skip to content
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.

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

Adding a few browser related attribute conventions #559

Closed
wants to merge 2 commits into from

Conversation

scheler
Copy link
Contributor

@scheler scheler commented Nov 23, 2023

Introducing a few attribute conventions under browser namespace.

Changes

  • Introducing browser.page.url, browser.page.instance.id and browser.instance.id

Note: if the PR is touching an area that is not listed in the existing areas, or the area does not have sufficient domain experts coverage, the PR might be tagged as experts needed and move slowly until experts are identified.

Merge requirement checklist

@@ -54,3 +54,19 @@ groups:
to retrieve brands and platform individually from the User-Agent Client Hints API.
To retrieve the value, the legacy `navigator.userAgent` API can be used.
examples: ['Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.54 Safari/537.36']
- id: page.url
Copy link
Member

@AlexanderWert AlexanderWert Nov 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is page.* really an attribute of the resource browser? Shouldn't that be rather a signal-level attribute?

In particular: if a user navigates to a different page would that also imply that there's a new instance of the OTel SDK in the browser? If not, the page.* must not be a resource attribute, because resource attributes must not change during the lifetime of a resource / SDK instance.

Apart from the above, can we use browser.page.url.full instead? To be consistent with the url.* namespace. Once we have a solution for #339, we will be able to simply replace it with a reuse of the url.full attribute under the browser.page.* namespace

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AlexanderWert yes, in my intended usage of these attributes they are not at the resource level - I added them here so that all attributes under browser namespace are at one place. I realize this one place is in registry, which didn't exist when this namespace was introduced. I can create the registry entry for browser now, but have one question - these attribute are intended to be added by sdk level processors into both spans and events. Do you want me to create both model/trace/browser.yaml and model/logs/browser.yaml, duplicated?

cc: @martinkuba

Copy link
Contributor

@trisch-me trisch-me Dec 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@scheler FYI I have opened a PR with browser moved to the registry. I would like in the future to change your PR to add new attributes to the registry directly

@AlexanderWert
Copy link
Member

@scheler Unfortunately, this is currently blocked by that build-tools issue: open-telemetry/build-tools#242 (We are working on resolving it).

Copy link

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Jan 25, 2024
Copy link

github-actions bot commented Feb 2, 2024

Closed as inactive. Feel free to reopen if this PR is still being worked on.

@github-actions github-actions bot closed this Feb 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants