From 660c57fccb78d7df455a11838739d2a1664e25d0 Mon Sep 17 00:00:00 2001 From: Tigran Najaryan Date: Wed, 24 Apr 2024 12:35:06 -0400 Subject: [PATCH] Add references to logs and events OTEPs Contributes to https://github.com/open-telemetry/opentelemetry-specification/issues/3792 --- specification/logs/README.md | 6 ++++++ specification/logs/bridge-api.md | 5 +++++ specification/logs/data-model-appendix.md | 5 +++++ specification/logs/event-api.md | 5 +++++ specification/logs/sdk.md | 2 ++ specification/logs/supplementary-guidelines.md | 2 ++ 6 files changed, 25 insertions(+) diff --git a/specification/logs/README.md b/specification/logs/README.md index 569915df76e..5980f25b7c2 100644 --- a/specification/logs/README.md +++ b/specification/logs/README.md @@ -28,6 +28,7 @@ path_base_for_github_subdir: - [OpenTelemetry Collector](#opentelemetry-collector) - [Auto-Instrumenting Existing Logging](#auto-instrumenting-existing-logging) - [Specifications](#specifications) +- [References](#references) @@ -448,3 +449,8 @@ standard output. * [Logs Data Model](./data-model.md) * [Event API](./event-api.md) * [Trace Context in non-OTLP Log Formats](../compatibility/logging_trace_context.md) + +## References + +- [OTEP0091 Logs: Vocabulary](https://github.com/open-telemetry/oteps/blob/main/text/logs/0091-logs-vocabulary.md) +- [OTEP0092 OpenTelemetry Logs Vision](https://github.com/open-telemetry/oteps/blob/main/text/logs/0092-logs-vision.md) diff --git a/specification/logs/bridge-api.md b/specification/logs/bridge-api.md index 1686ce11dba..a81f59bdc9c 100644 --- a/specification/logs/bridge-api.md +++ b/specification/logs/bridge-api.md @@ -18,6 +18,7 @@ - [Optional and required parameters](#optional-and-required-parameters) - [Concurrency requirements](#concurrency-requirements) - [Artifact Naming](#artifact-naming) +- [References](#references) @@ -154,3 +155,7 @@ in the event OpenTelemetry were to add a user facing API, the Logs Bridge API wo be a natural starting point. Therefore, Log Bridge API artifact, package, and class names MUST NOT include the terms "bridge", "appender", or any other qualifier that would prevent evolution into a user facing API. + +## References + +- [OTEP0150](https://github.com/open-telemetry/oteps/blob/main/text/logs/0150-logging-library-sdk.md) diff --git a/specification/logs/data-model-appendix.md b/specification/logs/data-model-appendix.md index 8d5df355cda..00c7d440efc 100644 --- a/specification/logs/data-model-appendix.md +++ b/specification/logs/data-model-appendix.md @@ -19,6 +19,7 @@ the respective exporter documentation if exact details are required. * [Google Cloud Logging](#google-cloud-logging) * [Elastic Common Schema](#elastic-common-schema) - [Appendix B: `SeverityNumber` example mappings](#appendix-b-severitynumber-example-mappings) +- [References](#references) @@ -815,3 +816,7 @@ for an exhaustive list. |Critical |Critical | |Dpanic| | |ERROR2 | |Alert | | |Panic | | |ERROR3 | |Emergency | |FATAL |Fatal | |LogLevel.Critical |FATAL | + +## References + +- [OTEP0097 Log Data Model, Appendix A. Example Mappings](https://github.com/open-telemetry/oteps/blob/main/text/logs/0097-log-data-model.md#appendix-a-example-mappings) diff --git a/specification/logs/event-api.md b/specification/logs/event-api.md index 0f97131d1c3..6749e656e38 100644 --- a/specification/logs/event-api.md +++ b/specification/logs/event-api.md @@ -17,6 +17,7 @@ * [EventLogger Operations](#eventlogger-operations) + [Emit Event](#emit-event) - [Optional and required parameters](#optional-and-required-parameters) +- [References](#references) @@ -129,3 +130,7 @@ NOT obligate a user to provide it. For each required parameter, the API MUST be structured to obligate a user to provide it. + +## References + +- [OTEP0202 Introducing Events and Logs API](https://github.com/open-telemetry/oteps/blob/main/text/0202-events-and-logs-api.md) diff --git a/specification/logs/sdk.md b/specification/logs/sdk.md index 24ab9fbd106..da8ba2c3973 100644 --- a/specification/logs/sdk.md +++ b/specification/logs/sdk.md @@ -488,3 +488,5 @@ return a Failure result. `Shutdown` SHOULD NOT block indefinitely (e.g. if it attempts to flush the data and the destination is unavailable). [OpenTelemetry SDK](../overview.md#sdk) authors MAY decide if they want to make the shutdown timeout configurable. + +- [OTEP0150 Logging Library SDK Prototype Specification](https://github.com/open-telemetry/oteps/blob/main/text/logs/0150-logging-library-sdk.md) diff --git a/specification/logs/supplementary-guidelines.md b/specification/logs/supplementary-guidelines.md index 56151f0da04..026951938b6 100644 --- a/specification/logs/supplementary-guidelines.md +++ b/specification/logs/supplementary-guidelines.md @@ -116,3 +116,5 @@ the current active span. See [an example](https://docs.google.com/document/d/15vR7D1x2tKd7u3zaTF0yH1WaHkUr2T4hhr7OyiZgmBg/edit#heading=h.4xuru5ljcups) of how it can be done for zap logging library for Go. + +- [OTEP0150 Logging Library SDK Prototype Specification](https://github.com/open-telemetry/oteps/blob/main/text/logs/0150-logging-library-sdk.md)