Skip to content

Commit

Permalink
Add metrics exporters spec files (#1837)
Browse files Browse the repository at this point in the history
* Updated the library guideline to clarify exporter for logs/metrics/traces.
* Added skeleton files for metrics exporters.
  • Loading branch information
reyang committed Aug 3, 2021
1 parent cce1d59 commit b76e16f
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 6 deletions.
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.

0 comments on commit b76e16f

Please sign in to comment.