Skip to content

Commit

Permalink
Add references to logs and events OTEPs (open-telemetry#4011)
Browse files Browse the repository at this point in the history
  • Loading branch information
tigrannajaryan authored Apr 29, 2024
1 parent c777937 commit 8236b87
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 0 deletions.
6 changes: 6 additions & 0 deletions specification/logs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<!-- tocstop -->

Expand Down Expand Up @@ -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)
5 changes: 5 additions & 0 deletions specification/logs/bridge-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
- [Optional and required parameters](#optional-and-required-parameters)
- [Concurrency requirements](#concurrency-requirements)
- [Artifact Naming](#artifact-naming)
- [References](#references)

<!-- tocstop -->

Expand Down Expand Up @@ -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 Logging Library SDK Prototype Specification](https://github.com/open-telemetry/oteps/blob/main/text/logs/0150-logging-library-sdk.md)
5 changes: 5 additions & 0 deletions specification/logs/data-model-appendix.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<!-- tocstop -->

Expand Down Expand Up @@ -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)
5 changes: 5 additions & 0 deletions specification/logs/event-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
* [EventLogger Operations](#eventlogger-operations)
+ [Emit Event](#emit-event)
- [Optional and required parameters](#optional-and-required-parameters)
- [References](#references)

<!-- tocstop -->

Expand Down Expand Up @@ -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)
2 changes: 2 additions & 0 deletions specification/logs/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 2 additions & 0 deletions specification/logs/supplementary-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit 8236b87

Please sign in to comment.