diff --git a/docs/README.md b/docs/README.md index 84757e51ea..c210860176 100644 --- a/docs/README.md +++ b/docs/README.md @@ -19,32 +19,32 @@ The benefit to using Semantic Conventions is in following a common naming scheme Semantic Conventions are defined for the following areas: -* **[General](general/README.md): General Semantic Conventions**. -* [CICD](cicd/README.md): Semantic Conventions for CICD systems. -* [Cloud Providers](cloud-providers/README.md): Semantic Conventions for cloud providers libraries. -* [CloudEvents](cloudevents/README.md): Semantic Conventions for the CloudEvents specification. -* [Database](database/README.md): Semantic Conventions for database operations. -* [Exceptions](exceptions/README.md): Semantic Conventions for exceptions. -* [FaaS](faas/README.md): Semantic Conventions for Function as a Service (FaaS) operations. -* [Feature Flags](feature-flags/README.md): Semantic Conventions for feature flag evaluations. -* [Generative AI](gen-ai/README.md): Semantic Conventions for generative AI (LLM, etc.) operations. -* [GraphQL](graphql/README.md): Semantic Conventions for GraphQL implementations. -* [HTTP](http/README.md): Semantic Conventions for HTTP client and server operations. -* [Messaging](messaging/README.md): Semantic Conventions for messaging operations and systems. -* [Object Stores](object-stores/README.md): Semantic Conventions for object stores operations. -* [RPC](rpc/README.md): Semantic Conventions for RPC client and server operations. -* [System](system/README.md): System Semantic Conventions. +- **[General](general/README.md): General Semantic Conventions**. +- [CICD](cicd/README.md): Semantic Conventions for CICD systems. +- [Cloud Providers](cloud-providers/README.md): Semantic Conventions for cloud providers libraries. +- [CloudEvents](cloudevents/README.md): Semantic Conventions for the CloudEvents specification. +- [Database](database/README.md): Semantic Conventions for database operations. +- [Exceptions](exceptions/README.md): Semantic Conventions for exceptions. +- [FaaS](faas/README.md): Semantic Conventions for Function as a Service (FaaS) operations. +- [Feature Flags](feature-flags/README.md): Semantic Conventions for feature flag evaluations. +- [Generative AI](gen-ai/README.md): Semantic Conventions for generative AI (LLM, etc.) operations. +- [GraphQL](graphql/README.md): Semantic Conventions for GraphQL implementations. +- [HTTP](http/README.md): Semantic Conventions for HTTP client and server operations. +- [Messaging](messaging/README.md): Semantic Conventions for messaging operations and systems. +- [Object Stores](object-stores/README.md): Semantic Conventions for object stores operations. +- [RPC](rpc/README.md): Semantic Conventions for RPC client and server operations. +- [System](system/README.md): System Semantic Conventions. Semantic Conventions by signals: -* [Events](general/events.md): Semantic Conventions for event data. -* [Logs](general/logs.md): Semantic Conventions for logs data. -* [Metrics](general/metrics.md): Semantic Conventions for metrics. -* [Profiles](general/profiles.md): Semantic Conventions for profiles. -* [Resource](resource/README.md): Semantic Conventions for resources. -* [Trace](general/trace.md): Semantic Conventions for traces and spans. +- [Events](general/events.md): Semantic Conventions for event data. +- [Logs](general/logs.md): Semantic Conventions for logs data. +- [Metrics](general/metrics.md): Semantic Conventions for metrics. +- [Profiles](general/profiles.md): Semantic Conventions for profiles. +- [Resource](resource/README.md): Semantic Conventions for resources. +- [Trace](general/trace.md): Semantic Conventions for traces and spans. Also see: -* [How to write semantic conventions](how-to-write-conventions/README.md) -* [Non-normative supplementary information](non-normative/README.md) +- [How to write semantic conventions](how-to-write-conventions/README.md) +- [Non-normative supplementary information](non-normative/README.md) diff --git a/docs/app/README.md b/docs/app/README.md index 678f84f64a..e1e249e91b 100644 --- a/docs/app/README.md +++ b/docs/app/README.md @@ -8,6 +8,6 @@ linkTitle: App Semantic conventions for Apps are defined for the following signals: -* [App Events](app-events.md) +- [App Events](app-events.md) [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/azure/README.md b/docs/azure/README.md index 0e54f5106d..a28273cc35 100644 --- a/docs/azure/README.md +++ b/docs/azure/README.md @@ -10,7 +10,7 @@ This document describes Azure Resource Logs, see [Azure Resource Log Top-level S Semantic conventions are defined for the following signals: -* [Events](azure-events.md) +- [Events](azure-events.md) [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status [AzureResourceSchema]: https://learn.microsoft.com/azure/azure-monitor/essentials/resource-logs-schema#top-level-common-schema diff --git a/docs/browser/README.md b/docs/browser/README.md index 9a5470234e..78d8733163 100644 --- a/docs/browser/README.md +++ b/docs/browser/README.md @@ -10,6 +10,6 @@ This document defines semantic conventions for Browser. Semantic conventions are defined for the following signals: -* [Events](browser-events.md) +- [Events](browser-events.md) [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/cicd/README.md b/docs/cicd/README.md index 618f51a8dc..83b4ddf77a 100644 --- a/docs/cicd/README.md +++ b/docs/cicd/README.md @@ -10,8 +10,8 @@ This document defines semantic conventions for Continuous Integration and Contin Semantic conventions for CICD are defined for the following signals: -* [CICD Spans](cicd-spans.md): Semantic Conventions for CICD *spans*. -* [CICD Metrics](cicd-metrics.md): Semantic Conventions for CICD *metrics*. -* [CICD Logs](cicd-logs.md): Semantic Conventions for CICD *logs*. +- [CICD Spans](cicd-spans.md): Semantic Conventions for CICD *spans*. +- [CICD Metrics](cicd-metrics.md): Semantic Conventions for CICD *metrics*. +- [CICD Logs](cicd-logs.md): Semantic Conventions for CICD *logs*. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/cicd/cicd-metrics.md b/docs/cicd/cicd-metrics.md index 851ea37b2a..9d0c03f694 100644 --- a/docs/cicd/cicd-metrics.md +++ b/docs/cicd/cicd-metrics.md @@ -41,9 +41,9 @@ but more may be added in the future. It might be useful to gather metrics specific to each pipeline run.
Examples of such metrics include: -* host metrics like cpu, memory, disk of the worker on which a pipeline run executes -* container metrics like cpu, memory requests and limits -* runtime metrics of any processes executed as part of the pipeline run like JVM metrics +- host metrics like cpu, memory, disk of the worker on which a pipeline run executes +- container metrics like cpu, memory requests and limits +- runtime metrics of any processes executed as part of the pipeline run like JVM metrics These metrics could be used to correlate build failures with environment issues like overload or out-of-memory. They could also be used in pipeline-level aggregations to inform adjustements of allocated worker resources. diff --git a/docs/cicd/cicd-spans.md b/docs/cicd/cicd-spans.md index 3c494c067c..de6dbcdf18 100644 --- a/docs/cicd/cicd-spans.md +++ b/docs/cicd/cicd-spans.md @@ -159,9 +159,9 @@ it's RECOMMENDED to: The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`cicd.pipeline.task.name`](/docs/registry/attributes/cicd.md) -* [`cicd.pipeline.task.run.id`](/docs/registry/attributes/cicd.md) -* [`cicd.pipeline.task.run.url.full`](/docs/registry/attributes/cicd.md) +- [`cicd.pipeline.task.name`](/docs/registry/attributes/cicd.md) +- [`cicd.pipeline.task.run.id`](/docs/registry/attributes/cicd.md) +- [`cicd.pipeline.task.run.url.full`](/docs/registry/attributes/cicd.md) --- diff --git a/docs/cli/README.md b/docs/cli/README.md index ab5258195d..9d6c410597 100644 --- a/docs/cli/README.md +++ b/docs/cli/README.md @@ -8,6 +8,6 @@ linkTitle: CLI programs Semantic conventions for CLI programs are defined for the following signals: -* [CLI Spans](cli-spans.md) +- [CLI Spans](cli-spans.md) [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/database/README.md b/docs/database/README.md index 4dd6c14d0e..68ff95ee1d 100644 --- a/docs/database/README.md +++ b/docs/database/README.md @@ -15,43 +15,43 @@ database metrics and logs. > [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-spans.md) > (or prior): > -> * SHOULD NOT change the version of the database conventions that they emit by +> - SHOULD NOT change the version of the database conventions that they emit by > default in their existing major version. Conventions include (but are not > limited to) attributes, metric and span names, and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in their existing major version as a comma-separated list of category-specific values > (e.g., http, databases, messaging). The list of values includes: -> * `database` - emit the stable database conventions, and stop emitting +> - `database` - emit the stable database conventions, and stop emitting > the experimental database conventions that the instrumentation emitted > previously. -> * `database/dup` - emit both the experimental and stable database conventions, +> - `database/dup` - emit both the experimental and stable database conventions, > allowing for a phased rollout of the stable semantic conventions. -> * The default behavior (in the absence of one of these values) is to continue +> - The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental database conventions > the instrumentation was emitting previously. -> * Note: `database/dup` has higher precedence than `database` in case both values are present -> * SHOULD maintain (security patching at a minimum) their existing major version +> - Note: `database/dup` has higher precedence than `database` in case both values are present +> - SHOULD maintain (security patching at a minimum) their existing major version > for at least six months after it starts emitting both sets of conventions. -> * MAY drop the environment variable in their next major version and emit only +> - MAY drop the environment variable in their next major version and emit only > the stable database conventions. Semantic conventions for database operations are defined for the following signals: -* [DB Spans](database-spans.md): Semantic Conventions for database client *spans*. -* [DB Metrics](database-metrics.md): Semantic Conventions for database operation *metrics*. +- [DB Spans](database-spans.md): Semantic Conventions for database client *spans*. +- [DB Metrics](database-metrics.md): Semantic Conventions for database operation *metrics*. Technology specific semantic conventions are defined for the following databases: -* [AWS DynamoDB](dynamodb.md): Semantic Conventions for *AWS DynamoDB*. -* [Cassandra](cassandra.md): Semantic Conventions for *Cassandra*. -* [Azure Cosmos DB](cosmosdb.md): Semantic Conventions for *Azure Cosmos DB*. -* [CouchDB](couchdb.md): Semantic Conventions for *CouchDB*. -* [Elasticsearch](elasticsearch.md): Semantic Conventions for *Elasticsearch*. -* [HBase](hbase.md): Semantic Conventions for *HBase*. -* [MongoDB](mongodb.md): Semantic Conventions for *MongoDB*. -* [Microsoft SQL Server](sql-server.md): Semantic Conventions for *Microsoft SQL Server*. -* [Oracle Database](oracledb.md): Semantic Conventions for *Oracle Database*. -* [Redis](redis.md): Semantic Conventions for *Redis*. -* [SQL](sql.md): Semantic Conventions for *SQL* databases. +- [AWS DynamoDB](dynamodb.md): Semantic Conventions for *AWS DynamoDB*. +- [Cassandra](cassandra.md): Semantic Conventions for *Cassandra*. +- [Azure Cosmos DB](cosmosdb.md): Semantic Conventions for *Azure Cosmos DB*. +- [CouchDB](couchdb.md): Semantic Conventions for *CouchDB*. +- [Elasticsearch](elasticsearch.md): Semantic Conventions for *Elasticsearch*. +- [HBase](hbase.md): Semantic Conventions for *HBase*. +- [MongoDB](mongodb.md): Semantic Conventions for *MongoDB*. +- [Microsoft SQL Server](sql-server.md): Semantic Conventions for *Microsoft SQL Server*. +- [Oracle Database](oracledb.md): Semantic Conventions for *Oracle Database*. +- [Redis](redis.md): Semantic Conventions for *Redis*. +- [SQL](sql.md): Semantic Conventions for *SQL* databases. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/database/cassandra.md b/docs/database/cassandra.md index 40490e862b..49be74c519 100644 --- a/docs/database/cassandra.md +++ b/docs/database/cassandra.md @@ -147,13 +147,13 @@ Examples: The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`db.collection.name`](/docs/registry/attributes/db.md) -* [`db.namespace`](/docs/registry/attributes/db.md) -* [`db.operation.name`](/docs/registry/attributes/db.md) -* [`db.query.summary`](/docs/registry/attributes/db.md) -* [`db.query.text`](/docs/registry/attributes/db.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`db.collection.name`](/docs/registry/attributes/db.md) +- [`db.namespace`](/docs/registry/attributes/db.md) +- [`db.operation.name`](/docs/registry/attributes/db.md) +- [`db.query.summary`](/docs/registry/attributes/db.md) +- [`db.query.text`](/docs/registry/attributes/db.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/database/cosmosdb.md b/docs/database/cosmosdb.md index b287e5e3c6..44e96da778 100644 --- a/docs/database/cosmosdb.md +++ b/docs/database/cosmosdb.md @@ -251,11 +251,11 @@ Examples: The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`db.collection.name`](/docs/registry/attributes/db.md) -* [`db.namespace`](/docs/registry/attributes/db.md) -* [`db.operation.name`](/docs/registry/attributes/db.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`db.collection.name`](/docs/registry/attributes/db.md) +- [`db.namespace`](/docs/registry/attributes/db.md) +- [`db.operation.name`](/docs/registry/attributes/db.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/database/couchdb.md b/docs/database/couchdb.md index d33e8209bf..3425370024 100644 --- a/docs/database/couchdb.md +++ b/docs/database/couchdb.md @@ -73,10 +73,10 @@ Instrumentations SHOULD document how `error.type` is populated. The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`db.namespace`](/docs/registry/attributes/db.md) -* [`db.operation.name`](/docs/registry/attributes/db.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`db.namespace`](/docs/registry/attributes/db.md) +- [`db.operation.name`](/docs/registry/attributes/db.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/database/database-metrics.md b/docs/database/database-metrics.md index 3d246691f3..a680e7ee21 100644 --- a/docs/database/database-metrics.md +++ b/docs/database/database-metrics.md @@ -32,24 +32,24 @@ linkTitle: Metrics > [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-spans.md) > (or prior): > -> * SHOULD NOT change the version of the database conventions that they emit by +> - SHOULD NOT change the version of the database conventions that they emit by > default in their existing major version. Conventions include (but are not > limited to) attributes, metric and span names, and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in their existing major version as a comma-separated list of category-specific values > (e.g., http, databases, messaging). The list of values includes: -> * `database` - emit the stable database conventions, and stop emitting +> - `database` - emit the stable database conventions, and stop emitting > the experimental database conventions that the instrumentation emitted > previously. -> * `database/dup` - emit both the experimental and stable database conventions, +> - `database/dup` - emit both the experimental and stable database conventions, > allowing for a phased rollout of the stable semantic conventions. -> * The default behavior (in the absence of one of these values) is to continue +> - The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental database conventions > the instrumentation was emitting previously. -> * Note: `database/dup` has higher precedence than `database` in case both values are present -> * SHOULD maintain (security patching at a minimum) their existing major version +> - Note: `database/dup` has higher precedence than `database` in case both values are present +> - SHOULD maintain (security patching at a minimum) their existing major version > for at least six months after it starts emitting both sets of conventions. -> * MAY drop the environment variable in their next major version and emit only +> - MAY drop the environment variable in their next major version and emit only > the stable database conventions. ## Database operation diff --git a/docs/database/database-spans.md b/docs/database/database-spans.md index 4bdb22f8ca..368510250a 100644 --- a/docs/database/database-spans.md +++ b/docs/database/database-spans.md @@ -25,24 +25,24 @@ linkTitle: Spans > [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-spans.md) > (or prior): > -> * SHOULD NOT change the version of the database conventions that they emit by +> - SHOULD NOT change the version of the database conventions that they emit by > default in their existing major version. Conventions include (but are not > limited to) attributes, metric and span names, and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in their existing major version as a comma-separated list of category-specific values > (e.g., http, databases, messaging). The list of values includes: -> * `database` - emit the stable database conventions, and stop emitting +> - `database` - emit the stable database conventions, and stop emitting > the experimental database conventions that the instrumentation emitted > previously. -> * `database/dup` - emit both the experimental and stable database conventions, +> - `database/dup` - emit both the experimental and stable database conventions, > allowing for a phased rollout of the stable semantic conventions. -> * The default behavior (in the absence of one of these values) is to continue +> - The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental database conventions > the instrumentation was emitting previously. -> * Note: `database/dup` has higher precedence than `database` in case both values are present -> * SHOULD maintain (security patching at a minimum) their existing major version +> - Note: `database/dup` has higher precedence than `database` in case both values are present +> - SHOULD maintain (security patching at a minimum) their existing major version > for at least six months after it starts emitting both sets of conventions. -> * MAY drop the environment variable in their next major version and emit only +> - MAY drop the environment variable in their next major version and emit only > the stable database conventions. ## Name @@ -233,14 +233,14 @@ Examples: The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`db.collection.name`](/docs/registry/attributes/db.md) -* [`db.namespace`](/docs/registry/attributes/db.md) -* [`db.operation.name`](/docs/registry/attributes/db.md) -* [`db.query.summary`](/docs/registry/attributes/db.md) -* [`db.query.text`](/docs/registry/attributes/db.md) -* [`db.system.name`](/docs/registry/attributes/db.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`db.collection.name`](/docs/registry/attributes/db.md) +- [`db.namespace`](/docs/registry/attributes/db.md) +- [`db.operation.name`](/docs/registry/attributes/db.md) +- [`db.query.summary`](/docs/registry/attributes/db.md) +- [`db.query.text`](/docs/registry/attributes/db.md) +- [`db.system.name`](/docs/registry/attributes/db.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- @@ -515,15 +515,15 @@ The instrumentation SHOULD allow users to pass a propagator to overwrite the glo More specific Semantic Conventions are defined for the following database technologies: -* [AWS DynamoDB](dynamodb.md): Semantic Conventions for *AWS DynamoDB*. -* [Cassandra](cassandra.md): Semantic Conventions for *Cassandra*. -* [Azure Cosmos DB](cosmosdb.md): Semantic Conventions for *Azure Cosmos DB*. -* [CouchDB](couchdb.md): Semantic Conventions for *CouchDB*. -* [Elasticsearch](elasticsearch.md): Semantic Conventions for *Elasticsearch*. -* [HBase](hbase.md): Semantic Conventions for *HBase*. -* [MongoDB](mongodb.md): Semantic Conventions for *MongoDB*. -* [Microsoft SQL Server](sql-server.md): Semantic Conventions for *Microsoft SQL Server*. -* [Redis](redis.md): Semantic Conventions for *Redis*. -* [SQL](sql.md): Semantic Conventions for *SQL* databases. +- [AWS DynamoDB](dynamodb.md): Semantic Conventions for *AWS DynamoDB*. +- [Cassandra](cassandra.md): Semantic Conventions for *Cassandra*. +- [Azure Cosmos DB](cosmosdb.md): Semantic Conventions for *Azure Cosmos DB*. +- [CouchDB](couchdb.md): Semantic Conventions for *CouchDB*. +- [Elasticsearch](elasticsearch.md): Semantic Conventions for *Elasticsearch*. +- [HBase](hbase.md): Semantic Conventions for *HBase*. +- [MongoDB](mongodb.md): Semantic Conventions for *MongoDB*. +- [Microsoft SQL Server](sql-server.md): Semantic Conventions for *Microsoft SQL Server*. +- [Redis](redis.md): Semantic Conventions for *Redis*. +- [SQL](sql.md): Semantic Conventions for *SQL* databases. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/database/elasticsearch.md b/docs/database/elasticsearch.md index 1ea48cd7fb..381685fe90 100644 --- a/docs/database/elasticsearch.md +++ b/docs/database/elasticsearch.md @@ -128,14 +128,14 @@ Parameterized query text SHOULD NOT be sanitized. Even though parameterized quer The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`db.collection.name`](/docs/registry/attributes/db.md) -* [`db.namespace`](/docs/registry/attributes/db.md) -* [`db.operation.name`](/docs/registry/attributes/db.md) -* [`db.query.text`](/docs/registry/attributes/db.md) -* [`http.request.method`](/docs/registry/attributes/http.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) -* [`url.full`](/docs/registry/attributes/url.md) +- [`db.collection.name`](/docs/registry/attributes/db.md) +- [`db.namespace`](/docs/registry/attributes/db.md) +- [`db.operation.name`](/docs/registry/attributes/db.md) +- [`db.query.text`](/docs/registry/attributes/db.md) +- [`http.request.method`](/docs/registry/attributes/http.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) +- [`url.full`](/docs/registry/attributes/url.md) --- diff --git a/docs/database/hbase.md b/docs/database/hbase.md index 3bab6e87bf..75a30c2331 100644 --- a/docs/database/hbase.md +++ b/docs/database/hbase.md @@ -78,11 +78,11 @@ Instrumentations SHOULD document how `error.type` is populated. The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`db.collection.name`](/docs/registry/attributes/db.md) -* [`db.namespace`](/docs/registry/attributes/db.md) -* [`db.operation.name`](/docs/registry/attributes/db.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`db.collection.name`](/docs/registry/attributes/db.md) +- [`db.namespace`](/docs/registry/attributes/db.md) +- [`db.operation.name`](/docs/registry/attributes/db.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/database/mariadb.md b/docs/database/mariadb.md index 6fcff6b09d..158b3aeaee 100644 --- a/docs/database/mariadb.md +++ b/docs/database/mariadb.md @@ -131,11 +131,11 @@ Examples: The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`db.namespace`](/docs/registry/attributes/db.md) -* [`db.query.summary`](/docs/registry/attributes/db.md) -* [`db.query.text`](/docs/registry/attributes/db.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`db.namespace`](/docs/registry/attributes/db.md) +- [`db.query.summary`](/docs/registry/attributes/db.md) +- [`db.query.text`](/docs/registry/attributes/db.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/database/mongodb.md b/docs/database/mongodb.md index bb11cef544..e4ede5e196 100644 --- a/docs/database/mongodb.md +++ b/docs/database/mongodb.md @@ -69,11 +69,11 @@ Instrumentations SHOULD document how `error.type` is populated. The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`db.collection.name`](/docs/registry/attributes/db.md) -* [`db.namespace`](/docs/registry/attributes/db.md) -* [`db.operation.name`](/docs/registry/attributes/db.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`db.collection.name`](/docs/registry/attributes/db.md) +- [`db.namespace`](/docs/registry/attributes/db.md) +- [`db.operation.name`](/docs/registry/attributes/db.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/database/mysql.md b/docs/database/mysql.md index 93b755b78e..67bdea8ae3 100644 --- a/docs/database/mysql.md +++ b/docs/database/mysql.md @@ -131,11 +131,11 @@ Examples: The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`db.namespace`](/docs/registry/attributes/db.md) -* [`db.query.summary`](/docs/registry/attributes/db.md) -* [`db.query.text`](/docs/registry/attributes/db.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`db.namespace`](/docs/registry/attributes/db.md) +- [`db.query.summary`](/docs/registry/attributes/db.md) +- [`db.query.text`](/docs/registry/attributes/db.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/database/oracledb.md b/docs/database/oracledb.md index 22da088195..bcb2b7d34f 100644 --- a/docs/database/oracledb.md +++ b/docs/database/oracledb.md @@ -127,11 +127,11 @@ Examples: The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`db.namespace`](/docs/registry/attributes/db.md) -* [`db.query.summary`](/docs/registry/attributes/db.md) -* [`db.query.text`](/docs/registry/attributes/db.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`db.namespace`](/docs/registry/attributes/db.md) +- [`db.query.summary`](/docs/registry/attributes/db.md) +- [`db.query.text`](/docs/registry/attributes/db.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/database/postgresql.md b/docs/database/postgresql.md index be994e988b..44b45487e0 100644 --- a/docs/database/postgresql.md +++ b/docs/database/postgresql.md @@ -139,11 +139,11 @@ Examples: The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`db.namespace`](/docs/registry/attributes/db.md) -* [`db.query.summary`](/docs/registry/attributes/db.md) -* [`db.query.text`](/docs/registry/attributes/db.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`db.namespace`](/docs/registry/attributes/db.md) +- [`db.query.summary`](/docs/registry/attributes/db.md) +- [`db.query.text`](/docs/registry/attributes/db.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/database/redis.md b/docs/database/redis.md index 4a48878142..ca7aaa896a 100644 --- a/docs/database/redis.md +++ b/docs/database/redis.md @@ -83,11 +83,11 @@ The value provided for `db.query.text` SHOULD correspond to the syntax of the Re The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`db.namespace`](/docs/registry/attributes/db.md) -* [`db.operation.name`](/docs/registry/attributes/db.md) -* [`db.query.text`](/docs/registry/attributes/db.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`db.namespace`](/docs/registry/attributes/db.md) +- [`db.operation.name`](/docs/registry/attributes/db.md) +- [`db.query.text`](/docs/registry/attributes/db.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/database/sql-server.md b/docs/database/sql-server.md index 91afc66472..6574e5355f 100644 --- a/docs/database/sql-server.md +++ b/docs/database/sql-server.md @@ -138,11 +138,11 @@ Examples: The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`db.namespace`](/docs/registry/attributes/db.md) -* [`db.query.summary`](/docs/registry/attributes/db.md) -* [`db.query.text`](/docs/registry/attributes/db.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`db.namespace`](/docs/registry/attributes/db.md) +- [`db.query.summary`](/docs/registry/attributes/db.md) +- [`db.query.text`](/docs/registry/attributes/db.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/database/sql.md b/docs/database/sql.md index 6aa241e43e..9b6e0e02f3 100644 --- a/docs/database/sql.md +++ b/docs/database/sql.md @@ -188,10 +188,10 @@ Examples: The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`db.query.summary`](/docs/registry/attributes/db.md) -* [`db.query.text`](/docs/registry/attributes/db.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`db.query.summary`](/docs/registry/attributes/db.md) +- [`db.query.text`](/docs/registry/attributes/db.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/dns/README.md b/docs/dns/README.md index 2eeeb53cf1..8d82d9f06f 100644 --- a/docs/dns/README.md +++ b/docs/dns/README.md @@ -10,6 +10,6 @@ This document defines semantic conventions for DNS. Semantic conventions are defined for the following signals: -* [Metrics](dns-metrics.md) +- [Metrics](dns-metrics.md) [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/dotnet/README.md b/docs/dotnet/README.md index 7e6c2f8f82..b2adaf3f8b 100644 --- a/docs/dotnet/README.md +++ b/docs/dotnet/README.md @@ -12,9 +12,9 @@ The following span are currently supported: The following metrics are currently supported: -* [ASP.NET Core](dotnet-aspnetcore-metrics.md): Semantic Conventions for ASP.NET Core routing, exceptions, and rate-limiting *metrics*. -* [DNS](dotnet-dns-metrics.md): Semantic Conventions for client-side DNS lookups associated with *metrics*. -* [HTTP](dotnet-http-metrics.md): Semantic Conventions for HTTP client and server *metrics*. -* [Kestrel](dotnet-kestrel-metrics.md): Semantic Conventions for Kestrel web server *metrics*. -* [SignalR](dotnet-signalr-metrics.md): Semantic Conventions for SignalR server *metrics*. -* [Runtime](/docs/runtime/dotnet-metrics.md): Semantic conventions for .NET Runtime *metrics*. +- [ASP.NET Core](dotnet-aspnetcore-metrics.md): Semantic Conventions for ASP.NET Core routing, exceptions, and rate-limiting *metrics*. +- [DNS](dotnet-dns-metrics.md): Semantic Conventions for client-side DNS lookups associated with *metrics*. +- [HTTP](dotnet-http-metrics.md): Semantic Conventions for HTTP client and server *metrics*. +- [Kestrel](dotnet-kestrel-metrics.md): Semantic Conventions for Kestrel web server *metrics*. +- [SignalR](dotnet-signalr-metrics.md): Semantic Conventions for SignalR server *metrics*. +- [Runtime](/docs/runtime/dotnet-metrics.md): Semantic conventions for .NET Runtime *metrics*. diff --git a/docs/exceptions/README.md b/docs/exceptions/README.md index 5934a07cfc..689eb407a1 100644 --- a/docs/exceptions/README.md +++ b/docs/exceptions/README.md @@ -8,7 +8,7 @@ linkTitle: Exceptions Semantic conventions for Exceptions are defined for the following signals: -* [Exceptions on spans](exceptions-spans.md): Semantic Conventions for Exceptions associated with *spans*. -* [Exceptions in logs](exceptions-logs.md): Semantic Conventions for Exceptions recorded in *logs*. +- [Exceptions on spans](exceptions-spans.md): Semantic Conventions for Exceptions associated with *spans*. +- [Exceptions in logs](exceptions-logs.md): Semantic Conventions for Exceptions recorded in *logs*. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/faas/README.md b/docs/faas/README.md index 69c59ee6af..bb8865753a 100644 --- a/docs/faas/README.md +++ b/docs/faas/README.md @@ -10,11 +10,11 @@ This document defines semantic conventions for Function as a Service (FaaS) span Semantic conventions for FaaS are defined for the following signals: -* [FaaS Spans](faas-spans.md): Semantic Conventions for FaaS *spans*. -* [FaaS Metrics](faas-metrics.md): Semantic Conventions for FaaS *metrics*. +- [FaaS Spans](faas-spans.md): Semantic Conventions for FaaS *spans*. +- [FaaS Metrics](faas-metrics.md): Semantic Conventions for FaaS *metrics*. Technology specific semantic conventions are defined for the following FaaS services: -* [AWS Lambda](aws-lambda.md): Semantic Conventions for *AWS Lambda*. +- [AWS Lambda](aws-lambda.md): Semantic Conventions for *AWS Lambda*. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/faas/faas-metrics.md b/docs/faas/faas-metrics.md index 6615df2211..e68e1fb4cd 100644 --- a/docs/faas/faas-metrics.md +++ b/docs/faas/faas-metrics.md @@ -373,11 +373,11 @@ This metric is [recommended][MetricRecommended]. Below are links to documentation regarding metrics that are available with different FaaS providers. This list is not exhaustive. -* [AWS Lambda Metrics](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-metrics.html) -* [AWS Lambda Insight Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-metrics.html) -* [Azure Functions Metrics](https://docs.microsoft.com/azure/azure-monitor/platform/metrics-supported) -* [Google CloudFunctions Metrics](https://cloud.google.com/monitoring/api/metrics_gcp_c#gcp-cloudfunctions) -* [OpenFaas Metrics](https://docs.openfaas.com/architecture/metrics/) +- [AWS Lambda Metrics](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-metrics.html) +- [AWS Lambda Insight Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-metrics.html) +- [Azure Functions Metrics](https://docs.microsoft.com/azure/azure-monitor/platform/metrics-supported) +- [Google CloudFunctions Metrics](https://cloud.google.com/monitoring/api/metrics_gcp_c#gcp-cloudfunctions) +- [OpenFaas Metrics](https://docs.openfaas.com/architecture/metrics/) [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status [MetricRecommended]: /docs/general/metric-requirement-level.md#recommended diff --git a/docs/feature-flags/README.md b/docs/feature-flags/README.md index fa37c4868f..0ccea9c91b 100644 --- a/docs/feature-flags/README.md +++ b/docs/feature-flags/README.md @@ -11,6 +11,6 @@ evaluations in logs. Semantic conventions for feature flags are defined for the following signals: -* [Feature Flags in Events](feature-flags-events.md): Semantic Conventions for recording feature flags in *events*. +- [Feature Flags in Events](feature-flags-events.md): Semantic Conventions for recording feature flags in *events*. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/gen-ai/README.md b/docs/gen-ai/README.md index 0a0b588660..77d8f0b6f3 100644 --- a/docs/gen-ai/README.md +++ b/docs/gen-ai/README.md @@ -12,16 +12,16 @@ linkTitle: Generative AI > [v1.36.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.36.0/docs/gen-ai/README.md) > (or prior): > -> * SHOULD NOT change the version of the GenAI conventions that they emit by default. +> - SHOULD NOT change the version of the GenAI conventions that they emit by default. > Conventions include, but are not limited to, attributes, metric, span and event names, > span kind and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > as a comma-separated list of category-specific values. The list of values > includes: -> * `gen_ai_latest_experimental` - emit the latest experimental version of +> - `gen_ai_latest_experimental` - emit the latest experimental version of > GenAI conventions (supported by the instrumentation) and do not emit the > old one (v1.36.0 or prior). -> * The default behavior is to continue emitting whatever version of the GenAI +> - The default behavior is to continue emitting whatever version of the GenAI > conventions the instrumentation was emitting (1.36.0 or prior). > > This transition plan will be updated to include stable version before the @@ -29,15 +29,15 @@ linkTitle: Generative AI Semantic conventions for Generative AI operations are defined for the following signals: -* [Events](gen-ai-events.md): Semantic Conventions for Generative AI inputs and outputs - *events*. -* [Metrics](gen-ai-metrics.md): Semantic Conventions for Generative AI operations - *metrics*. -* [Model spans](gen-ai-spans.md): Semantic Conventions for Generative AI model operations - *spans*. -* [Agent spans](gen-ai-agent-spans.md): Semantic Conventions for Generative AI agent operations - *spans*. +- [Events](gen-ai-events.md): Semantic Conventions for Generative AI inputs and outputs - *events*. +- [Metrics](gen-ai-metrics.md): Semantic Conventions for Generative AI operations - *metrics*. +- [Model spans](gen-ai-spans.md): Semantic Conventions for Generative AI model operations - *spans*. +- [Agent spans](gen-ai-agent-spans.md): Semantic Conventions for Generative AI agent operations - *spans*. Technology specific semantic conventions are defined for the following GenAI system: -* [Azure AI Inference](./azure-ai-inference.md): Semantic Conventions for Azure AI Inference. -* [OpenAI](./openai.md): Semantic Conventions for OpenAI. -* [AWS Bedrock](./aws-bedrock.md): Semantic Conventions for AWS Bedrock. +- [Azure AI Inference](./azure-ai-inference.md): Semantic Conventions for Azure AI Inference. +- [OpenAI](./openai.md): Semantic Conventions for OpenAI. +- [AWS Bedrock](./aws-bedrock.md): Semantic Conventions for AWS Bedrock. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/gen-ai/aws-bedrock.md b/docs/gen-ai/aws-bedrock.md index ba69c84588..99b88df6ed 100644 --- a/docs/gen-ai/aws-bedrock.md +++ b/docs/gen-ai/aws-bedrock.md @@ -12,16 +12,16 @@ linkTitle: AWS Bedrock > [v1.36.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.36.0/docs/gen-ai/README.md) > (or prior): > -> * SHOULD NOT change the version of the GenAI conventions that they emit by default. +> - SHOULD NOT change the version of the GenAI conventions that they emit by default. > Conventions include, but are not limited to, attributes, metric, span and event names, > span kind and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > as a comma-separated list of category-specific values. The list of values > includes: -> * `gen_ai_latest_experimental` - emit the latest experimental version of +> - `gen_ai_latest_experimental` - emit the latest experimental version of > GenAI conventions (supported by the instrumentation) and do not emit the > old one (v1.36.0 or prior). -> * The default behavior is to continue emitting whatever version of the GenAI +> - The default behavior is to continue emitting whatever version of the GenAI > conventions the instrumentation was emitting (1.34.0 or prior). > > This transition plan will be updated to include stable version before the diff --git a/docs/gen-ai/azure-ai-inference.md b/docs/gen-ai/azure-ai-inference.md index eda70be7d6..1755c80b56 100644 --- a/docs/gen-ai/azure-ai-inference.md +++ b/docs/gen-ai/azure-ai-inference.md @@ -21,16 +21,16 @@ linkTitle: Azure AI Inference > [v1.36.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.36.0/docs/gen-ai/README.md) > (or prior): > -> * SHOULD NOT change the version of the GenAI conventions that they emit by default. +> - SHOULD NOT change the version of the GenAI conventions that they emit by default. > Conventions include, but are not limited to, attributes, metric, span and event names, > span kind and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > as a comma-separated list of category-specific values. The list of values > includes: -> * `gen_ai_latest_experimental` - emit the latest experimental version of +> - `gen_ai_latest_experimental` - emit the latest experimental version of > GenAI conventions (supported by the instrumentation) and do not emit the > old one (v1.36.0 or prior). -> * The default behavior is to continue emitting whatever version of the GenAI +> - The default behavior is to continue emitting whatever version of the GenAI > conventions the instrumentation was emitting (1.36.0 or prior). > > This transition plan will be updated to include stable version before the diff --git a/docs/gen-ai/gen-ai-agent-spans.md b/docs/gen-ai/gen-ai-agent-spans.md index e11d0d1dba..9fe85bf4a9 100644 --- a/docs/gen-ai/gen-ai-agent-spans.md +++ b/docs/gen-ai/gen-ai-agent-spans.md @@ -21,16 +21,16 @@ linkTitle: Agent spans > [v1.36.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.36.0/docs/gen-ai/README.md) > (or prior): > -> * SHOULD NOT change the version of the GenAI conventions that they emit by default. +> - SHOULD NOT change the version of the GenAI conventions that they emit by default. > Conventions include, but are not limited to, attributes, metric, span and event names, > span kind and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > as a comma-separated list of category-specific values. The list of values > includes: -> * `gen_ai_latest_experimental` - emit the latest experimental version of +> - `gen_ai_latest_experimental` - emit the latest experimental version of > GenAI conventions (supported by the instrumentation) and do not emit the > old one (v1.36.0 or prior). -> * The default behavior is to continue emitting whatever version of the GenAI +> - The default behavior is to continue emitting whatever version of the GenAI > conventions the instrumentation was emitting (1.34.0 or prior). > > This transition plan will be updated to include stable version before the diff --git a/docs/gen-ai/gen-ai-events.md b/docs/gen-ai/gen-ai-events.md index afbf196a8b..82fbf75df7 100644 --- a/docs/gen-ai/gen-ai-events.md +++ b/docs/gen-ai/gen-ai-events.md @@ -19,16 +19,16 @@ linkTitle: Events > [v1.36.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.36.0/docs/gen-ai/README.md) > (or prior): > -> * SHOULD NOT change the version of the GenAI conventions that they emit by default. +> - SHOULD NOT change the version of the GenAI conventions that they emit by default. > Conventions include, but are not limited to, attributes, metric, span and event names, > span kind and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > as a comma-separated list of category-specific values. The list of values > includes: -> * `gen_ai_latest_experimental` - emit the latest experimental version of +> - `gen_ai_latest_experimental` - emit the latest experimental version of > GenAI conventions (supported by the instrumentation) and do not emit the > old one (v1.36.0 or prior). -> * The default behavior is to continue emitting whatever version of the GenAI +> - The default behavior is to continue emitting whatever version of the GenAI > conventions the instrumentation was emitting (1.36.0 or prior). > > This transition plan will be updated to include stable version before the diff --git a/docs/gen-ai/gen-ai-metrics.md b/docs/gen-ai/gen-ai-metrics.md index 2efdb2a5c2..6d59a020a2 100644 --- a/docs/gen-ai/gen-ai-metrics.md +++ b/docs/gen-ai/gen-ai-metrics.md @@ -24,16 +24,16 @@ linkTitle: Metrics > [v1.36.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.36.0/docs/gen-ai/README.md) > (or prior): > -> * SHOULD NOT change the version of the GenAI conventions that they emit by default. +> - SHOULD NOT change the version of the GenAI conventions that they emit by default. > Conventions include, but are not limited to, attributes, metric, span and event names, > span kind and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > as a comma-separated list of category-specific values. The list of values > includes: -> * `gen_ai_latest_experimental` - emit the latest experimental version of +> - `gen_ai_latest_experimental` - emit the latest experimental version of > GenAI conventions (supported by the instrumentation) and do not emit the > old one (v1.36.0 or prior). -> * The default behavior is to continue emitting whatever version of the GenAI +> - The default behavior is to continue emitting whatever version of the GenAI > conventions the instrumentation was emitting (1.36.0 or prior). > > This transition plan will be updated to include stable version before the diff --git a/docs/gen-ai/gen-ai-spans.md b/docs/gen-ai/gen-ai-spans.md index 04e13df69a..0ef628f75d 100644 --- a/docs/gen-ai/gen-ai-spans.md +++ b/docs/gen-ai/gen-ai-spans.md @@ -26,16 +26,16 @@ linkTitle: Spans > [v1.36.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.36.0/docs/gen-ai/README.md) > (or prior): > -> * SHOULD NOT change the version of the GenAI conventions that they emit by default. +> - SHOULD NOT change the version of the GenAI conventions that they emit by default. > Conventions include, but are not limited to, attributes, metric, span and event names, > span kind and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > as a comma-separated list of category-specific values. The list of values > includes: -> * `gen_ai_latest_experimental` - emit the latest experimental version of +> - `gen_ai_latest_experimental` - emit the latest experimental version of > GenAI conventions (supported by the instrumentation) and do not emit the > old one (v1.36.0 or prior). -> * The default behavior is to continue emitting whatever version of the GenAI +> - The default behavior is to continue emitting whatever version of the GenAI > conventions the instrumentation was emitting (1.36.0 or prior). > > This transition plan will be updated to include stable version before the diff --git a/docs/gen-ai/openai.md b/docs/gen-ai/openai.md index a8c8a2cac2..cb4d70fa94 100644 --- a/docs/gen-ai/openai.md +++ b/docs/gen-ai/openai.md @@ -23,16 +23,16 @@ linkTitle: OpenAI > [v1.36.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.36.0/docs/gen-ai/README.md) > (or prior): > -> * SHOULD NOT change the version of the GenAI conventions that they emit by default. +> - SHOULD NOT change the version of the GenAI conventions that they emit by default. > Conventions include, but are not limited to, attributes, metric, span and event names, > span kind and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > as a comma-separated list of category-specific values. The list of values > includes: -> * `gen_ai_latest_experimental` - emit the latest experimental version of +> - `gen_ai_latest_experimental` - emit the latest experimental version of > GenAI conventions (supported by the instrumentation) and do not emit the > old one (v1.36.0 or prior). -> * The default behavior is to continue emitting whatever version of the GenAI +> - The default behavior is to continue emitting whatever version of the GenAI > conventions the instrumentation was emitting (1.36.0 or prior). > > This transition plan will be updated to include stable version before the diff --git a/docs/general/README.md b/docs/general/README.md index e95ff9f264..d781726d16 100644 --- a/docs/general/README.md +++ b/docs/general/README.md @@ -10,8 +10,8 @@ This document defines general Semantic Conventions for spans, metrics, logs and The following general Semantic Conventions are defined: -* **[General attributes](attributes.md): General semantic attributes**. -* [Events](events.md): General Semantic Conventions for events. -* [Logs](logs.md): General Semantic Conventions for logs. -* [Metrics](metrics.md): General Semantic Conventions for metrics. -* [Spans](trace.md): General Semantic Conventions for traces / spans. +- **[General attributes](attributes.md): General semantic attributes**. +- [Events](events.md): General Semantic Conventions for events. +- [Logs](logs.md): General Semantic Conventions for logs. +- [Metrics](metrics.md): General Semantic Conventions for metrics. +- [Spans](trace.md): General Semantic Conventions for traces / spans. diff --git a/docs/general/events.md b/docs/general/events.md index 445bc4272a..817b71612d 100644 --- a/docs/general/events.md +++ b/docs/general/events.md @@ -22,17 +22,13 @@ Semantic conventions that define events MUST document the event name and its att ## General event semantics -* An event MUST have an [event name](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.51.0/specification/logs/data-model.md#field-eventname) +- An event MUST have an [event name](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.51.0/specification/logs/data-model.md#field-eventname) that uniquely identifies the event structure. - -* Event names SHOULD follow the [Naming guidelines](/docs/general/naming.md). - -* [Attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.51.0/specification/logs/data-model.md#field-attributes) +- Event names SHOULD follow the [Naming guidelines](/docs/general/naming.md). +- [Attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.51.0/specification/logs/data-model.md#field-attributes) SHOULD be used to represent details and provide additional context about the event. - -* Events SHOULD NOT use [body](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.51.0/specification/logs/data-model.md#field-body). - -* Events SHOULD specify a [severity number](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.51.0/specification/logs/data-model.md#field-severitynumber). +- Events SHOULD NOT use [body](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.51.0/specification/logs/data-model.md#field-body). +- Events SHOULD specify a [severity number](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.51.0/specification/logs/data-model.md#field-severitynumber). ## External event compatibility diff --git a/docs/general/logs.md b/docs/general/logs.md index f40243e361..75a8f15c56 100644 --- a/docs/general/logs.md +++ b/docs/general/logs.md @@ -21,8 +21,8 @@ They may be used in any Log Record they apply to. The following semantic conventions for logs are defined: -* **[General](#general-log-identification-attributes): General semantic attributes that may be used in describing Log Records.** -* [Exceptions](/docs/exceptions/exceptions-logs.md): Semantic attributes that may be used in describing exceptions in logs. +- **[General](#general-log-identification-attributes): General semantic attributes that may be used in describing Log Records.** +- [Exceptions](/docs/exceptions/exceptions-logs.md): Semantic attributes that may be used in describing exceptions in logs. Apart from semantic conventions for logs, [events](events.md), [traces](trace.md), and [metrics](metrics.md), OpenTelemetry also defines the concept of overarching [Resources](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.51.0/specification/resource/sdk.md) with their own diff --git a/docs/general/metrics.md b/docs/general/metrics.md index 23900d88d3..6a8f289ce4 100644 --- a/docs/general/metrics.md +++ b/docs/general/metrics.md @@ -19,22 +19,22 @@ aliases: [metrics-general] The following semantic conventions surrounding metrics are defined: -* **[General Guidelines](#general-guidelines): General metrics guidelines.** -* [Database](/docs/database/database-metrics.md): For SQL and NoSQL client metrics. -* [FaaS](/docs/faas/faas-metrics.md): For [Function as a Service](https://wikipedia.org/wiki/Function_as_a_service) metrics. -* [GenAI](/docs/gen-ai/gen-ai-metrics.md): For Generative AI metrics. -* [HTTP](/docs/http/http-metrics.md): For HTTP client and server metrics. -* [Messaging](/docs/messaging/messaging-metrics.md): For messaging systems (queues, publish/subscribe, etc.) metrics. -* [RPC](/docs/rpc/rpc-metrics.md): For RPC client and server metrics. -* [.NET](/docs/dotnet/README.md): For network-related metrics emitted by .NET runtime components. -* **System metrics** - * [System](/docs/system/system-metrics.md): For standard system metrics. - * [Container](/docs/system/container-metrics.md) - * [Hardware](/docs/hardware/README.md): For hardware-related metrics. - * [K8s](/docs/system/k8s-metrics.md): For K8s metrics. - * [Process](/docs/system/process-metrics.md): For standard process metrics. - * [Runtime Environment](/docs/runtime/README.md#metrics): For runtime environment metrics. -* [OTel SDK Telemetry](/docs/otel/sdk-metrics.md): Metrics emitted by the OpenTelemetry SDK components. +- **[General Guidelines](#general-guidelines): General metrics guidelines.** +- [Database](/docs/database/database-metrics.md): For SQL and NoSQL client metrics. +- [FaaS](/docs/faas/faas-metrics.md): For [Function as a Service](https://wikipedia.org/wiki/Function_as_a_service) metrics. +- [GenAI](/docs/gen-ai/gen-ai-metrics.md): For Generative AI metrics. +- [HTTP](/docs/http/http-metrics.md): For HTTP client and server metrics. +- [Messaging](/docs/messaging/messaging-metrics.md): For messaging systems (queues, publish/subscribe, etc.) metrics. +- [RPC](/docs/rpc/rpc-metrics.md): For RPC client and server metrics. +- [.NET](/docs/dotnet/README.md): For network-related metrics emitted by .NET runtime components. +- **System metrics** + - [System](/docs/system/system-metrics.md): For standard system metrics. + - [Container](/docs/system/container-metrics.md) + - [Hardware](/docs/hardware/README.md): For hardware-related metrics. + - [K8s](/docs/system/k8s-metrics.md): For K8s metrics. + - [Process](/docs/system/process-metrics.md): For standard process metrics. + - [Runtime Environment](/docs/runtime/README.md#metrics): For runtime environment metrics. +- [OTel SDK Telemetry](/docs/otel/sdk-metrics.md): Metrics emitted by the OpenTelemetry SDK components. Apart from semantic conventions for metrics, [traces](trace.md), [logs](logs.md), and [events](events.md), OpenTelemetry also defines the concept of overarching [Resources](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.51.0/specification/resource/sdk.md) with diff --git a/docs/general/trace.md b/docs/general/trace.md index b60a9f6f69..7a82b11b59 100644 --- a/docs/general/trace.md +++ b/docs/general/trace.md @@ -20,17 +20,17 @@ can still be easily correlated and cross-analyzed. The following semantic conventions for spans are defined: -* **[General](attributes.md): General semantic attributes that may be used in describing different kinds of operations.** -* [Compatibility](trace-compatibility.md): For spans generated by compatibility components, e.g. OpenTracing Shim layer. -* [CloudEvents](/docs/cloudevents/README.md): Semantic Conventions for the CloudEvents spans. -* [Cloud Providers](/docs/cloud-providers/README.md): Semantic Conventions for cloud providers spans. -* [Database](/docs/database/database-spans.md): For SQL and NoSQL client call spans. -* [Exceptions](/docs/exceptions/exceptions-spans.md): For recording exceptions associated with a span. -* [FaaS](/docs/faas/faas-spans.md): For [Function as a Service](https://wikipedia.org/wiki/Function_as_a_service) (e.g., AWS Lambda) spans. -* [HTTP](/docs/http/http-spans.md): For HTTP client and server spans. -* [Messaging](/docs/messaging/messaging-spans.md): For messaging systems (queues, publish/subscribe, etc.) spans. -* [Object Stores](/docs/object-stores/README.md): Semantic Conventions for object stores spans. -* [RPC/RMI](/docs/rpc/rpc-spans.md): For remote procedure call (e.g., gRPC) spans. +- **[General](attributes.md): General semantic attributes that may be used in describing different kinds of operations.** +- [Compatibility](trace-compatibility.md): For spans generated by compatibility components, e.g. OpenTracing Shim layer. +- [CloudEvents](/docs/cloudevents/README.md): Semantic Conventions for the CloudEvents spans. +- [Cloud Providers](/docs/cloud-providers/README.md): Semantic Conventions for cloud providers spans. +- [Database](/docs/database/database-spans.md): For SQL and NoSQL client call spans. +- [Exceptions](/docs/exceptions/exceptions-spans.md): For recording exceptions associated with a span. +- [FaaS](/docs/faas/faas-spans.md): For [Function as a Service](https://wikipedia.org/wiki/Function_as_a_service) (e.g., AWS Lambda) spans. +- [HTTP](/docs/http/http-spans.md): For HTTP client and server spans. +- [Messaging](/docs/messaging/messaging-spans.md): For messaging systems (queues, publish/subscribe, etc.) spans. +- [Object Stores](/docs/object-stores/README.md): Semantic Conventions for object stores spans. +- [RPC/RMI](/docs/rpc/rpc-spans.md): For remote procedure call (e.g., gRPC) spans. Apart from semantic conventions for traces, [metrics](metrics.md), [logs](logs.md), and [events](events.md), OpenTelemetry also defines the concept of overarching [Resources](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.51.0/specification/resource/sdk.md) with their own diff --git a/docs/graphql/README.md b/docs/graphql/README.md index 0801f5f479..7fb53f0e15 100644 --- a/docs/graphql/README.md +++ b/docs/graphql/README.md @@ -10,6 +10,6 @@ This document defines semantic conventions for GraphQL. Semantic conventions are defined for the following signals: -* [Spans](graphql-spans.md) +- [Spans](graphql-spans.md) [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/hardware/README.md b/docs/hardware/README.md index cd153a23f7..ec45296d5a 100644 --- a/docs/hardware/README.md +++ b/docs/hardware/README.md @@ -13,21 +13,21 @@ when creating instruments not explicitly defined in the specification. Semantic conventions for hardware are defined as following: -* [Common Hardware Metrics](common.md): Semantic Conventions for *common* hardware metrics. -* [Physical Host Metrics](host.md): Semantic Conventions for *physical host* metrics. -* [Battery Metrics](battery.md): Semantic Conventions for *battery* metrics. -* [CPU Metrics](cpu.md): Semantic Conventions for *CPU* metrics. -* [Disk Controller Metrics](disk-controller.md): Semantic Conventions for *disk controller* metrics. -* [Enclosure Metrics](enclosure.md): Semantic Conventions for *enclosure* metrics. -* [Fan Metrics](fan.md): Semantic Conventions for *fan* metrics. -* [GPU Metrics](gpu.md): Semantic Conventions for *GPU* metrics. -* [Logical Disk Metrics](logical-disk.md): Semantic Conventions for *logical disk* metrics. -* [Memory Metrics](memory.md): Semantic Conventions for *memory* metrics. -* [Network Metrics](network.md): Semantic Conventions for *network* metrics. -* [Physical Disk Metrics](physical-disk.md): Semantic Conventions for *physical disk* metrics. -* [Power Supply Metrics](power-supply.md): Semantic Conventions for *power supply* metrics. -* [Tape Drive Metrics](tape-drive.md): Semantic Conventions for *tape drive* metrics. -* [Temperature Metrics](temperature.md): Semantic Conventions for *temperature* metrics. -* [Voltage Metrics](voltage.md): Semantic Conventions for *voltage* metrics. +- [Common Hardware Metrics](common.md): Semantic Conventions for *common* hardware metrics. +- [Physical Host Metrics](host.md): Semantic Conventions for *physical host* metrics. +- [Battery Metrics](battery.md): Semantic Conventions for *battery* metrics. +- [CPU Metrics](cpu.md): Semantic Conventions for *CPU* metrics. +- [Disk Controller Metrics](disk-controller.md): Semantic Conventions for *disk controller* metrics. +- [Enclosure Metrics](enclosure.md): Semantic Conventions for *enclosure* metrics. +- [Fan Metrics](fan.md): Semantic Conventions for *fan* metrics. +- [GPU Metrics](gpu.md): Semantic Conventions for *GPU* metrics. +- [Logical Disk Metrics](logical-disk.md): Semantic Conventions for *logical disk* metrics. +- [Memory Metrics](memory.md): Semantic Conventions for *memory* metrics. +- [Network Metrics](network.md): Semantic Conventions for *network* metrics. +- [Physical Disk Metrics](physical-disk.md): Semantic Conventions for *physical disk* metrics. +- [Power Supply Metrics](power-supply.md): Semantic Conventions for *power supply* metrics. +- [Tape Drive Metrics](tape-drive.md): Semantic Conventions for *tape drive* metrics. +- [Temperature Metrics](temperature.md): Semantic Conventions for *temperature* metrics. +- [Voltage Metrics](voltage.md): Semantic Conventions for *voltage* metrics. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/how-to-write-conventions/resource-and-entities.md b/docs/how-to-write-conventions/resource-and-entities.md index b36863f31c..3b72efe64e 100644 --- a/docs/how-to-write-conventions/resource-and-entities.md +++ b/docs/how-to-write-conventions/resource-and-entities.md @@ -242,8 +242,8 @@ this is: > > Resource provides two important aspects for observability: > -> * It MUST identify an entity that is producing telemetry. -> * It SHOULD allow users to determine where that entity resides within their +> - It MUST identify an entity that is producing telemetry. +> - It SHOULD allow users to determine where that entity resides within their > infrastructure. All resources are composed of [Entities](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.45.0/specification/entities/README.md#overview). diff --git a/docs/how-to-write-conventions/status-metrics.md b/docs/how-to-write-conventions/status-metrics.md index ceb802a792..0badfcf9af 100644 --- a/docs/how-to-write-conventions/status-metrics.md +++ b/docs/how-to-write-conventions/status-metrics.md @@ -68,8 +68,8 @@ If there are not any naming options immediately available, you may use this recommended naming scheme. This naming scheme necessitates choosing words to represent two things: -* The noun representing one of the set of possible values (the attribute name) -* The adjective describing which of the values is currently active (the metric +- The noun representing one of the set of possible values (the attribute name) +- The adjective describing which of the values is currently active (the metric name) The general recommendation is to use the word "state" for the attribute and diff --git a/docs/http/README.md b/docs/http/README.md index f1972f15bd..4afeb45aba 100644 --- a/docs/http/README.md +++ b/docs/http/README.md @@ -15,31 +15,31 @@ and various HTTP versions like 1.1, 2 and SPDY. > [v1.20.0 of this document](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/trace/semantic_conventions/http.md) > (or prior): > -> * SHOULD NOT change the version of the HTTP or networking conventions that they emit by default +> - SHOULD NOT change the version of the HTTP or networking conventions that they emit by default > until the HTTP semantic conventions are marked stable (HTTP stabilization will > include stabilization of a core set of networking conventions which are also used > in HTTP instrumentations). Conventions include, but are not limited to, attributes, > metric and span names, and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in the existing major version as a comma-separated list of category-specific values > (e.g., http, databases, messaging). The list of values includes: -> * `http` - emit the new, stable HTTP and networking conventions, +> - `http` - emit the new, stable HTTP and networking conventions, > and stop emitting the old experimental HTTP and networking conventions > that the instrumentation emitted previously. -> * `http/dup` - emit both the old and the stable HTTP and networking conventions, +> - `http/dup` - emit both the old and the stable HTTP and networking conventions, > allowing for a seamless transition. -> * The default behavior (in the absence of one of these values) is to continue +> - The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental HTTP and networking conventions > the instrumentation was emitting previously. -> * Note: `http/dup` has higher precedence than `http` in case both values are present -> * SHOULD maintain (security patching at a minimum) the existing major version +> - Note: `http/dup` has higher precedence than `http` in case both values are present +> - SHOULD maintain (security patching at a minimum) the existing major version > for at least six months after it starts emitting both sets of conventions. -> * SHOULD drop the environment variable in the next major version. +> - SHOULD drop the environment variable in the next major version. Semantic conventions for HTTP are defined for the following signals: -* [HTTP Spans](http-spans.md): Semantic Conventions for HTTP client and server *spans*. -* [HTTP Metrics](http-metrics.md): Semantic Conventions for HTTP client and server *metrics*. +- [HTTP Spans](http-spans.md): Semantic Conventions for HTTP client and server *spans*. +- [HTTP Metrics](http-metrics.md): Semantic Conventions for HTTP client and server *metrics*. For help migrating from non-stable to stable conventions, see [the migration guide](../non-normative/http-migration.md). diff --git a/docs/http/http-metrics.md b/docs/http/http-metrics.md index 88e3715246..6e636a8ea5 100644 --- a/docs/http/http-metrics.md +++ b/docs/http/http-metrics.md @@ -34,26 +34,26 @@ operations. By adding HTTP attributes to metric events it allows for finely tune > [v1.20.0 of this document](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/metrics/semantic_conventions/http-metrics.md) > (or prior): > -> * SHOULD NOT change the version of the HTTP or networking conventions that they emit by default +> - SHOULD NOT change the version of the HTTP or networking conventions that they emit by default > until the HTTP semantic conventions are marked stable (HTTP stabilization will > include stabilization of a core set of networking conventions which are also used > in HTTP instrumentations). Conventions include, but are not limited to, attributes, > metric and span names, and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in the existing major version as a comma-separated list of category-specific values > (e.g., http, databases, messaging). The list of values includes: -> * `http` - emit the new, stable HTTP and networking conventions, +> - `http` - emit the new, stable HTTP and networking conventions, > and stop emitting the old experimental HTTP and networking conventions > that the instrumentation emitted previously. -> * `http/dup` - emit both the old and the stable HTTP and networking conventions, +> - `http/dup` - emit both the old and the stable HTTP and networking conventions, > allowing for a seamless transition. -> * The default behavior (in the absence of one of these values) is to continue +> - The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental HTTP and networking conventions > the instrumentation was emitting previously. -> * Note: `http/dup` has higher precedence than `http` in case both values are present -> * SHOULD maintain (security patching at a minimum) the existing major version +> - Note: `http/dup` has higher precedence than `http` in case both values are present +> - SHOULD maintain (security patching at a minimum) the existing major version > for at least six months after it starts emitting both sets of conventions. -> * SHOULD drop the environment variable in the next major version. +> - SHOULD drop the environment variable in the next major version. ## HTTP server diff --git a/docs/http/http-spans.md b/docs/http/http-spans.md index e064465eac..b7e6fb00c9 100644 --- a/docs/http/http-spans.md +++ b/docs/http/http-spans.md @@ -39,26 +39,26 @@ and various HTTP versions like 1.1, 2 and SPDY. > [v1.20.0 of this document](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/trace/semantic_conventions/http.md) > (or prior): > -> * SHOULD NOT change the version of the HTTP or networking conventions that they emit by default +> - SHOULD NOT change the version of the HTTP or networking conventions that they emit by default > until the HTTP semantic conventions are marked stable (HTTP stabilization will > include stabilization of a core set of networking conventions which are also used > in HTTP instrumentations). Conventions include, but are not limited to, attributes, > metric and span names, and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in the existing major version as a comma-separated list of category-specific values > (e.g., http, databases, messaging). The list of values includes: -> * `http` - emit the new, stable HTTP and networking conventions, +> - `http` - emit the new, stable HTTP and networking conventions, > and stop emitting the old experimental HTTP and networking conventions > that the instrumentation emitted previously. -> * `http/dup` - emit both the old and the stable HTTP and networking conventions, +> - `http/dup` - emit both the old and the stable HTTP and networking conventions, > allowing for a seamless transition. -> * The default behavior (in the absence of one of these values) is to continue +> - The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental HTTP and networking conventions > the instrumentation was emitting previously. -> * Note: `http/dup` has higher precedence than `http` in case both values are present -> * SHOULD maintain (security patching at a minimum) the existing major version +> - Note: `http/dup` has higher precedence than `http` in case both values are present +> - SHOULD maintain (security patching at a minimum) the existing major version > for at least six months after it starts emitting both sets of conventions. -> * SHOULD drop the environment variable in the next major version. +> - SHOULD drop the environment variable in the next major version. ## Name @@ -293,10 +293,10 @@ Examples: The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`http.request.method`](/docs/registry/attributes/http.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) -* [`url.full`](/docs/registry/attributes/url.md) +- [`http.request.method`](/docs/registry/attributes/http.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) +- [`url.full`](/docs/registry/attributes/url.md) --- @@ -353,8 +353,8 @@ and SHOULD be provided **at span creation time** (if provided at all): There are some minimal constraints that SHOULD be honored: -* HTTP client spans SHOULD start sometime before the first request byte is sent. This may or may not include connection time. -* HTTP client spans SHOULD end sometime after the HTTP response headers are fully read (or when they fail to be read). This may or may not include reading the response body. +- HTTP client spans SHOULD start sometime before the first request byte is sent. This may or may not include connection time. +- HTTP client spans SHOULD end sometime after the HTTP response headers are fully read (or when they fail to be read). This may or may not include reading the response body. If there is any possibility for application code to not fully read the HTTP response (and for the HTTP client library to then have to clean up the HTTP response asynchronously), @@ -375,9 +375,9 @@ Each time an HTTP request is resent, the `http.request.resend_count` attribute S See the examples for more details about: -* [retrying a server error](#http-client-retries-examples), -* [redirects](#http-client-redirects-examples), -* [authorization](#http-client-authorization-retry-examples). +- [retrying a server error](#http-client-retries-examples), +- [redirects](#http-client-redirects-examples), +- [authorization](#http-client-authorization-retry-examples). ## HTTP server @@ -401,9 +401,9 @@ In the context of HTTP server, `server.address` and `server.port` attributes cap HTTP server instrumentations SHOULD do the best effort when populating `server.address` and `server.port` attributes and SHOULD determine them by using the first of the following that applies: -* The original host which may be passed by the reverse proxy in the [`Forwarded#host`][Forwarded#host], [`X-Forwarded-Host`][X-Forwarded-Host], or a similar header. -* The [`:authority`][HTTP/2 authority] pseudo-header in case of HTTP/2 or HTTP/3 -* The [`Host`][Host header] header. +- The original host which may be passed by the reverse proxy in the [`Forwarded#host`][Forwarded#host], [`X-Forwarded-Host`][X-Forwarded-Host], or a similar header. +- The [`:authority`][HTTP/2 authority] pseudo-header in case of HTTP/2 or HTTP/3 +- The [`Host`][Host header] header. > **Note**: The `Host` and `:authority` headers contain host and port number of the server. The same applies to the `host` identifier of `Forwarded` header or the `X-Forwarded-Host` header. Instrumentations SHOULD populate both `server.address` and `server.port` attributes by parsing the value of corresponding header. @@ -591,15 +591,15 @@ Examples: The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`client.address`](/docs/registry/attributes/client.md) -* [`http.request.header.`](/docs/registry/attributes/http.md) -* [`http.request.method`](/docs/registry/attributes/http.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) -* [`url.path`](/docs/registry/attributes/url.md) -* [`url.query`](/docs/registry/attributes/url.md) -* [`url.scheme`](/docs/registry/attributes/url.md) -* [`user_agent.original`](/docs/registry/attributes/user-agent.md) +- [`client.address`](/docs/registry/attributes/client.md) +- [`http.request.header.`](/docs/registry/attributes/http.md) +- [`http.request.method`](/docs/registry/attributes/http.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) +- [`url.path`](/docs/registry/attributes/url.md) +- [`url.query`](/docs/registry/attributes/url.md) +- [`url.scheme`](/docs/registry/attributes/url.md) +- [`user_agent.original`](/docs/registry/attributes/user-agent.md) --- diff --git a/docs/messaging/README.md b/docs/messaging/README.md index 9092dd76fa..aec483c38a 100644 --- a/docs/messaging/README.md +++ b/docs/messaging/README.md @@ -14,42 +14,42 @@ This document defines semantic conventions for messaging systems spans, metrics > [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/messaging/messaging-spans.md) > (or prior): > -> * SHOULD NOT change the version of the messaging conventions that they emit by default +> - SHOULD NOT change the version of the messaging conventions that they emit by default > until the messaging semantic conventions are marked stable. > Conventions include, but are not limited to, attributes, > metric and span names, span kind and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in the existing major version as a comma-separated list of category-specific values > (e.g., http, databases, messaging). The list of values includes: -> * `messaging` - emit the new, stable messaging conventions, +> - `messaging` - emit the new, stable messaging conventions, > and stop emitting the old experimental messaging conventions > that the instrumentation emitted previously. -> * `messaging/dup` - emit both the old and the stable messaging conventions, +> - `messaging/dup` - emit both the old and the stable messaging conventions, > allowing for a seamless transition. -> * The default behavior (in the absence of one of these values) is to continue +> - The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental messaging conventions > the instrumentation was emitting previously. -> * Note: `messaging/dup` has higher precedence than `messaging` in case both values are present -> * SHOULD maintain (security patching at a minimum) the existing major version +> - Note: `messaging/dup` has higher precedence than `messaging` in case both values are present +> - SHOULD maintain (security patching at a minimum) the existing major version > for at least six months after it starts emitting both sets of conventions. -> * SHOULD drop the environment variable in the next major version. -> * SHOULD emit the new, stable values for span name, span kind and similar "single" -> valued concepts when `messaging/dup` is present in the list. +> - SHOULD drop the environment variable in the next major version. +> - SHOULD emit the new, stable values for span name, span kind and similar "single" +> valued concepts when `messaging/dup` is present in the list. Semantic conventions for messaging systems are defined for the following signals: -* [Messaging Spans](messaging-spans.md): Semantic Conventions for messaging *spans*. -* [Messaging Metrics](messaging-metrics.md): Semantic Conventions for messaging *metrics*. +- [Messaging Spans](messaging-spans.md): Semantic Conventions for messaging *spans*. +- [Messaging Metrics](messaging-metrics.md): Semantic Conventions for messaging *metrics*. Technology specific semantic conventions are defined for the following messaging systems: -* [Kafka](kafka.md): Semantic Conventions for *Apache Kafka*. -* [RabbitMQ](rabbitmq.md): Semantic Conventions for *RabbitMQ*. -* [RocketMQ](rocketmq.md): Semantic Conventions for *Apache RocketMQ*. -* [SNS](sns.md): Semantic Conventions for *Amazon SNS*. -* [SQS](sqs.md): Semantic Conventions for *Amazon SQS*. -* [Google Cloud Pub/Sub](gcp-pubsub.md): Semantic Conventions for *Google Cloud Pub/Sub*. -* [Azure Service Bus](azure-messaging.md#azure-service-bus): Semantic Conventions for *Azure Service Bus*. -* [Azure Event Hubs](azure-messaging.md#azure-event-hubs): Semantic Conventions for *Azure Event Hubs*. +- [Kafka](kafka.md): Semantic Conventions for *Apache Kafka*. +- [RabbitMQ](rabbitmq.md): Semantic Conventions for *RabbitMQ*. +- [RocketMQ](rocketmq.md): Semantic Conventions for *Apache RocketMQ*. +- [SNS](sns.md): Semantic Conventions for *Amazon SNS*. +- [SQS](sqs.md): Semantic Conventions for *Amazon SQS*. +- [Google Cloud Pub/Sub](gcp-pubsub.md): Semantic Conventions for *Google Cloud Pub/Sub*. +- [Azure Service Bus](azure-messaging.md#azure-service-bus): Semantic Conventions for *Azure Service Bus*. +- [Azure Event Hubs](azure-messaging.md#azure-event-hubs): Semantic Conventions for *Azure Event Hubs*. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/messaging/azure-messaging.md b/docs/messaging/azure-messaging.md index 92291dc1b3..23366326ae 100644 --- a/docs/messaging/azure-messaging.md +++ b/docs/messaging/azure-messaging.md @@ -14,27 +14,27 @@ The Semantic Conventions for [Azure Service Bus](https://learn.microsoft.com/azu > [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/messaging/messaging-spans.md) > (or prior): > -> * SHOULD NOT change the version of the messaging conventions that they emit by default +> - SHOULD NOT change the version of the messaging conventions that they emit by default > until the messaging semantic conventions are marked stable. > Conventions include, but are not limited to, attributes, > metric and span names, span kind and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in the existing major version as a comma-separated list of category-specific values > (e.g., http, databases, messaging). The list of values includes: -> * `messaging` - emit the new, stable messaging conventions, +> - `messaging` - emit the new, stable messaging conventions, > and stop emitting the old experimental messaging conventions > that the instrumentation emitted previously. -> * `messaging/dup` - emit both the old and the stable messaging conventions, +> - `messaging/dup` - emit both the old and the stable messaging conventions, > allowing for a seamless transition. -> * The default behavior (in the absence of one of these values) is to continue +> - The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental messaging conventions > the instrumentation was emitting previously. -> * Note: `messaging/dup` has higher precedence than `messaging` in case both values are present -> * SHOULD maintain (security patching at a minimum) the existing major version +> - Note: `messaging/dup` has higher precedence than `messaging` in case both values are present +> - SHOULD maintain (security patching at a minimum) the existing major version > for at least six months after it starts emitting both sets of conventions. -> * SHOULD drop the environment variable in the next major version. -> * SHOULD emit the new, stable values for span name, span kind and similar "single" -> valued concepts when `messaging/dup` is present in the list. +> - SHOULD drop the environment variable in the next major version. +> - SHOULD emit the new, stable values for span name, span kind and similar "single" +> valued concepts when `messaging/dup` is present in the list. ## Azure Service Bus @@ -118,12 +118,12 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`messaging.destination.name`](/docs/registry/attributes/messaging.md) -* [`messaging.destination.subscription.name`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.name`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.type`](/docs/registry/attributes/messaging.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`messaging.destination.name`](/docs/registry/attributes/messaging.md) +- [`messaging.destination.subscription.name`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.name`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.type`](/docs/registry/attributes/messaging.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- @@ -239,13 +239,13 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`messaging.consumer.group.name`](/docs/registry/attributes/messaging.md) -* [`messaging.destination.name`](/docs/registry/attributes/messaging.md) -* [`messaging.destination.partition.id`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.name`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.type`](/docs/registry/attributes/messaging.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`messaging.consumer.group.name`](/docs/registry/attributes/messaging.md) +- [`messaging.destination.name`](/docs/registry/attributes/messaging.md) +- [`messaging.destination.partition.id`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.name`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.type`](/docs/registry/attributes/messaging.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/messaging/gcp-pubsub.md b/docs/messaging/gcp-pubsub.md index 9b240fec5c..851785e4e0 100644 --- a/docs/messaging/gcp-pubsub.md +++ b/docs/messaging/gcp-pubsub.md @@ -14,27 +14,27 @@ The Semantic Conventions for [Google Cloud Pub/Sub](https://cloud.google.com/pub > [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/messaging/messaging-spans.md) > (or prior): > -> * SHOULD NOT change the version of the messaging conventions that they emit by default +> - SHOULD NOT change the version of the messaging conventions that they emit by default > until the messaging semantic conventions are marked stable. > Conventions include, but are not limited to, attributes, > metric and span names, span kind and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in the existing major version as a comma-separated list of category-specific values > (e.g., http, databases, messaging). The list of values includes: -> * `messaging` - emit the new, stable messaging conventions, +> - `messaging` - emit the new, stable messaging conventions, > and stop emitting the old experimental messaging conventions > that the instrumentation emitted previously. -> * `messaging/dup` - emit both the old and the stable messaging conventions, +> - `messaging/dup` - emit both the old and the stable messaging conventions, > allowing for a seamless transition. -> * The default behavior (in the absence of one of these values) is to continue +> - The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental messaging conventions > the instrumentation was emitting previously. -> * Note: `messaging/dup` has higher precedence than `messaging` in case both values are present -> * SHOULD maintain (security patching at a minimum) the existing major version +> - Note: `messaging/dup` has higher precedence than `messaging` in case both values are present +> - SHOULD maintain (security patching at a minimum) the existing major version > for at least six months after it starts emitting both sets of conventions. -> * SHOULD drop the environment variable in the next major version. -> * SHOULD emit the new, stable values for span name, span kind and similar "single" -> valued concepts when `messaging/dup` is present in the list. +> - SHOULD drop the environment variable in the next major version. +> - SHOULD emit the new, stable values for span name, span kind and similar "single" +> valued concepts when `messaging/dup` is present in the list. `messaging.system` MUST be set to `"gcp_pubsub"` and SHOULD be provided **at span creation time**. @@ -112,12 +112,12 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`messaging.destination.name`](/docs/registry/attributes/messaging.md) -* [`messaging.destination.subscription.name`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.name`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.type`](/docs/registry/attributes/messaging.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`messaging.destination.name`](/docs/registry/attributes/messaging.md) +- [`messaging.destination.subscription.name`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.name`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.type`](/docs/registry/attributes/messaging.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/messaging/kafka.md b/docs/messaging/kafka.md index 4a3bad0f09..a4de428bee 100644 --- a/docs/messaging/kafka.md +++ b/docs/messaging/kafka.md @@ -22,27 +22,27 @@ The Semantic Conventions for [Apache Kafka](https://kafka.apache.org/) extend an > [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/messaging/messaging-spans.md) > (or prior): > -> * SHOULD NOT change the version of the messaging conventions that they emit by default +> - SHOULD NOT change the version of the messaging conventions that they emit by default > until the messaging semantic conventions are marked stable. > Conventions include, but are not limited to, attributes, > metric and span names, span kind and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in the existing major version as a comma-separated list of category-specific values > (e.g., http, databases, messaging). The list of values includes: -> * `messaging` - emit the new, stable messaging conventions, +> - `messaging` - emit the new, stable messaging conventions, > and stop emitting the old experimental messaging conventions > that the instrumentation emitted previously. -> * `messaging/dup` - emit both the old and the stable messaging conventions, +> - `messaging/dup` - emit both the old and the stable messaging conventions, > allowing for a seamless transition. -> * The default behavior (in the absence of one of these values) is to continue +> - The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental messaging conventions > the instrumentation was emitting previously. -> * Note: `messaging/dup` has higher precedence than `messaging` in case both values are present -> * SHOULD maintain (security patching at a minimum) the existing major version +> - Note: `messaging/dup` has higher precedence than `messaging` in case both values are present +> - SHOULD maintain (security patching at a minimum) the existing major version > for at least six months after it starts emitting both sets of conventions. -> * SHOULD drop the environment variable in the next major version. -> * SHOULD emit the new, stable values for span name, span kind and similar "single" -> valued concepts when `messaging/dup` is present in the list. +> - SHOULD drop the environment variable in the next major version. +> - SHOULD emit the new, stable values for span name, span kind and similar "single" +> valued concepts when `messaging/dup` is present in the list. `messaging.system` MUST be set to `"kafka"` and SHOULD be provided **at span creation time**. @@ -120,13 +120,13 @@ body size should be used. The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`messaging.consumer.group.name`](/docs/registry/attributes/messaging.md) -* [`messaging.destination.name`](/docs/registry/attributes/messaging.md) -* [`messaging.destination.partition.id`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.name`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.type`](/docs/registry/attributes/messaging.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`messaging.consumer.group.name`](/docs/registry/attributes/messaging.md) +- [`messaging.destination.name`](/docs/registry/attributes/messaging.md) +- [`messaging.destination.partition.id`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.name`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.type`](/docs/registry/attributes/messaging.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/messaging/messaging-metrics.md b/docs/messaging/messaging-metrics.md index bf9bc4ceb5..2ad549b97a 100644 --- a/docs/messaging/messaging-metrics.md +++ b/docs/messaging/messaging-metrics.md @@ -24,27 +24,27 @@ linkTitle: Metrics > [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/messaging/messaging-spans.md) > (or prior): > -> * SHOULD NOT change the version of the messaging conventions that they emit by default +> - SHOULD NOT change the version of the messaging conventions that they emit by default > until the messaging semantic conventions are marked stable. > Conventions include, but are not limited to, attributes, > metric and span names, span kind and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in the existing major version as a comma-separated list of category-specific values > (e.g., http, databases, messaging). The list of values includes: -> * `messaging` - emit the new, stable messaging conventions, +> - `messaging` - emit the new, stable messaging conventions, > and stop emitting the old experimental messaging conventions > that the instrumentation emitted previously. -> * `messaging/dup` - emit both the old and the stable messaging conventions, +> - `messaging/dup` - emit both the old and the stable messaging conventions, > allowing for a seamless transition. -> * The default behavior (in the absence of one of these values) is to continue +> - The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental messaging conventions > the instrumentation was emitting previously. -> * Note: `messaging/dup` has higher precedence than `messaging` in case both values are present -> * SHOULD maintain (security patching at a minimum) the existing major version +> - Note: `messaging/dup` has higher precedence than `messaging` in case both values are present +> - SHOULD maintain (security patching at a minimum) the existing major version > for at least six months after it starts emitting both sets of conventions. -> * SHOULD drop the environment variable in the next major version. -> * SHOULD emit the new, stable values for span name, span kind and similar "single" -> valued concepts when `messaging/dup` is present in the list. +> - SHOULD drop the environment variable in the next major version. +> - SHOULD emit the new, stable values for span name, span kind and similar "single" +> valued concepts when `messaging/dup` is present in the list. ## Common metrics diff --git a/docs/messaging/messaging-spans.md b/docs/messaging/messaging-spans.md index 3d9fb37f82..1d5eaf7ee8 100644 --- a/docs/messaging/messaging-spans.md +++ b/docs/messaging/messaging-spans.md @@ -45,27 +45,27 @@ linkTitle: Spans > [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/messaging/messaging-spans.md) > (or prior): > -> * SHOULD NOT change the version of the messaging conventions that they emit by default +> - SHOULD NOT change the version of the messaging conventions that they emit by default > until the messaging semantic conventions are marked stable. > Conventions include, but are not limited to, attributes, > metric and span names, span kind and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in the existing major version as a comma-separated list of category-specific values > (e.g., http, databases, messaging). The list of values includes: -> * `messaging` - emit the new, stable messaging conventions, +> - `messaging` - emit the new, stable messaging conventions, > and stop emitting the old experimental messaging conventions > that the instrumentation emitted previously. -> * `messaging/dup` - emit both the old and the stable messaging conventions, +> - `messaging/dup` - emit both the old and the stable messaging conventions, > allowing for a seamless transition. -> * The default behavior (in the absence of one of these values) is to continue +> - The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental messaging conventions > the instrumentation was emitting previously. -> * Note: `messaging/dup` has higher precedence than `messaging` in case both values are present -> * SHOULD maintain (security patching at a minimum) the existing major version +> - Note: `messaging/dup` has higher precedence than `messaging` in case both values are present +> - SHOULD maintain (security patching at a minimum) the existing major version > for at least six months after it starts emitting both sets of conventions. -> * SHOULD drop the environment variable in the next major version. -> * SHOULD emit the new, stable values for span name, span kind and similar "single" -> valued concepts when `messaging/dup` is present in the list. +> - SHOULD drop the environment variable in the next major version. +> - SHOULD emit the new, stable values for span name, span kind and similar "single" +> valued concepts when `messaging/dup` is present in the list. ## Definitions @@ -78,9 +78,9 @@ This envelope may offer the possibility to convey additional metadata, often in A message is sent by a message *producer* to: -* Physically: some message *broker* (which can be e.g., a single server, or a cluster, or a local process reached via IPC). The broker handles the actual delivery, re-delivery, persistence, etc. In some messaging systems the broker may be identical or co-located with (some) message consumers. +- Physically: some message *broker* (which can be e.g., a single server, or a cluster, or a local process reached via IPC). The broker handles the actual delivery, re-delivery, persistence, etc. In some messaging systems the broker may be identical or co-located with (some) message consumers. With Apache Kafka, the physical broker a message is written to depends on the number of partitions, and which broker is the *leader* of the partition the record is written to. -* Logically: some particular message *destination*. +- Logically: some particular message *destination*. Messages can be delivered to 0, 1, or multiple consumers depending on the dispatching semantic of the protocol. @@ -212,13 +212,13 @@ a specific operation, the instrumentation SHOULD omit the `{destination}`. Examples: -* `publish shop.orders` -* `send shop.orders` -* `subscribe shop.orders` -* `ack shop.orders` -* `nack print_jobs` -* `process topic with spaces` -* `settle AuthenticationRequest-Conversations` +- `publish shop.orders` +- `send shop.orders` +- `subscribe shop.orders` +- `ack shop.orders` +- `nack print_jobs` +- `process topic with spaces` +- `settle AuthenticationRequest-Conversations` ### Operation types @@ -459,16 +459,16 @@ size should be used. The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`messaging.consumer.group.name`](/docs/registry/attributes/messaging.md) -* [`messaging.destination.name`](/docs/registry/attributes/messaging.md) -* [`messaging.destination.partition.id`](/docs/registry/attributes/messaging.md) -* [`messaging.destination.subscription.name`](/docs/registry/attributes/messaging.md) -* [`messaging.destination.template`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.name`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.type`](/docs/registry/attributes/messaging.md) -* [`messaging.system`](/docs/registry/attributes/messaging.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`messaging.consumer.group.name`](/docs/registry/attributes/messaging.md) +- [`messaging.destination.name`](/docs/registry/attributes/messaging.md) +- [`messaging.destination.partition.id`](/docs/registry/attributes/messaging.md) +- [`messaging.destination.subscription.name`](/docs/registry/attributes/messaging.md) +- [`messaging.destination.template`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.name`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.type`](/docs/registry/attributes/messaging.md) +- [`messaging.system`](/docs/registry/attributes/messaging.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/messaging/rabbitmq.md b/docs/messaging/rabbitmq.md index 220bcc5278..c1a436451a 100644 --- a/docs/messaging/rabbitmq.md +++ b/docs/messaging/rabbitmq.md @@ -14,27 +14,27 @@ The Semantic Conventions for [RabbitMQ](https://www.rabbitmq.com/) extend and ov > [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/messaging/messaging-spans.md) > (or prior): > -> * SHOULD NOT change the version of the messaging conventions that they emit by default +> - SHOULD NOT change the version of the messaging conventions that they emit by default > until the messaging semantic conventions are marked stable. > Conventions include, but are not limited to, attributes, > metric and span names, span kind and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in the existing major version as a comma-separated list of category-specific values > (e.g., http, databases, messaging). The list of values includes: -> * `messaging` - emit the new, stable messaging conventions, +> - `messaging` - emit the new, stable messaging conventions, > and stop emitting the old experimental messaging conventions > that the instrumentation emitted previously. -> * `messaging/dup` - emit both the old and the stable messaging conventions, +> - `messaging/dup` - emit both the old and the stable messaging conventions, > allowing for a seamless transition. -> * The default behavior (in the absence of one of these values) is to continue +> - The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental messaging conventions > the instrumentation was emitting previously. -> * Note: `messaging/dup` has higher precedence than `messaging` in case both values are present -> * SHOULD maintain (security patching at a minimum) the existing major version +> - Note: `messaging/dup` has higher precedence than `messaging` in case both values are present +> - SHOULD maintain (security patching at a minimum) the existing major version > for at least six months after it starts emitting both sets of conventions. -> * SHOULD drop the environment variable in the next major version. -> * SHOULD emit the new, stable values for span name, span kind and similar "single" -> valued concepts when `messaging/dup` is present in the list. +> - SHOULD drop the environment variable in the next major version. +> - SHOULD emit the new, stable values for span name, span kind and similar "single" +> valued concepts when `messaging/dup` is present in the list. `messaging.system` MUST be set to `"rabbitmq"` and SHOULD be provided **at span creation time**. @@ -110,11 +110,11 @@ body size should be used. The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`messaging.destination.name`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.name`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.type`](/docs/registry/attributes/messaging.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`messaging.destination.name`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.name`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.type`](/docs/registry/attributes/messaging.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/messaging/rocketmq.md b/docs/messaging/rocketmq.md index 926f8f7c67..50afaa62f7 100644 --- a/docs/messaging/rocketmq.md +++ b/docs/messaging/rocketmq.md @@ -14,27 +14,27 @@ The Semantic Conventions for [Apache RocketMQ](https://rocketmq.apache.org/) ext > [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/messaging/messaging-spans.md) > (or prior): > -> * SHOULD NOT change the version of the messaging conventions that they emit by default +> - SHOULD NOT change the version of the messaging conventions that they emit by default > until the messaging semantic conventions are marked stable. > Conventions include, but are not limited to, attributes, > metric and span names, span kind and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in the existing major version as a comma-separated list of category-specific values > (e.g., http, databases, messaging). The list of values includes: -> * `messaging` - emit the new, stable messaging conventions, +> - `messaging` - emit the new, stable messaging conventions, > and stop emitting the old experimental messaging conventions > that the instrumentation emitted previously. -> * `messaging/dup` - emit both the old and the stable messaging conventions, +> - `messaging/dup` - emit both the old and the stable messaging conventions, > allowing for a seamless transition. -> * The default behavior (in the absence of one of these values) is to continue +> - The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental messaging conventions > the instrumentation was emitting previously. -> * Note: `messaging/dup` has higher precedence than `messaging` in case both values are present -> * SHOULD maintain (security patching at a minimum) the existing major version +> - Note: `messaging/dup` has higher precedence than `messaging` in case both values are present +> - SHOULD maintain (security patching at a minimum) the existing major version > for at least six months after it starts emitting both sets of conventions. -> * SHOULD drop the environment variable in the next major version. -> * SHOULD emit the new, stable values for span name, span kind and similar "single" -> valued concepts when `messaging/dup` is present in the list. +> - SHOULD drop the environment variable in the next major version. +> - SHOULD emit the new, stable values for span name, span kind and similar "single" +> valued concepts when `messaging/dup` is present in the list. `messaging.system` MUST be set to `"rocketmq"` and SHOULD be provided **at span creation time**. @@ -116,12 +116,12 @@ body size should be used. The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`messaging.consumer.group.name`](/docs/registry/attributes/messaging.md) -* [`messaging.destination.name`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.name`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.type`](/docs/registry/attributes/messaging.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`messaging.consumer.group.name`](/docs/registry/attributes/messaging.md) +- [`messaging.destination.name`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.name`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.type`](/docs/registry/attributes/messaging.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/messaging/sns.md b/docs/messaging/sns.md index 8290c865d8..06bc6c17fb 100644 --- a/docs/messaging/sns.md +++ b/docs/messaging/sns.md @@ -64,11 +64,11 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`messaging.destination.name`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.name`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.type`](/docs/registry/attributes/messaging.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`messaging.destination.name`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.name`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.type`](/docs/registry/attributes/messaging.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/messaging/sqs.md b/docs/messaging/sqs.md index da8964ca9b..b7aededce7 100644 --- a/docs/messaging/sqs.md +++ b/docs/messaging/sqs.md @@ -64,11 +64,11 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -* [`messaging.destination.name`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.name`](/docs/registry/attributes/messaging.md) -* [`messaging.operation.type`](/docs/registry/attributes/messaging.md) -* [`server.address`](/docs/registry/attributes/server.md) -* [`server.port`](/docs/registry/attributes/server.md) +- [`messaging.destination.name`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.name`](/docs/registry/attributes/messaging.md) +- [`messaging.operation.type`](/docs/registry/attributes/messaging.md) +- [`server.address`](/docs/registry/attributes/server.md) +- [`server.port`](/docs/registry/attributes/server.md) --- diff --git a/docs/mobile/README.md b/docs/mobile/README.md index 20b88b5a2c..090541ed62 100644 --- a/docs/mobile/README.md +++ b/docs/mobile/README.md @@ -10,6 +10,6 @@ This document defines semantic conventions for mobile platform spans, metrics an Semantic conventions for the mobile platform are defined for the following signals: -* [Mobile Events](mobile-events.md) : Semantic Conventions for mobile events in *logs*. +- [Mobile Events](mobile-events.md) : Semantic Conventions for mobile events in *logs*. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/nfs/README.md b/docs/nfs/README.md index 7299f8255f..71581587ad 100644 --- a/docs/nfs/README.md +++ b/docs/nfs/README.md @@ -8,6 +8,6 @@ linkTitle: NFS Semantic conventions for NFS are defined for the following signals: -* [NFS Metrics](nfs-metrics.md) +- [NFS Metrics](nfs-metrics.md) [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/non-normative/code-attrs-migration.md b/docs/non-normative/code-attrs-migration.md index e2541666bd..6ebc220448 100644 --- a/docs/non-normative/code-attrs-migration.md +++ b/docs/non-normative/code-attrs-migration.md @@ -40,12 +40,12 @@ to > > Examples: > -> * Java method: `com.example.MyHttpService.serveRequest` -> * Java anonymous class method: `com.mycompany.Main$1.myMethod` -> * Java lambda method: `com.mycompany.Main$$Lambda/0x0000748ae4149c00.myMethod` -> * PHP function: `GuzzleHttp\Client::transfer` -> * Go function: `github.com/my/repo/pkg.foo.func5` -> * Elixir: `OpenTelemetry.Ctx.new` -> * Erlang: `opentelemetry_ctx:new` -> * Rust: `playground::my_module::my_cool_func` -> * C function: `fopen` +> - Java method: `com.example.MyHttpService.serveRequest` +> - Java anonymous class method: `com.mycompany.Main$1.myMethod` +> - Java lambda method: `com.mycompany.Main$$Lambda/0x0000748ae4149c00.myMethod` +> - PHP function: `GuzzleHttp\Client::transfer` +> - Go function: `github.com/my/repo/pkg.foo.func5` +> - Elixir: `OpenTelemetry.Ctx.new` +> - Erlang: `opentelemetry_ctx:new` +> - Rust: `playground::my_module::my_cool_func` +> - C function: `fopen` diff --git a/docs/non-normative/groups/system/cpu-metrics-guidelines.md b/docs/non-normative/groups/system/cpu-metrics-guidelines.md index 9172a2c597..94fd1ab294 100644 --- a/docs/non-normative/groups/system/cpu-metrics-guidelines.md +++ b/docs/non-normative/groups/system/cpu-metrics-guidelines.md @@ -13,8 +13,8 @@ metrics across the different areas of the Semantic Conventions. ## Policy -* **recommended**: `*.cpu.time` -* **opt-in** (optional): `*.cpu.utilization`, `*.cpu.usage`, +- **recommended**: `*.cpu.time` +- **opt-in** (optional): `*.cpu.utilization`, `*.cpu.usage`, `*.cpu.limit_utilization`, `*.cpu.request_utilization` ## Rationale @@ -40,16 +40,16 @@ uniquely implemented in other systems like the ## Implementation Guidance -* SHOULD emit `*.cpu.time` by default for system, process container, and k8s +- SHOULD emit `*.cpu.time` by default for system, process container, and k8s resources. -* SHOULD gate `*.cpu.*utilization` and `*.cpu.usage` metrics behind explicit +- SHOULD gate `*.cpu.*utilization` and `*.cpu.usage` metrics behind explicit configuration. ## Backend Guidance -* SHOULD provide transforms or views to derive utilization/usage from +- SHOULD provide transforms or views to derive utilization/usage from `*.cpu.time` when helpful. -* SHOULD treat `*.cpu.time` as the canonical source of truth across system, +- SHOULD treat `*.cpu.time` as the canonical source of truth across system, container, and k8s resources. ## Using CPU Time diff --git a/docs/non-normative/groups/system/design-philosophy.md b/docs/non-normative/groups/system/design-philosophy.md index a5a51774f6..bee5c71be2 100644 --- a/docs/non-normative/groups/system/design-philosophy.md +++ b/docs/non-normative/groups/system/design-philosophy.md @@ -201,11 +201,11 @@ baseline level of knowledge of the concepts being instrumented**. The `brief` and `note` fields of metrics and attributes should be used to convey information that is crucial to understanding the instrumentation intention, i.e.: -* Differences in the same piece of data when it is instrumented on different +- Differences in the same piece of data when it is instrumented on different platforms -* When we recommend calculations be done on particular data rather than +- When we recommend calculations be done on particular data rather than surfacing direct values from existing tools -* When particular names or enum values were chosen when there are common +- When particular names or enum values were chosen when there are common alternate terms for the same concept For root metrics and attributes, we will strive to always have a `brief` field. diff --git a/docs/object-stores/README.md b/docs/object-stores/README.md index 0decbca90f..a21d52bb39 100644 --- a/docs/object-stores/README.md +++ b/docs/object-stores/README.md @@ -10,6 +10,6 @@ This document defines semantic conventions for object store operations. The following technology specific semantic conventions are defined for object stores: -* [AWS S3](s3.md): Semantic Conventions for *AWS S3*. +- [AWS S3](s3.md): Semantic Conventions for *AWS S3*. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/otel/README.md b/docs/otel/README.md index 209b40aebf..e649fb7f56 100644 --- a/docs/otel/README.md +++ b/docs/otel/README.md @@ -10,6 +10,6 @@ This document defines semantic conventions for telemetry emitted by the OpenTele Semantic conventions are defined for the following signals: -* [Metrics](sdk-metrics.md) +- [Metrics](sdk-metrics.md) [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/resource/README.md b/docs/resource/README.md index e7af2ada1c..a71a07a27d 100644 --- a/docs/resource/README.md +++ b/docs/resource/README.md @@ -29,10 +29,10 @@ This document defines standard attributes for resources. These attributes are ty ## TODOs -* Add more compute units: AppEngine unit, etc. -* Add Web Browser. -* Decide if lower case strings only. -* Consider to add optional/required for each attribute and combination of attributes +- Add more compute units: AppEngine unit, etc. +- Add Web Browser. +- Decide if lower case strings only. +- Consider to add optional/required for each attribute and combination of attributes (e.g when supplying a k8s resource all k8s may be required). ## Document conventions diff --git a/docs/resource/cloud-provider/README.md b/docs/resource/cloud-provider/README.md index 1525e63e33..c9003eff0f 100644 --- a/docs/resource/cloud-provider/README.md +++ b/docs/resource/cloud-provider/README.md @@ -4,8 +4,8 @@ This document defines semantic conventions for resource cloud providers. -* [AWS](aws/README.md): Semantic Conventions for Amazon Web Services. -* [GCP](gcp/README.md): Semantic Conventions for Google Cloud Platform. -* [Heroku](heroku.md): Semantic Conventions for Heroku. +- [AWS](aws/README.md): Semantic Conventions for Amazon Web Services. +- [GCP](gcp/README.md): Semantic Conventions for Google Cloud Platform. +- [Heroku](heroku.md): Semantic Conventions for Heroku. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/resource/cloudfoundry.md b/docs/resource/cloudfoundry.md index fe1c79a1b5..fb6ed15642 100644 --- a/docs/resource/cloudfoundry.md +++ b/docs/resource/cloudfoundry.md @@ -4,10 +4,10 @@ Useful resources to understand CloudFoundry metadata: -* -* -* -* +- +- +- +- CloudFoundry organizes application deployments (apps) by spaces contained in organizations (orgs). Names are unique only in their respective enclosing diff --git a/docs/resource/k8s/README.md b/docs/resource/k8s/README.md index 959b002760..25478195cb 100644 --- a/docs/resource/k8s/README.md +++ b/docs/resource/k8s/README.md @@ -4,10 +4,10 @@ Useful resources to understand Kubernetes objects and metadata: -* [Namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) -* [Names and UIDs](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/). -* [Pods](https://kubernetes.io/docs/concepts/workloads/pods/) -* [Controllers](https://kubernetes.io/docs/concepts/workloads/controllers/) +- [Namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) +- [Names and UIDs](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/). +- [Pods](https://kubernetes.io/docs/concepts/workloads/pods/) +- [Controllers](https://kubernetes.io/docs/concepts/workloads/controllers/) The "name" of a Kubernetes object is unique for that type of object within a "namespace" and only at a specific moment of time (names can be reused over diff --git a/docs/resource/process.md b/docs/resource/process.md index 14f594fa1f..5a208b4e07 100644 --- a/docs/resource/process.md +++ b/docs/resource/process.md @@ -78,11 +78,11 @@ linkTitle: Process At least one of the following attributes is required: -* [`process.executable.name`](../registry/attributes/process.md) -* [`process.executable.path`](../registry/attributes/process.md) -* [`process.command`](../registry/attributes/process.md) -* [`process.command_line`](../registry/attributes/process.md) -* [`process.command_args`](../registry/attributes/process.md) +- [`process.executable.name`](../registry/attributes/process.md) +- [`process.executable.path`](../registry/attributes/process.md) +- [`process.command`](../registry/attributes/process.md) +- [`process.command_line`](../registry/attributes/process.md) +- [`process.command_args`](../registry/attributes/process.md) Between `process.command_args` and `process.command_line`, usually `process.command_args` should be preferred. On Windows and other systems where the native format of process commands is a single string, diff --git a/docs/resource/webengine.md b/docs/resource/webengine.md index 44ba6b60b9..9aedddff42 100644 --- a/docs/resource/webengine.md +++ b/docs/resource/webengine.md @@ -35,5 +35,5 @@ A resource can be attributed to at most one web engine. The situations where there are multiple candidates, it is up to instrumentation library authors to choose the web engine. To illustrate, let's look at a Python application using Apache HTTP Server with mod_wsgi as the server and Django as the web framework. In this situation: -* Either Apache HTTP Server or `mod_wsgi` MAY be chosen as `webengine`, depending on the decision made by the instrumentation authors. -* Django SHOULD NOT be set as an `webengine` as the required information is already available in instrumentation library and setting this into `webengine` would duplicate the information. +- Either Apache HTTP Server or `mod_wsgi` MAY be chosen as `webengine`, depending on the decision made by the instrumentation authors. +- Django SHOULD NOT be set as an `webengine` as the required information is already available in instrumentation library and setting this into `webengine` would duplicate the information. diff --git a/docs/rpc/README.md b/docs/rpc/README.md index dbf0240dca..4991dae1ff 100644 --- a/docs/rpc/README.md +++ b/docs/rpc/README.md @@ -14,39 +14,39 @@ This document defines semantic conventions for remote procedure calls (RPC) > [v1.37.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.37.0/docs/rpc/README.md) > (or prior): > -> * SHOULD NOT change the version of the RPC conventions that they emit by +> - SHOULD NOT change the version of the RPC conventions that they emit by > default in their existing major version. Conventions include (but are not > limited to) attributes, metric and span names, and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in their existing major version as a comma-separated list of category-specific values > (e.g., http, databases, rpc). The list of values includes: -> * `rpc` - emit the stable RPC conventions, and stop emitting +> - `rpc` - emit the stable RPC conventions, and stop emitting > the experimental RPC conventions that the instrumentation emitted > previously. -> * `rpc/dup` - emit both the experimental and stable RPC conventions, +> - `rpc/dup` - emit both the experimental and stable RPC conventions, > allowing for a phased rollout of the stable semantic conventions. -> * The default behavior (in the absence of one of these values) is to continue +> - The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental RPC conventions > the instrumentation was emitting previously. -> * Note: `rpc/dup` has higher precedence than `rpc` in case both values are present -> * SHOULD maintain (security patching at a minimum) their existing major version +> - Note: `rpc/dup` has higher precedence than `rpc` in case both values are present +> - SHOULD maintain (security patching at a minimum) their existing major version > for at least six months after it starts emitting both sets of conventions. -> * MAY drop the environment variable in their next major version and emit only +> - MAY drop the environment variable in their next major version and emit only > the stable RPC conventions. Semantic conventions for RPC are defined for the following signals: -* [RPC Spans](rpc-spans.md): Semantic Conventions for RPC client and server *spans*. -* [RPC Metrics](rpc-metrics.md): Semantic Conventions for RPC *metrics*. +- [RPC Spans](rpc-spans.md): Semantic Conventions for RPC client and server *spans*. +- [RPC Metrics](rpc-metrics.md): Semantic Conventions for RPC *metrics*. Technology specific semantic conventions are defined for the following RPC systems: -* [Connect](connect-rpc.md): Semantic Conventions for *Connect RPC*. -* [gRPC](grpc.md): Semantic Conventions for *gRPC*. -* [JSON-RPC](json-rpc.md): Semantic Conventions for *JSON-RPC*. +- [Connect](connect-rpc.md): Semantic Conventions for *Connect RPC*. +- [gRPC](grpc.md): Semantic Conventions for *gRPC*. +- [JSON-RPC](json-rpc.md): Semantic Conventions for *JSON-RPC*. Specifications defined by maintainers of RPC systems: -* [gRPC](https://github.com/grpc/proposal/blob/master/A66-otel-stats.md): Semantic Conventions for *gRPC*. +- [gRPC](https://github.com/grpc/proposal/blob/master/A66-otel-stats.md): Semantic Conventions for *gRPC*. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/rpc/rpc-metrics.md b/docs/rpc/rpc-metrics.md index 97932e6b7d..41625e5800 100644 --- a/docs/rpc/rpc-metrics.md +++ b/docs/rpc/rpc-metrics.md @@ -32,24 +32,24 @@ metrics can be filtered for finer grain analysis. > [v1.37.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.37.0/docs/rpc/rpc-metrics.md) > (or prior): > -> * SHOULD NOT change the version of the RPC conventions that they emit by +> - SHOULD NOT change the version of the RPC conventions that they emit by > default in their existing major version. Conventions include (but are not > limited to) attributes, metric and span names, and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in their existing major version as a comma-separated list of category-specific values > (e.g., http, databases, rpc). The list of values includes: -> * `rpc` - emit the stable RPC conventions, and stop emitting +> - `rpc` - emit the stable RPC conventions, and stop emitting > the experimental RPC conventions that the instrumentation emitted > previously. -> * `rpc/dup` - emit both the experimental and stable RPC conventions, +> - `rpc/dup` - emit both the experimental and stable RPC conventions, > allowing for a phased rollout of the stable semantic conventions. -> * The default behavior (in the absence of one of these values) is to continue +> - The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental RPC conventions > the instrumentation was emitting previously. -> * Note: `rpc/dup` has higher precedence than `rpc` in case both values are present -> * SHOULD maintain (security patching at a minimum) their existing major version +> - Note: `rpc/dup` has higher precedence than `rpc` in case both values are present +> - SHOULD maintain (security patching at a minimum) their existing major version > for at least six months after it starts emitting both sets of conventions. -> * MAY drop the environment variable in their next major version and emit only +> - MAY drop the environment variable in their next major version and emit only > the stable RPC conventions. ## Metric instruments @@ -672,13 +672,13 @@ different processes could be listening on TCP port 12345 and UDP port 12345. More specific Semantic Conventions are defined for the following RPC technologies: -* [Connect](connect-rpc.md): Semantic Conventions for *Connect RPC*. -* [gRPC](grpc.md): Semantic Conventions for *gRPC*. -* [JSON-RPC](json-rpc.md): Semantic Conventions for *JSON-RPC*. +- [Connect](connect-rpc.md): Semantic Conventions for *Connect RPC*. +- [gRPC](grpc.md): Semantic Conventions for *gRPC*. +- [JSON-RPC](json-rpc.md): Semantic Conventions for *JSON-RPC*. Specifications defined by maintainers of RPC systems: -* [gRPC](https://github.com/grpc/proposal/blob/master/A66-otel-stats.md): Semantic Conventions for *gRPC*. +- [gRPC](https://github.com/grpc/proposal/blob/master/A66-otel-stats.md): Semantic Conventions for *gRPC*. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status [MetricRecommended]: /docs/general/metric-requirement-level.md#recommended diff --git a/docs/rpc/rpc-spans.md b/docs/rpc/rpc-spans.md index 04b6e7a4a9..7b3ae0a00f 100644 --- a/docs/rpc/rpc-spans.md +++ b/docs/rpc/rpc-spans.md @@ -28,24 +28,24 @@ This document defines how to describe remote procedure calls > [v1.37.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.37.0/docs/rpc/rpc-spans.md) > (or prior): > -> * SHOULD NOT change the version of the RPC conventions that they emit by +> - SHOULD NOT change the version of the RPC conventions that they emit by > default in their existing major version. Conventions include (but are not > limited to) attributes, metric and span names, and unit of measure. -> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` +> - SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in their existing major version as a comma-separated list of category-specific values > (e.g., http, databases, rpc). The list of values includes: -> * `rpc` - emit the stable RPC conventions, and stop emitting +> - `rpc` - emit the stable RPC conventions, and stop emitting > the experimental RPC conventions that the instrumentation emitted > previously. -> * `rpc/dup` - emit both the experimental and stable RPC conventions, +> - `rpc/dup` - emit both the experimental and stable RPC conventions, > allowing for a phased rollout of the stable semantic conventions. -> * The default behavior (in the absence of one of these values) is to continue +> - The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental RPC conventions > the instrumentation was emitting previously. -> * Note: `rpc/dup` has higher precedence than `rpc` in case both values are present -> * SHOULD maintain (security patching at a minimum) their existing major version +> - Note: `rpc/dup` has higher precedence than `rpc` in case both values are present +> - SHOULD maintain (security patching at a minimum) their existing major version > for at least six months after it starts emitting both sets of conventions. -> * MAY drop the environment variable in their next major version and emit only +> - MAY drop the environment variable in their next major version and emit only > the stable RPC conventions. ## Common remote procedure call conventions @@ -363,8 +363,8 @@ Note that *method* in this context is about the called remote procedure and *not More specific Semantic Conventions are defined for the following RPC technologies: -* [Connect](connect-rpc.md): Semantic Conventions for *Connect RPC*. -* [gRPC](grpc.md): Semantic Conventions for *gRPC*. -* [JSON-RPC](json-rpc.md): Semantic Conventions for *JSON-RPC*. +- [Connect](connect-rpc.md): Semantic Conventions for *Connect RPC*. +- [gRPC](grpc.md): Semantic Conventions for *gRPC*. +- [JSON-RPC](json-rpc.md): Semantic Conventions for *JSON-RPC*. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/runtime/jvm-metrics.md b/docs/runtime/jvm-metrics.md index fc0c549f27..d1075fd2cd 100644 --- a/docs/runtime/jvm-metrics.md +++ b/docs/runtime/jvm-metrics.md @@ -242,10 +242,10 @@ of `[ 0.01, 0.1, 1, 10 ]`. This metric is [recommended][MetricRecommended]. This metric is obtained from a combination of -* [`ThreadMXBean#getAllThreadIds()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/ThreadMXBean.html#getAllThreadIds--) -* [`ThreadMXBean#getThreadInfo()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/ThreadMXBean.html#getThreadInfo-long:A-) -* [`ThreadInfo#getThreadState()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/ThreadInfo.html#getThreadState--) -* [`ThreadInfo#isDaemon()`](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/ThreadInfo.html#isDaemon()) (requires Java 9+) +- [`ThreadMXBean#getAllThreadIds()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/ThreadMXBean.html#getAllThreadIds--) +- [`ThreadMXBean#getThreadInfo()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/ThreadMXBean.html#getThreadInfo-long:A-) +- [`ThreadInfo#getThreadState()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/ThreadInfo.html#getThreadState--) +- [`ThreadInfo#isDaemon()`](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/ThreadInfo.html#isDaemon()) (requires Java 9+) Note that this is the number of platform threads (as opposed to virtual threads). diff --git a/docs/system/README.md b/docs/system/README.md index 8cc7e0647d..33f645cfdf 100644 --- a/docs/system/README.md +++ b/docs/system/README.md @@ -10,11 +10,11 @@ This document defines semantic conventions for systems (such as processes, runti System semantic conventions are defined for the following metrics: -* [System](system-metrics.md): For standard system metrics. -* [Container](container-metrics.md): For container-related metrics. -* [K8s](k8s-metrics.md): For K8s-related metrics. -* [Hardware](../hardware/README.md): For hardware-related metrics. -* [Process](process-metrics.md): For standard process metrics. -* [Runtime Environment](/docs/runtime/README.md#metrics): For runtime environment metrics. +- [System](system-metrics.md): For standard system metrics. +- [Container](container-metrics.md): For container-related metrics. +- [K8s](k8s-metrics.md): For K8s-related metrics. +- [Hardware](../hardware/README.md): For hardware-related metrics. +- [Process](process-metrics.md): For standard process metrics. +- [Runtime Environment](/docs/runtime/README.md#metrics): For runtime environment metrics. [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status diff --git a/docs/system/process-metrics.md b/docs/system/process-metrics.md index 3c5ec06b47..24ecb351be 100644 --- a/docs/system/process-metrics.md +++ b/docs/system/process-metrics.md @@ -36,10 +36,10 @@ metrics](/docs/runtime/README.md#metrics). > [v1.21.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.21.0/docs/system/process-metrics.md) > (or prior): > -> * SHOULD NOT adopt any breaking changes from document until the system +> - SHOULD NOT adopt any breaking changes from document until the system > semantic conventions are marked stable. Conventions include, but are not > limited to, attributes, metric names, and unit of measure. -> * SHOULD introduce a control mechanism to allow users to opt-in to the new +> - SHOULD introduce a control mechanism to allow users to opt-in to the new > conventions once the migration plan is finalized. ## Process metrics diff --git a/docs/system/system-metrics.md b/docs/system/system-metrics.md index 2c52948dc7..c316359ac7 100644 --- a/docs/system/system-metrics.md +++ b/docs/system/system-metrics.md @@ -67,10 +67,10 @@ Resource attributes related to a host, SHOULD be reported under the `host.*` nam > [v1.21.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.21.0/docs/system/system-metrics.md) > (or prior): > -> * SHOULD NOT adopt any breaking changes from document until the system +> - SHOULD NOT adopt any breaking changes from document until the system > semantic conventions are marked stable. Conventions include, but are not > limited to, attributes, metric names, and unit of measure. -> * SHOULD introduce a control mechanism to allow users to opt-in to the new +> - SHOULD introduce a control mechanism to allow users to opt-in to the new > conventions once the migration plan is finalized. ## General metrics diff --git a/docs/url/README.md b/docs/url/README.md index 2da0df6d9e..8a5ef50742 100644 --- a/docs/url/README.md +++ b/docs/url/README.md @@ -8,7 +8,7 @@ linkTitle: URL This document defines semantic conventions for url. -* [Attributes](../registry/attributes/url.md) +- [Attributes](../registry/attributes/url.md) ## Sensitive information diff --git a/model/README.md b/model/README.md index 3f0a18685f..88375824dd 100644 --- a/model/README.md +++ b/model/README.md @@ -55,7 +55,7 @@ make check-policies See also: -* [Markdown Templates](../templates/registry/markdown) -* [Weaver Template Documentation](https://github.com/open-telemetry/weaver/blob/main/crates/weaver_forge/README.md) -* [Weaver Usage Documentation](https://github.com/open-telemetry/weaver/blob/main/docs/usage.md#registry-generate) -* [Code Generator Documentation](../docs/non-normative/code-generation.md) +- [Markdown Templates](../templates/registry/markdown) +- [Weaver Template Documentation](https://github.com/open-telemetry/weaver/blob/main/crates/weaver_forge/README.md) +- [Weaver Usage Documentation](https://github.com/open-telemetry/weaver/blob/main/docs/usage.md#registry-generate) +- [Code Generator Documentation](../docs/non-normative/code-generation.md) diff --git a/templates/registry/markdown/sampling_macros.j2 b/templates/registry/markdown/sampling_macros.j2 index 07929e7d41..a2cbda1053 100644 --- a/templates/registry/markdown/sampling_macros.j2 +++ b/templates/registry/markdown/sampling_macros.j2 @@ -3,5 +3,5 @@ The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): -{% for attribute in sampling_attributes | sort(attribute="name") %}* {{ attrs.name_with_link(attribute, attribute_registry_base_url, lineage_attributes) }} +{% for attribute in sampling_attributes | sort(attribute="name") %}- {{ attrs.name_with_link(attribute, attribute_registry_base_url, lineage_attributes) }} {% endfor %}{% endif %}{% endmacro %}