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

Add system-specific naming guidance #1708

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lmolkova
Copy link
Contributor

Fixes #1494

Related:

Documents:

  • Systems-specific attribute names follow {optional domain}.{system} pattern
  • Systems-specific metric names follow {domain}.client|server.{system} or {system}.client|server pattern
  • Metrics for network operations should include some indication if they are client or server

Merge requirement checklist

@lmolkova lmolkova requested review from a team as code owners December 21, 2024 00:53
the system name should be included in the instrument name using the pattern:
`{domain}.{client|server}.{system}.*.{property}` pattern.

For example, `db.client.cosmosdb.operation.request_charge`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

the difference with signalr.server.connection.duration below makes me think if we should simplify it and do cosmosdb.client.operation.request_charge. What's the benefit of having db in front of it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

summoning @open-telemetry/semconv-system-approvers

It's the same question as for system.linux vs linux metrics in #1403 or #1618


Examples:

- `db.cassandra.consistency_level` - Describes the consistency level property
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Similar to https://github.com/open-telemetry/semantic-conventions/pull/1708/files#r1894523030

what's the benefit of having db in front of cassandra here? why not cassandra.consistency_level?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let's say we have some redis-specific attributes (and redis can be used as a DB and as a messaging system), would we define db.redis and messaging.redis ? probably not, it should be just redis.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

Document *.client.{system}.* ordering in the metric naming
1 participant