|
| 1 | +# Logs GA Scope |
| 2 | + |
| 3 | +This document defines what's in scope for OpenTelemetry Logs General |
| 4 | +Availability release. |
| 5 | + |
| 6 | +## Motivation |
| 7 | + |
| 8 | +Clearly defined scope is important to align all logs contributors and to make |
| 9 | +sure we know what target we are working towards. Note that some of the listed |
| 10 | +items are already fully or partially implemented but are still listed for |
| 11 | +completeness. |
| 12 | + |
| 13 | +General Availability of OpenTelemetry Logs is expected after OpenTelemetry 1.0 |
| 14 | +GA (which will only include traces and metrics). |
| 15 | + |
| 16 | +## Logs Roadmap Items |
| 17 | + |
| 18 | +### Specification and SDK |
| 19 | + |
| 20 | +- Write guidelines and specification for logging libraries to support |
| 21 | + OpenTelemetry-compliant logs. |
| 22 | + |
| 23 | +- Implement OpenTelemetry logs SDK for Java that support trace context |
| 24 | + extraction from the current execution context. |
| 25 | + |
| 26 | +- Show full OpenTelemetry-compliant implementation of an "addon" to one of the |
| 27 | + popular logging libraries for Java (e.g. Log4J, SLF4J, etc). Use OpenTelemetry |
| 28 | + SDK to automatically include extracted trace context in the logs and support |
| 29 | + exporting via OTLP. |
| 30 | + |
| 31 | +- Implement an example Java application that shows how to emit correlated traces |
| 32 | + and logs. Use the supported popular logging library together with |
| 33 | + OpenTelemetry SDK, and export logs using OTLP. |
| 34 | + |
| 35 | +- Add Logs support to OTLP specification. |
| 36 | + |
| 37 | +### Collector |
| 38 | + |
| 39 | +- Implement receiver and exporter for OTLP logs in Collector. |
| 40 | + |
| 41 | +- Implement "array" value type for in-memory data structures (it is already part |
| 42 | + of OTLP but is not supported by the Collector yet). |
| 43 | + |
| 44 | +- Implement log exporters in Collector for a few vendor formats from |
| 45 | + participating vendors. |
| 46 | + |
| 47 | +- Implement Fluent Forward protocol receiver to receive logs from |
| 48 | + FluentBit/FluentD. |
| 49 | + |
| 50 | +- Add support for log data type to the following processors: `resource`, |
| 51 | + `batch`, `attributes`, `k8s_tagger`, `resourcedetection`. |
| 52 | + |
| 53 | +- Add end-to-end performance tests for log forwarding (similar to existing trace |
| 54 | + and metric tests) at least for OTLP and Fluent Forward protocols. |
| 55 | + |
| 56 | +- Test operation of Collector together with at least one other logging agent |
| 57 | + (e.g. FluentBit), allowing to read file logs as described here. Publish test |
| 58 | + results (including performance). |
| 59 | + |
| 60 | +- Implement an example that shows how to use OpenTelemetry Collector to collect |
| 61 | + correlated logs, traces and metrics from a distributed microservices |
| 62 | + application (preferably running in a cloud-native control plane like |
| 63 | + Kubernetes) |
0 commit comments