Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add metrics exporters spec files #1837

Merged
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions specification/library-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
7 changes: 7 additions & 0 deletions specification/metrics/sdk_exporters/in-memory.md
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 7 additions & 0 deletions specification/metrics/sdk_exporters/otlp.md
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 7 additions & 0 deletions specification/metrics/sdk_exporters/prometheus.md
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 7 additions & 0 deletions specification/metrics/sdk_exporters/stdout.md
Original file line number Diff line number Diff line change
@@ -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.