Skip to content

Commit

Permalink
Clean up the Metrics top level README (#1934)
Browse files Browse the repository at this point in the history
  • Loading branch information
@reyang
reyang authored Sep 17, 2021
1 parent 03ccecc commit c20b492
Showing 1 changed file with 18 additions and 29 deletions.
47 changes: 18 additions & 29 deletions specification/metrics/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,6 @@

**Status**: [Experimental](../document-status.md)

**Owner:**

* [Reiley Yang](https://github.com/reyang)

**Domain Experts:**

* [Bogdan Drutu](https://github.com/bogdandrutu)
* [Josh Suereth](https://github.com/jsuereth)
* [Joshua MacDonald](https://github.com/jmacd)

Note: this specification is subject to major changes. To ensure the best use of
language client maintainers time, we don't recommend OpenTelemetry clients to start
the implementation unless explicitly communicated via
[OTEP](https://github.com/open-telemetry/oteps#opentelemetry-enhancement-proposal-otep).

<details>
<summary>
Table of Contents
Expand All @@ -29,8 +14,8 @@ Table of Contents
* [SDK](#sdk)
* [Specifications](#specifications)
* [Metrics API](./api.md)
* Metrics SDK (not available yet)
* [Metrics Data Model and Protocol](datamodel.md)
* [Metrics SDK](./sdk.md)
* [Metrics Data Model and Protocol](./datamodel.md)
* [Semantic Conventions](./semantic_conventions/README.md)

</details>
Expand Down Expand Up @@ -72,8 +57,8 @@ The **OpenTelemetry Metrics API** ("the API" hereafter) serves two purposes:
* Decoupling the instrumentation from the [SDK](#sdk), allowing the SDK to be
specified/included in the application.

When no [SDK](#sdk) is explicitly included/enabled in the application, no telemetry data
will be collected. Please refer to the overall [OpenTelemetry
When no [SDK](#sdk) is explicitly included/enabled in the application, no
telemetry data will be collected. Please refer to the overall [OpenTelemetry
API](../overview.md#api) concept and [API and Minimal
Implementation](../library-guidelines.md#api-and-minimal-implementation) for
more information.
Expand All @@ -93,24 +78,28 @@ SDK](../overview.md#sdk) concept for more information.

```text
+------------------+
| MeterProvider |
| Meter A | +-----------+ +------------+ +----------+
| Instrument X | Measurements... | | | | | |
| Instrument Y +-----------------> Processor +--> Aggregator +--> Exporter +--> Another process
| Meter B | | | | | | |
| Instrument Z | +-----------+ +------------+ +----------+
| ... |
| ... |
| MeterProvider | +-----------------+ +--------------+
| Meter A | Measurements... | | Metrics... | |
| Instrument X +-----------------> In-memory state +-------------> MetricReader |
| Instrument Y | | | | |
| Meter B | +-----------------+ +--------------+
| Instrument Z |
| ... | +-----------------+ +--------------+
| ... | Measurements... | | Metrics... | |
| ... +-----------------> In-memory state +-------------> MetricReader |
| ... | | | | |
| ... | +-----------------+ +--------------+
+------------------+
```

## Specifications

* [Metrics API](./api.md)
* [Metrics SDK](./sdk.md)
* [Metrics Data Model and Protocol](datamodel.md)
* [Metrics Data Model and Protocol](./datamodel.md)
* [Semantic Conventions](./semantic_conventions/README.md)

## References

* Scenarios for Metrics API/SDK Prototyping ([OTEP 146](https://github.com/open-telemetry/oteps/blob/main/text/metrics/0146-metrics-prototype-scenarios.md))
* Scenarios for Metrics API/SDK Prototyping ([OTEP
146](https://github.com/open-telemetry/oteps/blob/main/text/metrics/0146-metrics-prototype-scenarios.md))

0 comments on commit c20b492

Please sign in to comment.