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

Alignment with gRPC conventions #1773

Open
mx-psi opened this issue Jan 20, 2025 · 2 comments
Open

Alignment with gRPC conventions #1773

mx-psi opened this issue Jan 20, 2025 · 2 comments
Labels
area:rpc enhancement New feature or request experts needed This issue or pull request is outside an area where general approvers feel they can approve

Comments

@mx-psi
Copy link
Member

mx-psi commented Jan 20, 2025

Area(s)

area:rpc

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

The gRPC project has designed its own set of metrics and attributes. There is some overlap with existing gRPC attributes (compare our attributes with gRPC attributes). Users get frustrated since we are not consistent with each other, e.g. see open-telemetry/opentelemetry-go-contrib/issues/6093.

Describe the solution you'd like

Adopt gRPC conventions as the 'official' conventions for modelling gRPC. Consider contributing upstream anything that is missing.

Describe alternatives you've considered

Some other sort of collaboration with gRPC that leads to alignment

Additional context

No response

@pellared
Copy link
Member

CC @dfawley @aranjans

@lmolkova
Copy link
Contributor

thanks for raising it!

This is a perfect use-case for multi-registry. If we supported it, the grpc metrics could be defined and owned by grpc community and OTel could reference them.

As of recently, we don't recommend hosting external conventions in this repo

- Instrumentations that follow external schema not fully compatible with OpenTelemetry such as
[Kafka client JMX metrics](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/v2.10.0/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/README.md)
or [RabbitMQ Collector Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.116.0/receiver/rabbitmqreceiver)
SHOULD document such conventions in their own repository.

and I think grpc ones fall into this bucket - they don't extend otel conventions and, even though they look great, they are not consistent with how we'd define them. E.g. we use server.address|port and other network attributes and grpc ones only use grpc.target which looks like the biggest and a major inconsistency to me.

We don't have anyone actively working on grpc semantic conventions at the moment, but this issue should definitely be a blocker for grpc stabilization and we'll need to decide what to do here. We should figure out how to have one set of conventions.

@lmolkova lmolkova moved this from Need triage to Backlog in DRAFT - SemConv Issue Triage Jan 22, 2025
@lmolkova lmolkova added experts needed This issue or pull request is outside an area where general approvers feel they can approve and removed triage:needs-triage labels Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:rpc enhancement New feature or request experts needed This issue or pull request is outside an area where general approvers feel they can approve
Projects
Development

No branches or pull requests

3 participants