Merge branch 'main' into add_cpu_state_constraint

ChrsMark · Mar 11, 2024 · ca70568 · ca70568
2 parents e1b11b6 + c8b6163
commit ca70568
Show file tree

Hide file tree

Showing 139 changed files with 1,673 additions and 785 deletions.
diff --git a/.chloggen/697.yaml b/.chloggen/697.yaml
@@ -0,0 +1,7 @@
+change_type: enhancement
+
+component: messaging
+
+note: Clarifies span names for Azure messaging systems and adds `messaging.servicebus.disposition_status attribute`.
+
+issues: [697]
diff --git a/.chloggen/700.yaml b/.chloggen/700.yaml
@@ -0,0 +1,22 @@
+# Use this changelog template to create an entry for release notes.
+#
+# If your change doesn't affect end users you should instead start
+# your pull request title with [chore] or use the "Skip Changelog" label.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
+component: messaging
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add a "Process" spans and metrics for messaging
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+# The values here must be integers.
+issues: [657]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
diff --git a/.chloggen/769.yaml b/.chloggen/769.yaml
@@ -0,0 +1,4 @@
+change_type: deprecation
+component: db
+note: Deprecate `db.connection_string` attribute in favor of `server.address` and `server.port`
+issues: [724, 769]
diff --git a/.chloggen/778.yaml b/.chloggen/778.yaml
@@ -0,0 +1,22 @@
+# Use this changelog template to create an entry for release notes.
+#
+# If your change doesn't affect end users you should instead start
+# your pull request title with [chore] or use the "Skip Changelog" label.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: bug_fix
+
+# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
+component: aws-lambda
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Fix problem in `xray-lambda` propagator definition
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+# The values here must be integers.
+issues: [778]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
diff --git a/.chloggen/780.yaml b/.chloggen/780.yaml
@@ -0,0 +1,4 @@
+change_type: enhancement
+component: db
+note: Merge DB connection-level and call-level attributes tables
+issues: [780]
diff --git a/.chloggen/785.yaml b/.chloggen/785.yaml
@@ -0,0 +1,4 @@
+change_type: enhancement
+component: dns
+note: Introduces common DNS lookup duration metric and attributes.
+issues: [404]
diff --git a/.chloggen/796.yaml b/.chloggen/796.yaml
@@ -0,0 +1,4 @@
+change_type: deprecation
+component: db
+note: Deprecate `db.jdbc.driver_classname` attribute
+issues: [796]
diff --git a/.chloggen/allow-sanitizing-url-path.yaml b/.chloggen/allow-sanitizing-url-path.yaml
@@ -0,0 +1,22 @@
+# Use this changelog template to create an entry for release notes.
+#
+# If your change doesn't affect end users you should instead start
+# your pull request title with [chore] or use the "Skip Changelog" label.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
+component: url
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Sensitive content provided in `url.full`, `url.path`, and `url.query` SHOULD be scrubbed when instrumentations can identify it.
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+# The values here must be integers.
+issues: [676]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
diff --git a/.chloggen/clarify-metric-namespace.yaml b/.chloggen/clarify-metric-namespace.yaml
@@ -0,0 +1,5 @@
+change_type: 'enhancement'
+component: metrics
+note: Clarify metric attributes should be namespaced.
+issues: [394]
+subtext:
diff --git a/.chloggen/service-instance-id.yaml b/.chloggen/service-instance-id.yaml
@@ -0,0 +1,4 @@
+change_type: 'enhancement'
+component: resource
+note: Define a common algorithm for `service.instance.id`.
+issues: [312]
diff --git a/.github/workflows/stale-pr.yml b/.github/workflows/stale-pr.yml
@@ -14,5 +14,9 @@ jobs:
           close-pr-message: 'Closed as inactive. Feel free to reopen if this PR is still being worked on.'
           exempt-pr-labels: 'bug,work in progress,experts needed'
           exempt-draft-pr: true
+          # opt out of defaults to avoid marking issues as stale
+          days-before-stale: -1
+          days-before-close: -1
+          # overrides the above only for pull requests
           days-before-pr-stale: 15
           days-before-pr-close: 7
diff --git a/.prettierignore b/.prettierignore
@@ -1,4 +1,5 @@
 /.github
+/.chloggen
 
 # for the first iteration, we only reformat /docs/cloud* and will add the rest in individual PRs
 /docs/**

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -13,23 +13,23 @@ requirements and recommendations.
 
 - [Sign the CLA](#sign-the-cla)
 - [How to Contribute](#how-to-contribute)
-  * [Prerequisites](#prerequisites)
-  * [1. Modify the YAML model](#1-modify-the-yaml-model)
-    + [Schema files](#schema-files)
-  * [2. Update the markdown files](#2-update-the-markdown-files)
-    + [Hugo frontmatter](#hugo-frontmatter)
-  * [3. Verify the changes before committing](#3-verify-the-changes-before-committing)
-  * [4. Changelog](#4-changelog)
-    + [When to add a Changelog Entry](#when-to-add-a-changelog-entry)
+  - [Prerequisites](#prerequisites)
+  - [1. Modify the YAML model](#1-modify-the-yaml-model)
+    - [Schema files](#schema-files)
+  - [2. Update the markdown files](#2-update-the-markdown-files)
+    - [Hugo frontmatter](#hugo-frontmatter)
+  - [3. Verify the changes before committing](#3-verify-the-changes-before-committing)
+  - [4. Changelog](#4-changelog)
+    - [When to add a Changelog Entry](#when-to-add-a-changelog-entry)
       - [Examples](#examples)
-    + [Adding a Changelog Entry](#adding-a-changelog-entry)
-  * [5. Getting your PR merged](#5-getting-your-pr-merged)
+    - [Adding a Changelog Entry](#adding-a-changelog-entry)
+  - [5. Getting your PR merged](#5-getting-your-pr-merged)
 - [Automation](#automation)
-  * [Consistency Checks](#consistency-checks)
-  * [Auto formatting](#auto-formatting)
-  * [Markdown style](#markdown-style)
-  * [Misspell check](#misspell-check)
-  * [Markdown link check](#markdown-link-check)
+  - [Consistency Checks](#consistency-checks)
+  - [Auto formatting](#auto-formatting)
+  - [Markdown style](#markdown-style)
+  - [Misspell check](#misspell-check)
+  - [Markdown link check](#markdown-link-check)
 - [Updating the referenced specification version](#updating-the-referenced-specification-version)
 - [Making a Release](#making-a-release)
 - [Merging existing ECS conventions](#merging-existing-ecs-conventions)
@@ -320,7 +320,7 @@ make markdown-link-check
     - Add `next` as a version in `schema-next.yaml` version.
   - Run `make chlog-update VERSION=v{version}`
     - `make chlog-update` will clean up all the current `.yaml` files inside the
-    `.chloggen` folder automatically
+      `.chloggen` folder automatically
     - Double check that `CONTRIBUTING.md` is updated with the proper `v{version}`
   - Send staging tag as PR for review.
 - Create a tag `v{version}` on the merged PR and push remote.

diff --git a/Makefile b/Makefile
@@ -62,7 +62,7 @@ markdown-toc:
 	@for f in $(ALL_DOCS); do \
 		if grep -q '<!-- tocstop -->' $$f; then \
 			echo markdown-toc: processing $$f; \
-			npx --no -- markdown-toc --no-first-h1 --no-stripHeadingTags -i $$f || exit 1; \
+			npx --no -- markdown-toc --bullets "-" --no-first-h1 --no-stripHeadingTags -i $$f || exit 1; \
 		else \
 			echo markdown-toc: no TOC markers, skipping $$f; \
 		fi; \
@@ -117,12 +117,13 @@ fix-format:
 
 # Run all checks in order of speed / likely failure.
 .PHONY: check
-check: misspell markdownlint markdown-link-check check-format
+check: misspell markdownlint check-format markdown-toc markdown-link-check
+	git diff --exit-code ':*.md' || (echo 'Generated markdown Table of Contents is out of date, please run "make markdown-toc" and commit the changes in this PR.' && exit 1)
 	@echo "All checks complete"
 
 # Attempt to fix issues / regenerate tables.
 .PHONY: fix
-fix: table-generation misspell-correction fix-format
+fix: table-generation misspell-correction fix-format markdown-toc
 	@echo "All autofixes complete"
 
 .PHONY: install-tools

diff --git a/README.md b/README.md
@@ -18,10 +18,10 @@ See [CONTRIBUTING.md](CONTRIBUTING.md)
 
 Approvers ([@open-telemetry/specs-semconv-approvers](https://github.com/orgs/open-telemetry/teams/specs-semconv-approvers)):
 
+- [Alexandra Konrad](https://github.com/trisch-me), Elastic
 - [Christian Neumüller](https://github.com/Oberon00), Dynatrace
 - [James Moessis](https://github.com/jamesmoessis), Atlassian
 - [Johannes Tax](https://github.com/pyohannes), Grafana Labs
-- [Liudmila Molkova](https://github.com/lmolkova), Microsoft
 - [Sean Marciniak](https://github.com/MovieStoreGuy), Atlassian
 - [Ted Young](https://github.com/tedsuo), Lightstep
 
@@ -33,6 +33,7 @@ Maintainers ([@open-telemetry/specs-semconv-maintainers](https://github.com/orgs
 - [Armin Ruech](https://github.com/arminru), Dynatrace
 - [Joao Grassi](https://github.com/joaopgrassi), Dynatrace
 - [Josh Suereth](https://github.com/jsuereth), Google
+- [Liudmila Molkova](https://github.com/lmolkova), Microsoft
 - [Reiley Yang](https://github.com/reyang), Microsoft
 
 _Find more about the maintainer role in [community repository](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer)._
diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md
@@ -27,6 +27,7 @@ All registered attributes are listed by namespace in this registry.
 
 Currently, the following namespaces exist:
 
+* [Android](android.md)
 * [Browser](browser.md)
 * [Client](client.md)
 * [Cloud](cloud.md)
@@ -38,6 +39,7 @@ Currently, the following namespaces exist:
 * [Disk](disk.md)
 * [Error](error.md)
 * [Exception](exception.md)
+* [FaaS](faas.md)
 * [Host](host.md)
 * [HTTP](http.md)
 * [K8s](k8s.md)

diff --git a/docs/attributes-registry/android.md b/docs/attributes-registry/android.md
@@ -0,0 +1,8 @@
+# Android
+
+## Android Attributes
+<!-- semconv registry.android(omit_requirement_level) -->
+| Attribute  | Type | Description  | Examples  |
+|---|---|---|---|
+| `android.os.api_level` | string | Uniquely identifies the framework API revision offered by a version (`os.version`) of the android operating system. More information can be found [here](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels). | `33`; `32` |
+<!-- endsemconv -->
diff --git a/docs/attributes-registry/db.md b/docs/attributes-registry/db.md
@@ -9,11 +9,11 @@
 - [Cassandra Attributes](#cassandra-attributes)
 - [CosmosDB Attributes](#cosmosdb-attributes)
 - [Elasticsearch Attributes](#elasticsearch-attributes)
-- [JDBC Attributes](#jdbc-attributes)
 - [MongoDB Attributes](#mongodb-attributes)
 - [MSSQL Attributes](#mssql-attributes)
 - [Redis Attributes](#redis-attributes)
 - [SQL Attributes](#sql-attributes)
+- [Deprecated DB Attributes](#deprecated-db-attributes)
 
 <!-- tocstop -->
 
@@ -22,7 +22,6 @@
 <!-- semconv registry.db(omit_requirement_level,tag=db-generic) -->
 | Attribute  | Type | Description  | Examples  |
 |---|---|---|---|
-| `db.connection_string` | string | The connection string used to connect to the database. It is recommended to remove embedded credentials. | `Server=(localdb)\v11.0;Integrated Security=true;` |
 | `db.instance.id` | string | An identifier (address, unique name, or any other identifier) of the database instance that is executing queries or mutations on the current connection. This is useful in cases where the database is running in a clustered environment and the instrumentation is able to record the node executing the query. The client may obtain this value in databases like MySQL using queries like `select @@hostname`. | `mysql-e26b99z.example.com` |
 | `db.name` | string | This attribute is used to report the name of the database being accessed. For commands that switch the database, this should be set to the target database (even if the command fails). [1] | `customers`; `main` |
 | `db.operation` | string | The name of the operation being executed, e.g. the [MongoDB command name](https://docs.mongodb.com/manual/reference/command/#database-operations) such as `findAndModify`, or the SQL keyword. [2] | `findAndModify`; `HMSET`; `SELECT` |
@@ -178,14 +177,6 @@
 **[1]:** Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span attributes in the format `db.elasticsearch.path_parts.<key>`, where `<key>` is the url path part name. The implementation SHOULD reference the [elasticsearch schema](https://raw.githubusercontent.com/elastic/elasticsearch-specification/main/output/schema/schema.json) in order to map the path part values to their names.
 <!-- endsemconv -->
 
-## JDBC Attributes
-
-<!-- semconv registry.db(omit_requirement_level,tag=tech-specific-jdbc) -->
-| Attribute  | Type | Description  | Examples  |
-|---|---|---|---|
-| `db.jdbc.driver_classname` | string | The fully-qualified class name of the [Java Database Connectivity (JDBC)](https://docs.oracle.com/javase/8/docs/technotes/guides/jdbc/) driver used to connect. | `org.postgresql.Driver`; `com.microsoft.sqlserver.jdbc.SQLServerDriver` |
-<!-- endsemconv -->
-
 ## MongoDB Attributes
 
 <!-- semconv registry.db(omit_requirement_level,tag=tech-specific-mongodb) -->
@@ -221,3 +212,12 @@
 
 **[1]:** It is not recommended to attempt any client-side parsing of `db.statement` just to get this property, but it should be set if it is provided by the library being instrumented. If the operation is acting upon an anonymous table, or more than one table, this value MUST NOT be set.
 <!-- endsemconv -->
+
+## Deprecated DB Attributes
+
+<!-- semconv attributes.db.deprecated(omit_requirement_level) -->
+| Attribute  | Type | Description  | Examples  |
+|---|---|---|---|
+| `db.connection_string` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Deprecated, use `server.address`, `server.port` attributes instead. | `Server=(localdb)\v11.0;Integrated Security=true;` |
+| `db.jdbc.driver_classname` | string | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Removed, no replacement at this time. | `org.postgresql.Driver`; `com.microsoft.sqlserver.jdbc.SQLServerDriver` |
+<!-- endsemconv -->
diff --git a/docs/attributes-registry/dns.md b/docs/attributes-registry/dns.md
@@ -0,0 +1,14 @@
+<!--- Hugo front matter used to generate the website version of this page:
+--->
+
+# DNS
+
+## DNS Attributes
+
+<!-- semconv registry.dns(omit_requirement_level) -->
+| Attribute  | Type | Description  | Examples  |
+|---|---|---|---|
+| `dns.question.name` | string | The name being queried. [1] | `www.example.com`; `opentelemetry.io` |
+
+**[1]:** If the name field contains non-printable characters (below 32 or above 126), those characters should be represented as escaped base 10 integers (\DDD). Back slashes and quotes should be escaped. Tabs, carriage returns, and line feeds should be converted to \t, \r, and \n respectively.
+<!-- endsemconv -->