diff --git a/specification/library-guidelines.md b/specification/library-guidelines.md index d431e382f1b..ceff34e568a 100644 --- a/specification/library-guidelines.md +++ b/specification/library-guidelines.md @@ -21,12 +21,15 @@ _Note to OpenTelemetry client Authors:_ OpenTelemetry specification, API and SDK 4. The SDK must be clearly separated into wire protocol-independent parts that implement common logic (e.g. batching, tag enrichment by process information, etc.) and protocol-dependent telemetry exporters. Telemetry exporters must contain minimal functionality, thus enabling vendors to easily add support for their specific protocol. 5. The SDK implementation should include the following exporters: - - OTLP. - - Jaeger. - - Zipkin. - - Prometheus. - - Standard output (or logging) to use for debugging and testing as well as an input for the various log proxy tools. - - In-memory (mock) exporter that accumulates telemetry data in the local memory and allows to inspect it (useful for e.g. unit tests). + - logs, metrics, trace + - OTLP (OpenTelemetry Protocol). + - Standard output (or logging) to use for debugging and testing as well as an input for the various log proxy tools. + - In-memory (mock) exporter that accumulates telemetry data in the local memory and allows to inspect it (useful for e.g. unit tests). + - metrics + - Prometheus. + - trace + - Jaeger. + - Zipkin. Note: some of these support multiple protocols (e.g. gRPC, Thrift, etc). The exact list of protocols to implement in the exporters is TBD. diff --git a/specification/metrics/sdk_exporters/in-memory.md b/specification/metrics/sdk_exporters/in-memory.md new file mode 100644 index 00000000000..62541ea232e --- /dev/null +++ b/specification/metrics/sdk_exporters/in-memory.md @@ -0,0 +1,7 @@ +# OpenTelemetry Metrics Exporter - In-memory + +**Status**: [Experimental](../../document-status.md) + +Note: this specification is subject to major changes. To avoid thrusting +language client maintainers, we don't recommend OpenTelemetry clients to start +the implementation unless explicitly communicated. diff --git a/specification/metrics/sdk_exporters/otlp.md b/specification/metrics/sdk_exporters/otlp.md new file mode 100644 index 00000000000..507538aead0 --- /dev/null +++ b/specification/metrics/sdk_exporters/otlp.md @@ -0,0 +1,7 @@ +# OpenTelemetry Metrics Exporter - OTLP + +**Status**: [Experimental](../../document-status.md) + +Note: this specification is subject to major changes. To avoid thrusting +language client maintainers, we don't recommend OpenTelemetry clients to start +the implementation unless explicitly communicated. diff --git a/specification/metrics/sdk_exporters/prometheus.md b/specification/metrics/sdk_exporters/prometheus.md new file mode 100644 index 00000000000..bb78e8f526a --- /dev/null +++ b/specification/metrics/sdk_exporters/prometheus.md @@ -0,0 +1,7 @@ +# OpenTelemetry Metrics Exporter - Prometheus + +**Status**: [Experimental](../../document-status.md) + +Note: this specification is subject to major changes. To avoid thrusting +language client maintainers, we don't recommend OpenTelemetry clients to start +the implementation unless explicitly communicated. diff --git a/specification/metrics/sdk_exporters/stdout.md b/specification/metrics/sdk_exporters/stdout.md new file mode 100644 index 00000000000..1a91d26aa0e --- /dev/null +++ b/specification/metrics/sdk_exporters/stdout.md @@ -0,0 +1,7 @@ +# OpenTelemetry Metrics Exporter - Standard output + +**Status**: [Experimental](../../document-status.md) + +Note: this specification is subject to major changes. To avoid thrusting +language client maintainers, we don't recommend OpenTelemetry clients to start +the implementation unless explicitly communicated.