Merge branch 'main' into codeboten/add-with_resource_as_constant_labels

open-telemetry · Feb 15, 2024 · fa83641 · fa83641
2 parents 06c1b2b + 89aa013
commit fa83641
Show file tree

Hide file tree

Showing 17 changed files with 69 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,6 +24,8 @@ release.
 
 - Fix `Resource` field type in Logs Data Model.
   ([#3826](https://github.com/open-telemetry/opentelemetry-specification/pull/3826))
+- Remove confusing description from `Body` field in Logs Data Model to make it clear the Bridge API must support a structured body.
+  ([#3827](https://github.com/open-telemetry/opentelemetry-specification/pull/3827))
 - Deconstruct number scalar type to double and signed integer.
   ([#3854](https://github.com/open-telemetry/opentelemetry-specification/pull/3854))
 

diff --git a/specification/README.md b/specification/README.md
@@ -5,8 +5,11 @@ cascade:
   body_class: otel-docs-spec
   github_repo: &repo https://github.com/open-telemetry/opentelemetry-specification
   github_subdir: specification
-  path_base_for_github_subdir: content/en/docs/specs/otel/
+  path_base_for_github_subdir: tmp/otel/specification
   github_project_repo: *repo
+path_base_for_github_subdir:
+  from: tmp/otel/specification/_index.md
+  to: README.md
 --->
 
 # OpenTelemetry Specification

diff --git a/specification/baggage/README.md b/specification/baggage/README.md
@@ -1 +1,7 @@
+<!--- Hugo front matter used to generate the website version of this page:
+path_base_for_github_subdir:
+  from: tmp/otel/specification/baggage/_index.md
+  to: baggage/README.md
+--->
+
 # Baggage
diff --git a/specification/common/README.md b/specification/common/README.md
@@ -1,6 +1,9 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Common concepts
 aliases: [/docs/reference/specification/common/common]
+path_base_for_github_subdir:
+  from: tmp/otel/specification/common/_index.md
+  to: common/README.md
 --->
 
 # Common specification concepts

diff --git a/specification/compatibility/README.md b/specification/compatibility/README.md
@@ -1 +1,7 @@
+<!--- Hugo front matter used to generate the website version of this page:
+path_base_for_github_subdir:
+  from: tmp/otel/specification/compatibility/_index.md
+  to: compatibility/README.md
+--->
+
 # Compatibility
diff --git a/specification/configuration/README.md b/specification/configuration/README.md
@@ -1 +1,7 @@
+<!--- Hugo front matter used to generate the website version of this page:
+path_base_for_github_subdir:
+  from: tmp/otel/specification/configuration/_index.md
+  to: configuration/README.md
+--->
+
 # Configuration
diff --git a/specification/context/README.md b/specification/context/README.md
@@ -1,5 +1,8 @@
 <!--- Hugo front matter used to generate the website version of this page:
 aliases: [/docs/reference/specification/context/context]
+path_base_for_github_subdir:
+  from: tmp/otel/specification/context/_index.md
+  to: context/README.md
 --->
 
 # Context

diff --git a/specification/logs/README.md b/specification/logs/README.md
@@ -1,6 +1,9 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Logs
 aliases: [/docs/reference/specification/logs/overview]
+path_base_for_github_subdir:
+  from: tmp/otel/specification/logs/_index.md
+  to: logs/README.md
 --->
 
 # OpenTelemetry Logging

diff --git a/specification/logs/data-model.md b/specification/logs/data-model.md
@@ -402,16 +402,14 @@ corresponding short names).
 
 ### Field: `Body`
 
-Type: any.
-
-Description: A value containing the body of the log record (see the description
-of `any` type above). Can be for example a human-readable string message
-(including multi-line) describing the event in a free form or it can be a
-structured data composed of arrays and maps of other values. First-party
-Applications SHOULD use a string message. However, a structured body SHOULD be
-used to preserve the semantics of structured logs emitted by Third-party
-Applications. Can vary for each occurrence of the event coming from the same
-source. This field is optional.
+Type: [`any`](#type-any).
+
+Description: A value containing the body of the log record. Can be for example
+a human-readable string message (including multi-line) describing the event in
+a free form or it can be a structured data composed of arrays and maps of other
+values. Body MUST support [`any` type](#type-any) to preserve the semantics of
+structured logs emitted by the applications. Can vary for each occurrence of the
+event coming from the same source. This field is optional.
 
 ### Field: `Resource`
 

diff --git a/specification/metrics/README.md b/specification/metrics/README.md
@@ -1,5 +1,8 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Metrics
+path_base_for_github_subdir:
+  from: tmp/otel/specification/metrics/_index.md
+  to: metrics/README.md
 --->
 
 # OpenTelemetry Metrics

diff --git a/specification/metrics/sdk.md b/specification/metrics/sdk.md
@@ -1597,7 +1597,7 @@ The filtering is done at the [MetricProducer](#metricproducer) for performance r
 The `MetricFilter` allows filtering an entire metric stream - dropping or allowing all its attribute sets -
 by its `TestMetric` operation, which accepts the metric stream information
 (scope, name, kind and unit)  and returns an enumeration: `Accept`, `Drop`
-or `Allow_Partial`. If the latter returned, the `TestAttributes` operation
+or `Accept_Partial`. If the latter returned, the `TestAttributes` operation
 is to be called per attribute set of that metric stream, returning an enumeration
 determining if the data point for that (metric stream, attributes) pair is to be
 allowed in the result of the [MetricProducer](#metricproducer) `Produce` operation.

diff --git a/specification/metrics/sdk_exporters/README.md b/specification/metrics/sdk_exporters/README.md
@@ -1,5 +1,8 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Exporters
+path_base_for_github_subdir:
+  from: tmp/otel/specification/metrics/sdk_exporters/_index.md
+  to: metrics/sdk_exporters/README.md
 --->
 
 # Metrics Exporters
diff --git a/specification/protocol/README.md b/specification/protocol/README.md
@@ -1,5 +1,8 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Protocol
+path_base_for_github_subdir:
+  from: tmp/otel/specification/protocol/_index.md
+  to: protocol/README.md
 --->
 
 # OpenTelemetry Protocol

diff --git a/specification/resource/README.md b/specification/resource/README.md
@@ -1 +1,7 @@
+<!--- Hugo front matter used to generate the website version of this page:
+path_base_for_github_subdir:
+  from: tmp/otel/specification/resource/_index.md
+  to: resource/README.md
+--->
+
 # Resource
diff --git a/specification/schemas/README.md b/specification/schemas/README.md
@@ -1,6 +1,9 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Schemas
 aliases: [/docs/reference/specification/schemas/overview]
+path_base_for_github_subdir:
+  from: tmp/otel/specification/schemas/_index.md
+  to: schemas/README.md
 --->
 
 # Telemetry Schemas

diff --git a/specification/trace/README.md b/specification/trace/README.md
@@ -1 +1,7 @@
+<!--- Hugo front matter used to generate the website version of this page:
+path_base_for_github_subdir:
+  from: tmp/otel/specification/trace/_index.md
+  to: trace/README.md
+--->
+
 # Trace
diff --git a/specification/trace/sdk_exporters/README.md b/specification/trace/sdk_exporters/README.md
@@ -1,5 +1,8 @@
 <!--- Hugo front matter used to generate the website version of this page:
 linkTitle: Exporters
+path_base_for_github_subdir:
+  from: tmp/otel/specification/trace/sdk_exporters/_index.md
+  to: trace/sdk_exporters/README.md
 --->
 
 # Trace Exporters