Merge branch 'main' into add_k8s_resources

.github/workflows/auto-update-spec-repo-links.yml

@@ -22,7 +22,7 @@ jobs:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           current_version=$(grep "PREVIOUS_SPECIFICATION_VERSION=v.*" \
-                                 internal/tools/update_specification_version.sh \
+                                 .github/scripts/update-spec-repo-links.sh \
                             | sed "s/PREVIOUS_SPECIFICATION_VERSION=//")
           latest_version=$(gh release view \
                                --repo open-telemetry/opentelemetry-specification \
@@ -75,7 +75,6 @@ jobs:
           git checkout -b $branch
           git commit -a -m "$message"
           git push --set-upstream origin $branch
-          gh pr create --title "$message" \
+          gh pr create --title "[chore] $message" \
                        --body "$body" \
-                       --label "Skip Changelog" \
                        --base main

.github/workflows/changelog.yml

@@ -6,7 +6,7 @@ name: 'Changelog'
 
 on:
   pull_request:
-    types: [opened, ready_for_review, synchronize, reopened, labeled, unlabeled]
+    types: [opened, ready_for_review, edited, synchronize, reopened, labeled, unlabeled]
     branches:
       - main
 

docs/README.md

@@ -1,5 +1,4 @@
 <!--- Hugo front matter used to generate the website version of this page:
-linkTitle: Semantic Conventions
 cascade:
   body_class: otel-docs-spec
   github_repo: &repo https://github.com/open-telemetry/semantic-conventions
@@ -8,12 +7,13 @@ cascade:
   github_project_repo: *repo
 cSpell:ignore: semconv CICD
 auto_gen: below
+linkTitle: Semantic conventions
 path_base_for_github_subdir:
   from: tmp/semconv/docs/_index.md
   to: README.md
 --->
 
-# OpenTelemetry Semantic Conventions
+# OpenTelemetry semantic conventions
 
 The Semantic Conventions define a common set of (semantic) attributes which provide meaning to data when collecting, producing and consuming it.
 The Semantic Conventions specify among other things span names and kind, metric instruments and units as well as attribute names, types, meaning and valid values. For a detailed definition of the Semantic Conventions' scope see [Semantic Conventions Stability](https://opentelemetry.io/docs/specs/otel/versioning-and-stability/#semantic-conventions-stability).

docs/attributes-registry/README.md

@@ -10,7 +10,7 @@ path_base_for_github_subdir:
 <!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/readme.md.j2 -->
 
-# Attribute Registry
+# Attribute registry
 
 The attributes registry is the place where attributes are defined. An attribute definition covers the following properties of an attribute:
 

docs/attributes-registry/db.md

@@ -55,9 +55,9 @@ system specific term if more applicable.
 If `db.query.text` is also captured, then `db.operation.parameter.<key>` SHOULD match up with the parameterized placeholders present in `db.query.text`.
 
 **[6] `db.query.summary`:** `db.query.summary` provides static summary of the query text. It describes a class of database queries and is useful as a grouping key, especially when analyzing telemetry for database calls involving complex queries.
-Summary may be available to the instrumentation through instrumentation hooks or other means. If it is not available, instrumentations that support query parsing SHOULD generate a summary following [Generating query summary](../../docs/database/database-spans.md#generating-a-summary-of-the-query-text) section.
+Summary may be available to the instrumentation through instrumentation hooks or other means. If it is not available, instrumentations that support query parsing SHOULD generate a summary following [Generating query summary](../database/database-spans.md#generating-a-summary-of-the-query-text) section.
 
-**[7] `db.query.text`:** For sanitization see [Sanitization of `db.query.text`](../../docs/database/database-spans.md#sanitization-of-dbquerytext).
+**[7] `db.query.text`:** For sanitization see [Sanitization of `db.query.text`](../database/database-spans.md#sanitization-of-dbquerytext).
 For batch operations, if the individual operations are known to have the same query text then that query text SHOULD be used, otherwise all of the individual query texts SHOULD be concatenated with separator `; ` or some other database system specific separator if more applicable.
 Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk.
 

docs/attributes-registry/feature-flag.md

@@ -1,7 +1,7 @@
 <!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
 
-# Feature Flag
+# Feature flag
 
 ## Feature Flag Attributes
 

docs/attributes-registry/security-rule.md

@@ -1,7 +1,7 @@
 <!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
 
-# Security Rule
+# Security rule
 
 ## Security Rule
 

docs/attributes-registry/user-agent.md

@@ -1,7 +1,7 @@
 <!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
 
-# User Agent
+# User agent
 
 ## User-agent Attributes
 

docs/azure/README.md

@@ -5,7 +5,7 @@ path_base_for_github_subdir:
   to: azure/README.md
 --->
 
-# Semantic Conventions for Azure Resource Logs
+# Semantic conventions for Azure resource logs
 
 **Status**: [Experimental][DocumentStatus]
 

docs/azure/events.md

@@ -2,7 +2,7 @@
 linkTitle: Events
 --->
 
-# Semantic Conventions for Azure Resource Log Events
+# Semantic conventions for Azure resource log events
 
 **Status**: [Experimental][DocumentStatus]
 

docs/cicd/cicd-metrics.md

@@ -2,12 +2,10 @@
 linkTitle: CICD
 --->
 
-# Semantic Conventions for CICD Metrics
+# Semantic conventions for CICD metrics
 
 **Status**: [Experimental][DocumentStatus]
 
-<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->
-
 <!-- toc -->
 
 - [CICD Metrics](#cicd-metrics)

docs/cli/cli-spans.md

@@ -2,7 +2,7 @@
 linkTitle: CLI programs
 --->
 
-# Semantic Conventions for CLI (Command Line Interface) Programs
+# Semantic conventions for CLI (command line interface) programs
 
 **Status**: [Experimental][DocumentStatus]
 

docs/cloud-providers/README.md

@@ -5,7 +5,7 @@ path_base_for_github_subdir:
   to: cloud-providers/README.md
 --->
 
-# Semantic Conventions for Cloud Providers
+# Semantic conventions for cloud providers
 
 **Status**: [Experimental][DocumentStatus]
 

docs/cloud-providers/aws-sdk.md

@@ -2,7 +2,7 @@
 linkTitle: AWS SDK
 --->
 
-# Semantic Conventions for AWS SDK
+# Semantic conventions for AWS SDK
 
 **Status**: [Experimental][DocumentStatus]
 

docs/cloudevents/README.md

@@ -5,7 +5,7 @@ path_base_for_github_subdir:
   to: cloudevents/README.md
 --->
 
-# Semantic Conventions for CloudEvents
+# Semantic conventions for CloudEvents
 
 **Status**: [Experimental][DocumentStatus]
 

docs/cloudevents/cloudevents-spans.md

@@ -2,7 +2,7 @@
 linkTitle: CloudEvents spans
 --->
 
-# Semantic Conventions for CloudEvents Spans
+# Semantic conventions for CloudEvents spans
 
 **Status**: [Experimental][DocumentStatus]
 

docs/code/README.md

@@ -5,7 +5,7 @@ path_base_for_github_subdir:
   to: code/README.md
 --->
 
-# Semantic Conventions for Code
+# Semantic conventions for code
 
 **Status**: [Experimental][DocumentStatus]
 

docs/database/README.md

@@ -5,7 +5,7 @@ path_base_for_github_subdir:
   to: database/README.md
 --->
 
-# Semantic Conventions for Database Calls and Systems
+# Semantic conventions for database calls and systems
 
 **Status**: [Mixed][DocumentStatus]
 

docs/database/cassandra.md

@@ -2,7 +2,7 @@
 linkTitle: Cassandra
 --->
 
-# Semantic Conventions for Cassandra
+# Semantic conventions for Cassandra
 
 **Status**: [Experimental][DocumentStatus]
 
@@ -95,16 +95,16 @@ Instrumentations SHOULD document how `error.type` is populated.
 **[11] `db.operation.batch.size`:** Operations are only considered batches when they contain two or more operations, and so `db.operation.batch.size` SHOULD never be `1`.
 
 **[12] `db.query.summary`:** `db.query.summary` provides static summary of the query text. It describes a class of database queries and is useful as a grouping key, especially when analyzing telemetry for database calls involving complex queries.
-Summary may be available to the instrumentation through instrumentation hooks or other means. If it is not available, instrumentations that support query parsing SHOULD generate a summary following [Generating query summary](../../docs/database/database-spans.md#generating-a-summary-of-the-query-text) section.
+Summary may be available to the instrumentation through instrumentation hooks or other means. If it is not available, instrumentations that support query parsing SHOULD generate a summary following [Generating query summary](../database/database-spans.md#generating-a-summary-of-the-query-text) section.
 
 **[13] `db.query.summary`:** if readily available or if instrumentation supports query summarization.
 
-**[14] `db.query.text`:** For sanitization see [Sanitization of `db.query.text`](../../docs/database/database-spans.md#sanitization-of-dbquerytext).
+**[14] `db.query.text`:** For sanitization see [Sanitization of `db.query.text`](../database/database-spans.md#sanitization-of-dbquerytext).
 For batch operations, if the individual operations are known to have the same query text then that query text SHOULD be used, otherwise all of the individual query texts SHOULD be concatenated with separator `; ` or some other database system specific separator if more applicable.
 Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk.
 
-**[15] `db.query.text`:** Non-parameterized query text SHOULD NOT be collected by default unless there is sanitization that excludes sensitive data, e.g. by redacting all literal values present in the query text. See [Sanitization of `db.query.text`](../../docs/database/database-spans.md#sanitization-of-dbquerytext).
-Parameterized query text SHOULD be collected by default (the query parameter values themselves are opt-in, see [`db.operation.parameter.<key>`](../../docs/attributes-registry/db.md)).
+**[15] `db.query.text`:** Non-parameterized query text SHOULD NOT be collected by default unless there is sanitization that excludes sensitive data, e.g. by redacting all literal values present in the query text. See [Sanitization of `db.query.text`](../database/database-spans.md#sanitization-of-dbquerytext).
+Parameterized query text SHOULD be collected by default (the query parameter values themselves are opt-in, see [`db.operation.parameter.<key>`](../attributes-registry/db.md)).
 
 **[16] `network.peer.address`:** If a database operation involved multiple network calls (for example retries), the address of the last contacted node SHOULD be used.
 

docs/database/cosmosdb.md

@@ -2,12 +2,10 @@
 linkTitle: Cosmos DB
 --->
 
-# Semantic Conventions for Microsoft Azure Cosmos DB
+# Semantic conventions for Microsoft Azure Cosmos DB
 
 **Status**: [Experimental][DocumentStatus]
 
-<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->
-
 <!-- toc -->
 
 - [Spans](#spans)
@@ -209,16 +207,16 @@ Instrumentations SHOULD document how `error.type` is populated.
 **[10] `db.operation.batch.size`:** Operations are only considered batches when they contain two or more operations, and so `db.operation.batch.size` SHOULD never be `1`.
 
 **[11] `db.query.summary`:** `db.query.summary` provides static summary of the query text. It describes a class of database queries and is useful as a grouping key, especially when analyzing telemetry for database calls involving complex queries.
-Summary may be available to the instrumentation through instrumentation hooks or other means. If it is not available, instrumentations that support query parsing SHOULD generate a summary following [Generating query summary](../../docs/database/database-spans.md#generating-a-summary-of-the-query-text) section.
+Summary may be available to the instrumentation through instrumentation hooks or other means. If it is not available, instrumentations that support query parsing SHOULD generate a summary following [Generating query summary](../database/database-spans.md#generating-a-summary-of-the-query-text) section.
 
 **[12] `db.query.summary`:** if readily available or if instrumentation supports query summarization.
 
-**[13] `db.query.text`:** For sanitization see [Sanitization of `db.query.text`](../../docs/database/database-spans.md#sanitization-of-dbquerytext).
+**[13] `db.query.text`:** For sanitization see [Sanitization of `db.query.text`](../database/database-spans.md#sanitization-of-dbquerytext).
 For batch operations, if the individual operations are known to have the same query text then that query text SHOULD be used, otherwise all of the individual query texts SHOULD be concatenated with separator `; ` or some other database system specific separator if more applicable.
 Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk.
 
-**[14] `db.query.text`:** Non-parameterized query text SHOULD NOT be collected by default unless there is sanitization that excludes sensitive data, e.g. by redacting all literal values present in the query text. See [Sanitization of `db.query.text`](../../docs/database/database-spans.md#sanitization-of-dbquerytext).
-Parameterized query text SHOULD be collected by default (the query parameter values themselves are opt-in, see [`db.operation.parameter.<key>`](../../docs/attributes-registry/db.md)).
+**[14] `db.query.text`:** Non-parameterized query text SHOULD NOT be collected by default unless there is sanitization that excludes sensitive data, e.g. by redacting all literal values present in the query text. See [Sanitization of `db.query.text`](../database/database-spans.md#sanitization-of-dbquerytext).
+Parameterized query text SHOULD be collected by default (the query parameter values themselves are opt-in, see [`db.operation.parameter.<key>`](../attributes-registry/db.md)).
 
 **[15] `server.address`:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available.
 

docs/database/couchdb.md

@@ -2,7 +2,7 @@
 linkTitle: CouchDB
 --->
 
-# Semantic Conventions for CouchDB
+# Semantic conventions for CouchDB
 
 **Status**: [Experimental][DocumentStatus]
 

docs/database/database-metrics.md

@@ -2,12 +2,10 @@
 linkTitle: Metrics
 --->
 
-# Semantic Conventions for Database Client Metrics
+# Semantic conventions for database client metrics
 
 **Status**: [Mixed][DocumentStatus]
 
-<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->
-
 <!-- toc -->
 
 - [Database operation](#database-operation)
@@ -139,7 +137,7 @@ Instrumentations SHOULD document how `error.type` is populated.
 **[11] `server.port`:** If using a port other than the default port for this DBMS and if `server.address` is set.
 
 **[12] `db.query.summary`:** `db.query.summary` provides static summary of the query text. It describes a class of database queries and is useful as a grouping key, especially when analyzing telemetry for database calls involving complex queries.
-Summary may be available to the instrumentation through instrumentation hooks or other means. If it is not available, instrumentations that support query parsing SHOULD generate a summary following [Generating query summary](../../docs/database/database-spans.md#generating-a-summary-of-the-query-text) section.
+Summary may be available to the instrumentation through instrumentation hooks or other means. If it is not available, instrumentations that support query parsing SHOULD generate a summary following [Generating query summary](../database/database-spans.md#generating-a-summary-of-the-query-text) section.
 
 **[13] `db.query.summary`:** if readily available or if instrumentation supports query summarization.
 
@@ -148,7 +146,7 @@ If a database operation involved multiple network calls (for example retries), t
 
 **[15] `server.address`:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available.
 
-**[16] `db.query.text`:** For sanitization see [Sanitization of `db.query.text`](../../docs/database/database-spans.md#sanitization-of-dbquerytext).
+**[16] `db.query.text`:** For sanitization see [Sanitization of `db.query.text`](../database/database-spans.md#sanitization-of-dbquerytext).
 For batch operations, if the individual operations are known to have the same query text then that query text SHOULD be used, otherwise all of the individual query texts SHOULD be concatenated with separator `; ` or some other database system specific separator if more applicable.
 Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk.
 
@@ -303,7 +301,7 @@ Instrumentations SHOULD document how `error.type` is populated.
 **[11] `server.port`:** If using a port other than the default port for this DBMS and if `server.address` is set.
 
 **[12] `db.query.summary`:** `db.query.summary` provides static summary of the query text. It describes a class of database queries and is useful as a grouping key, especially when analyzing telemetry for database calls involving complex queries.
-Summary may be available to the instrumentation through instrumentation hooks or other means. If it is not available, instrumentations that support query parsing SHOULD generate a summary following [Generating query summary](../../docs/database/database-spans.md#generating-a-summary-of-the-query-text) section.
+Summary may be available to the instrumentation through instrumentation hooks or other means. If it is not available, instrumentations that support query parsing SHOULD generate a summary following [Generating query summary](../database/database-spans.md#generating-a-summary-of-the-query-text) section.
 
 **[13] `db.query.summary`:** if readily available or if instrumentation supports query summarization.
 
@@ -312,7 +310,7 @@ If a database operation involved multiple network calls (for example retries), t
 
 **[15] `server.address`:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available.
 
-**[16] `db.query.text`:** For sanitization see [Sanitization of `db.query.text`](../../docs/database/database-spans.md#sanitization-of-dbquerytext).
+**[16] `db.query.text`:** For sanitization see [Sanitization of `db.query.text`](../database/database-spans.md#sanitization-of-dbquerytext).
 For batch operations, if the individual operations are known to have the same query text then that query text SHOULD be used, otherwise all of the individual query texts SHOULD be concatenated with separator `; ` or some other database system specific separator if more applicable.
 Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk.