open-telemetry / semantic-conventions

Defines standards for generating consistent, accessible telemetry across a variety of domains
Apache License 2.0
231 stars 146 forks source link

Guidance on product/project name inside attribute/metric name #608

Open lmolkova opened 7 months ago

lmolkova commented 7 months ago

We should provide a guidance on product/project name being fully qualified (or not). We should keep the same pattern in different semconvs. Examples of inconsistencies:

We should provide a guidance on how to represent multiple words:

We should require consistency across signals:

Misc discrepancies:

[Update] Other attributes that have the same problem:

alanwest commented 5 months ago

With regards to representing multiple words, can a product's branding provide a guide? For example, use dynamodb, couchdb, and cosmos_db because they are respectively branded DynamoDB, CouchDB, and Cosmos DB.

trask commented 5 months ago

It would be nice if whatever the enum is, e.g. cosmosdb, that is also the namespace, e.g. db.cosmosdb.*, for product-specific attributes

trask commented 5 months ago

do we think we need mssqlcompact? that doesn't seem like something we'd necessarily know from the client side, and on the server side it could potentially be a resource attribute describing the "edition"

KalleOlaviNiemitalo commented 5 months ago

SQL Server Compact runs in-process rather than as a network service, so yes, the application should know it's using that. It's no longer supported by Microsoft, but https://github.com/open-telemetry/opentelemetry-specification/pull/3105 shows it's still used.

lmolkova commented 1 month ago

Based on the messaging SIG discussion on 6/13, none of the controversial systems are part of the initial stability (kafka + RabbitMQ), so removing the stability blocker label.