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.

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

Jump to bottom

Add service.pool.name #1404

Open
verdie-g opened this issue Sep 13, 2024 · 2 comments · May be fixed by #1915
Open

Add service.pool.name #1404

verdie-g opened this issue Sep 13, 2024 · 2 comments · May be fixed by #1915
Assignees
@reyang
Labels
area:service enhancement New feature or request experts needed This issue or pull request is outside an area where general approvers feel they can approve triage:needs-triage

Comments

@verdie-g
Copy link

verdie-g commented Sep 13, 2024 •
edited
Loading

Area(s)

area:service

Is your change request related to a problem? Please describe.

Instances of a service can be grouped into pools. For example, a service could be split into two pools: canary and default. Canary being a small pool that is deployed before default to check that everything is working as expected. Some pools can also be test pools of one or two instances to test a change in production.

The metrics can be aggregated by pool to easily compare the canary and default pools but currently there is no standard labels for that concept.

Describe the solution you'd like

A new label service.pool.name which designates the pool the instance is part of. The value would depend on the company but some recommended values would be:

  • default
  • canary
  • test-1
  • test-2

Describe alternatives you've considered

  • service.pool if we are sure a pool cannot have other fields (e.g. an id)
  • service.instance.pool
  • deployment.pool

Additional context

No response
@verdie-g verdie-g added enhancement New feature or request experts needed This issue or pull request is outside an area where general approvers feel they can approve triage:needs-triage labels Sep 13, 2024
@verdie-g verdie-g linked a pull request Feb 17, 2025 that will close this issue
Draft
3 tasks
@jsuereth
Copy link
Contributor

At a minimum I think this should be "service.pool.name".

I think you're modeling the notion of a pool of instances, so it'd be better to label the name of the pool.

@verdie-g verdie-g changed the title Add service.instance.pool Add service.pool.name Feb 18, 2025
@verdie-g
Copy link
Author

At a minimum I think this should be "service.pool.name".

I think you're modeling the notion of a pool of instances, so it'd be better to label the name of the pool.

Updated!

The service resource is treated specially in open telemetry, allowing interaction with environment variables. What the intention for how to fil out an instance pool name?

According to General SDK Configuration, it appears that only service.name has its dedicated env variable OTEL_SERVICE_NAME. For this new attribute, it would be appended to OTEL_RESOURCE_ATTRIBUTES. For example OTEL_RESOURCE_ATTRIBUTES=service.pool.name=main.

If we're talking about what to fill the value with, first it's fine to keep it empty. As mentioned in the PR, in cloud providers you can use the value of Auto Scaling groups (AWS), Virtual Machine Scale Sets (Azure), instance groups (GCP).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@reyang reyang

Labels
area:service enhancement New feature or request experts needed This issue or pull request is outside an area where general approvers feel they can approve triage:needs-triage
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add service.instance.pool verdie-g/semantic-conventions-fork
3 participants
@jsuereth @verdie-g @reyang