Merge branch 'main' into event_details

breedx-splk · Feb 6, 2024 · 43a13df · 43a13df
2 parents c2c827d + e39dcb5
commit 43a13df
Show file tree

Hide file tree

Showing 25 changed files with 59 additions and 26 deletions.
diff --git a/.chloggen/661.yaml b/.chloggen/661.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 messaging semantic conventions for settlement spans
+
+# 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: [621]
+
+# (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/docs/README.md b/docs/README.md
@@ -5,10 +5,10 @@ cascade:
   body_class: otel-docs-spec
   github_repo: &repo https://github.com/open-telemetry/semantic-conventions
   github_subdir: docs
-  path_base_for_github_subdir: content/en/docs/specs/semconv/
+  path_base_for_github_subdir: tmp/semconv/docs/
   github_project_repo: *repo
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/_index.md
+  from: tmp/semconv/docs/_index.md
   to: README.md
 --->
 

diff --git a/docs/attributes-registry/host.md b/docs/attributes-registry/host.md
@@ -1,5 +1,6 @@
 <!--- Hugo front matter used to generate the website version of this page:
 --->
+
 # Host
 
 ## Host Attributes

diff --git a/docs/attributes-registry/os.md b/docs/attributes-registry/os.md
@@ -1,6 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: OS
 --->
+
 # OS
 
 ## Operating System Attributes

diff --git a/docs/attributes-registry/url.md b/docs/attributes-registry/url.md
@@ -1,6 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: URL
 --->
+
 # URL
 
 ## URL Attributes

diff --git a/docs/cloud-providers/README.md b/docs/cloud-providers/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Cloud Providers
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/cloud-providers/_index.md
+  from: tmp/semconv/docs/cloud-providers/_index.md
   to: cloud-providers/README.md
 --->
 

diff --git a/docs/cloudevents/README.md b/docs/cloudevents/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: CloudEvents
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/cloudevents/_index.md
+  from: tmp/semconv/docs/cloudevents/_index.md
   to: cloudevents/README.md
 --->
 

diff --git a/docs/database/README.md b/docs/database/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Database
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/database/_index.md
+  from: tmp/semconv/docs/database/_index.md
   to: database/README.md
 --->
 

diff --git a/docs/dotnet/README.md b/docs/dotnet/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: .NET
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/dotnet/_index.md
+  from: tmp/semconv/docs/dotnet/_index.md
   to: dotnet/README.md
 --->
 

diff --git a/docs/exceptions/README.md b/docs/exceptions/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Exceptions
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/exceptions/_index.md
+  from: tmp/semconv/docs/exceptions/_index.md
   to: exceptions/README.md
 --->
 

diff --git a/docs/faas/README.md b/docs/faas/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: FaaS
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/faas/_index.md
+  from: tmp/semconv/docs/faas/_index.md
   to: faas/README.md
 --->
 

diff --git a/docs/feature-flags/README.md b/docs/feature-flags/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Feature Flags
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/feature-flags/_index.md
+  from: tmp/semconv/docs/feature-flags/_index.md
   to: feature-flags/README.md
 --->
 

diff --git a/docs/general/README.md b/docs/general/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: General
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/general/_index.md
+  from: tmp/semconv/docs/general/_index.md
   to: general/README.md
 weight: -1
 --->

diff --git a/docs/http/README.md b/docs/http/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: HTTP
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/http/_index.md
+  from: tmp/semconv/docs/http/_index.md
   to: http/README.md
 --->
 

diff --git a/docs/messaging/README.md b/docs/messaging/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Messaging Systems
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/messaging/_index.md
+  from: tmp/semconv/docs/messaging/_index.md
   to: messaging/README.md
 --->
 

diff --git a/docs/messaging/messaging-spans.md b/docs/messaging/messaging-spans.md
@@ -184,18 +184,19 @@ If the destination name is dynamic, such as a [conversation ID](#conversations)
 In these cases, an artificial destination name that best expresses the destination, or a generic, static fallback like `"(anonymous)"` for [anonymous destinations](#temporary-and-anonymous-destinations) SHOULD be used instead.
 
 The values allowed for `<operation name>` are defined in the section [Operation names](#operation-names) below.
-If the format above is used, the operation name MUST match the `messaging.operation` attribute defined for message consumer spans below.
 
 Examples:
 
 * `shop.orders publish`
 * `shop.orders receive`
-* `shop.orders process`
+* `shop.orders settle`
 * `print_jobs publish`
-* `topic with spaces process`
-* `AuthenticationRequest-Conversations process`
+* `topic with spaces deliver`
+* `AuthenticationRequest-Conversations settle`
 * `(anonymous) publish` (`(anonymous)` being a stable identifier for an unnamed destination)
 
+Messaging system specific adaptions to span naming MUST be documented in [semantic conventions for specific messaging technologies](#semantic-conventions-for-specific-messaging-technologies).
+
 ### Operation names
 
 The following operations related to messages are defined for these semantic conventions:
@@ -206,6 +207,7 @@ The following operations related to messages are defined for these semantic conv
 | `create`       | A message is created. "Create" spans always refer to a single message and are used to provide a unique creation context for messages in batch publishing scenarios. |
 | `receive`      | One or more messages are requested by a consumer. This operation refers to pull-based scenarios, where consumers explicitly call methods of messaging SDKs to receive messages. |
 | `deliver`      | One or more messages are passed to a consumer. This operation refers to push-based scenarios, where consumer register callbacks which get called by messaging SDKs. |
+| `settle`       | One or more messages are settled. |
 
 ### Span kind
 
@@ -269,6 +271,12 @@ batch of messages, or for no message at all (if it is signalled that no
 messages were received). For each message it accounts for, the "Deliver" or
 "Receive" span SHOULD link to the message's creation context.
 
+"Settle" spans SHOULD be created for every manually or automatically triggered
+settlement operation. A single "Settle" span can account for a single message
+or for multiple messages (in case messages are passed for settling as batches).
+For each message it accounts for, the "Settle" span MAY link to the creation
+context of the message.
+
 ## Messaging attributes
 
 Messaging attributes are organized into the following namespaces:

diff --git a/docs/mobile/README.md b/docs/mobile/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
-linkTitle: mobile
+linkTitle: Mobile
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/mobile/_index.md
+  from: tmp/semconv/docs/mobile/_index.md
   to: mobile/README.md
 --->
 

diff --git a/docs/object-stores/README.md b/docs/object-stores/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Object Stores
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/object-stores/_index.md
+  from: tmp/semconv/docs/object-stores/_index.md
   to: object-stores/README.md
 --->
 

diff --git a/docs/resource/README.md b/docs/resource/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Resource
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/resource/_index.md
+  from: tmp/semconv/docs/resource/_index.md
   to: resource/README.md
 --->
 

diff --git a/docs/resource/cloud-provider/README.md b/docs/resource/cloud-provider/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Resource Cloud Provider
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/resource/cloud-provider/_index.md
+  from: tmp/semconv/docs/resource/cloud-provider/_index.md
   to: resource/cloud-provider/README.md
 --->
 

diff --git a/docs/resource/cloud-provider/aws/README.md b/docs/resource/cloud-provider/aws/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: AWS
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/resource/cloud-provider/aws/_index.md
+  from: tmp/semconv/docs/resource/cloud-provider/aws/_index.md
   to: resource/cloud-provider/aws/README.md
 --->
 

diff --git a/docs/resource/cloud-provider/gcp/README.md b/docs/resource/cloud-provider/gcp/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: GCP
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/resource/cloud-provider/gcp/_index.md
+  from: tmp/semconv/docs/resource/cloud-provider/gcp/_index.md
   to: resource/cloud-provider/gcp/README.md
 --->
 

diff --git a/docs/rpc/README.md b/docs/rpc/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: RPC
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/rpc/_index.md
+  from: tmp/semconv/docs/rpc/_index.md
   to: rpc/README.md
 --->
 

diff --git a/docs/system/README.md b/docs/system/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: System
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/system/_index.md
+  from: tmp/semconv/docs/system/_index.md
   to: system/README.md
 --->
 

diff --git a/docs/url/README.md b/docs/url/README.md
@@ -1,7 +1,7 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: URL
 path_base_for_github_subdir:
-  from: content/en/docs/specs/semconv/url/_index.md
+  from: tmp/semconv/docs/url/_index.md
   to: url/README.md
 --->