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

Advice/hint APIs should be applied to all signals (when applicable) #3557

Open
lmolkova opened this issue Jun 16, 2023 · 1 comment
Open
Labels
area:api Cross language API specification issue area:configuration Related to configuring the SDK spec:metrics Related to the specification/metrics directory spec:trace Related to the specification/trace directory triage:deciding:community-feedback Open to community discussion. If the community can provide sufficient reasoning, it may be accepted

Comments

@lmolkova
Copy link
Contributor

lmolkova commented Jun 16, 2023

From #3546 (comment)

What are you trying to achieve?

Some advice/hint API we have/considering adding on metrics could be as well applied to traces.

Examples:

When designing metric-only APIs, we can end up with:

  • inconsistent telemetry on signals and limited attribute-based correlation
  • inconsistent advice/hint APIs across signals and subpar dev experience configuring SDK

Additional context.

The suggestion is to tie advice/hint API with configuration efforts and ensure consistent in-code and no-code configuration across signals.

@lmolkova lmolkova added the spec:trace Related to the specification/trace directory label Jun 16, 2023
@lmolkova lmolkova added spec:metrics Related to the specification/metrics directory area:configuration Related to configuring the SDK labels Jun 16, 2023
@lmolkova lmolkova changed the title Advice/hint APIs should be cross-signals (when applicable) Advice/hint APIs should be applied to all signals (when applicable) Jun 16, 2023
@mateuszrzeszutek
Copy link
Member

I think that this is a great idea that's definitely worth pursuing -- I think the general advice API would make a great tool for opting in or out from collecting attributes (the server.* case I mentioned in #3546, server.socket.* attributes on HTTP server spans, url.query if it contains sensitive info, etc) + all the use cases mentioned above.

The advice API on its own does not achieve much though: it only works so well in metrics because we have the views API that users can utilize to override the instrumentation authors' recommendations. If we were to add advice API for spans/logs we would probably have to introduce some sort of views API for them as well (together with selectors for instrumentation scope).

@arminru arminru added the area:api Cross language API specification issue label Jun 20, 2023
@carlosalberto carlosalberto added the priority:p2 Medium priority level label Jun 26, 2023
@austinlparker austinlparker added the triage:deciding:community-feedback Open to community discussion. If the community can provide sufficient reasoning, it may be accepted label May 14, 2024
@austinlparker austinlparker removed the priority:p2 Medium priority level label May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:api Cross language API specification issue area:configuration Related to configuring the SDK spec:metrics Related to the specification/metrics directory spec:trace Related to the specification/trace directory triage:deciding:community-feedback Open to community discussion. If the community can provide sufficient reasoning, it may be accepted
Projects
None yet
Development

No branches or pull requests

5 participants