Merge branch 'main' into add-measurement-processor-to-metrics-sdk-spec

open-telemetry · Dec 19, 2024 · 17f650c · 17f650c
2 parents 9d60b12 + e81d06b
commit 17f650c
Show file tree

Hide file tree

Showing 16 changed files with 88 additions and 177 deletions.
diff --git a/.github/auto_assign_issue.yml b/.github/auto_assign_issue.yml
diff --git a/.github/auto_assign_pr.yml b/.github/auto_assign_pr.yml
diff --git a/.github/workflows/auto-assign-pr.yml b/.github/workflows/auto-assign-pr.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,36 @@ release.
 
 ### Context
 
+### Traces
+
+### Metrics
+
+### Logs
+
+### Events
+
+### Baggage
+
+### Resource
+
+### Profiles
+
+### OpenTelemetry Protocol
+
+### Compatibility
+
+### SDK Configuration
+
+### Common
+
+### Supplementary Guidelines
+
+### OTEPs
+
+## v1.40.0 (2024-12-12)
+
+### Context
+
 - Adds optional `GetAll` method to `Getter` in Propagation API, allowing for the retrieval of multiple values for the same key.
   [#4295](https://github.com/open-telemetry/opentelemetry-specification/pull/4295)
 
@@ -32,20 +62,15 @@ release.
  ([#4183](https://github.com/open-telemetry/opentelemetry-specification/pull/4183))
 - Remove the recommendation to not synchronize access to `LoggerConfig.disabled`.
   ([#4310](https://github.com/open-telemetry/opentelemetry-specification/pull/4310))
+- Remove the in-development isolating log record processor.
+  ([#4301](https://github.com/open-telemetry/opentelemetry-specification/pull/4301))
 
 ### Events
 
-### Baggage
-
-### Resource
-
-### Profiles
-
-### OpenTelemetry Protocol
-
-### Compatibility
-
-### SDK Configuration
+- Deprecate Events API and SDK in favor of having Events support in the Logs API and SDK.
+  ([#4319](https://github.com/open-telemetry/opentelemetry-specification/pull/4319))
+- Change `event.name` attribute into top-level event name field.
+  ([#4320](https://github.com/open-telemetry/opentelemetry-specification/pull/4320))
 
 ### Common
 
@@ -57,6 +82,12 @@ release.
 - Add core principles for evaluating specification changes.
   ([#4286](https://github.com/open-telemetry/opentelemetry-specification/pull/4286))
 
+## OTEPs
+
+- The [open-telemetry/oteps](https://github.com/open-telemetry/oteps) repository was
+  merged into the specification repository.
+ ([#4288](https://github.com/open-telemetry/opentelemetry-specification/pull/4288))
+
 ## v1.39.0 (2024-11-06)
 
 ### Logs

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -289,34 +289,15 @@ Release Procedure:
 
 1. Prepare a [draft release here](https://github.com/open-telemetry/opentelemetry-specification/releases).
    Don't publish it yet.
-2. Create a PR with updated [CHANGELOG.md](CHANGELOG.md). The CHANGELOG.md must have a
+2. Run [opentelemetry.io workflow](https://github.com/open-telemetry/opentelemetry.io/actions/workflows/build-dev.yml)
+   against `opentelemetry-specification` submodule as a smoke-test for docs. Fix broken links, if any.
+3. Create a PR with updated [CHANGELOG.md](CHANGELOG.md). The CHANGELOG.md must have a
    heading with the new version number. Ensure that no CHANGELOG entries are missing or
    ended up in the wrong section (e.g., in the last released version rather than Unreleased).
-   The PR will fail the `schemas-check` Github action (all other actions must pass).
-   This is expected and will be fixed in the next steps. Have this PR reviewed and approved
-   and ready to be merged. While it is being reviewed you can work on step 3-4 in parallel.
-3. Prepare the schema file for the upcoming release. The schema file should be placed
-   in the `schemas` directory. If no changes to semantic conventions happened
-   since the last release which require a corresponding section in the schema file then
-   simply copy the previous schema file, rename it to the new version and add a section
-   with the new version number to the file. See for example the schema file for [1.9.0](
-   https://github.com/open-telemetry/opentelemetry-specification/blob/main/schemas/1.9.0)
-   that has no changes from 1.8.0.
-   The schema file may already exist if there were changes done to semantic conventions
-   and the schema file was created with corresponding changes.
-4. Create and merge the PR with the new schema file. Note the commit hash after merging.
-   If the schema file for the new release version previously existed then no new PR is
-   necessary, just note that latest commit hash of this repository.
-5. Once CHANGELOG.md PR is approved and ready to be merged we are ready to make the release.
-   Update the [opentelemetry.io](https://github.com/open-telemetry/opentelemetry.io)
-   repository: the [opentelemetry-specification](
-   https://github.com/open-telemetry/opentelemetry.io/tree/main/content-modules)
-   submodule points to this repository. Create a PR and update the submodule to point to
-   the commit hash from step 4. Merge this PR. This should update the
-   [https://opentelemetry.io/](https://opentelemetry.io/) website and the new schema file
-   should be downloadable at `https://opentelemetry.io/schemas/<version>`.
-6. Re-trigger the `schema-checks` Github action on the PR that updates the CHANGELOG.md.
-   The action should pass now. Merge the PR.
-7. Add the changelog entries from `CHANGELOG.md` to the description of the previously
+4. Once CHANGELOG.md PR is approved and ready to be merged we are ready to make the release.
+5. Add the changelog entries from `CHANGELOG.md` to the description of the previously
    created [draft release here](
    https://github.com/open-telemetry/opentelemetry-specification/releases) and publish it.
+
+New release is then auto-discovered by [opentelemetry.io](https://github.com/open-telemetry/opentelemetry.io) pipelines which
+(via bot-generated PR) will eventually publish new version of the specification.
diff --git a/spec-compliance-matrix.md b/spec-compliance-matrix.md
@@ -193,6 +193,7 @@ Disclaimer: this list of features is still a work in progress, please refer to t
 | LoggerProvider.Shutdown                      |          |     | +    |     | +      |      |        | +   |      | +   | -    |       |
 | LoggerProvider.ForceFlush                    |          |     | +    |     | +      |      |        | +   |      | +   | -    |       |
 | Logger.Emit(LogRecord)                       |          |     | +    |     | +      |      |        | +   |      | +   | -    |       |
+| Logger.EmitEvent(LogRecord)                  |          |     |      |     |        |      |        |     |      |     |      |       |
 | Logger.Enabled                               | X        | +   |      |     |        |      |        |     | +    | +   |      |       |
 | SimpleLogRecordProcessor                     |          |     | +    |     | +      |      |        | +   |      | +   |      |       |
 | BatchLogRecordProcessor                      |          |     | +    |     | +      |      |        | +   |      | +   |      |       |
@@ -203,26 +204,6 @@ Disclaimer: this list of features is still a work in progress, please refer to t
 | Can plug custom LogRecordExporter            |          |     | +    |     | +      |      |        | +   |      | +   |      |       |
 | Trace Context Injection                      |          |     | +    |     | +      |      |        | +   |      | +   | +    |       |
 
-## Events
-
-Features for the [Events API](specification/logs/event-api.md) and the [Events SDK](specification/logs/event-sdk.md).
-Disclaimer: Events are currently in Development status - work in progress.
-
-| Feature                                                                    | Optional | Go | Java | JS | Python | Ruby | Erlang | PHP | Rust | C++ | .NET | Swift |
-|----------------------------------------------------------------------------|----------|----|------|----|--------|------|--------|-----|------|-----|------|-------|
-| [EventLoggerProvider](specification/logs/event-api.md#eventloggerprovider) | Optional | Go | Java | JS | Python | Ruby | Erlang | PHP | Rust | C++ | .NET | Swift |
-| Get EventLogger                                                            |          |    |      |    |        |      |        |     |      |     |      |       |
-| Get EventLogger accepts version                                            | X        |    |      |    |        |      |        |     |      |     |      |       |
-| Get EventLogger accepts schema_url                                         | X        |    |      |    |        |      |        |     |      |     |      |       |
-| Get EventLogger accepts attributes                                         | X        |    |      |    |        |      |        |     |      |     |      |       |
-| [EventLogger](specification/logs/event-api.md#eventlogger)                 | Optional | Go | Java | JS | Python | Ruby | Erlang | PHP | Rust | C++ | .NET | Swift |
-| Emit event accepts name                                                    |          |    |      |    |        |      |        |     |      |     |      |       |
-| Emit event accepts AnyValue body                                           | X        |    |      |    |        |      |        |     |      |     |      |       |
-| Emit event accepts severity                                                | X        |    |      |    |        |      |        |     |      |     |      |       |
-| Emit event accepts timestamp                                               | X        |    |      |    |        |      |        |     |      |     |      |       |
-| Emit event accepts attributes                                              | X        |    |      |    |        |      |        |     |      |     |      |       |
-| Emit event accepts context                                                 | X        |    |      |    |        |      |        |     |      |     |      |       |
-
 ## Resource
 
 | Feature                                                                                                                                     | Optional | Go | Java | JS | Python | Ruby | Erlang | PHP | Rust | C++ | .NET | Swift |

diff --git a/specification/README.md b/specification/README.md
@@ -33,7 +33,6 @@ path_base_for_github_subdir:
   - [Metrics](metrics/api.md)
   - [Logs](logs/README.md)
     - [API](logs/api.md)
-    - [Event API](logs/event-api.md)
 - SDK Specification
   - [Tracing](trace/sdk.md)
   - [Metrics](metrics/sdk.md)