Skip to content

Commit c62fae8

Browse files
reyangcijothomasjmacd
authored
Remove MetricProcessor from the SDK spec (for now) (#1840)
* Remove MetricProcessor from the SDK spec (for now) * fix typo * fix links * Update specification/metrics/sdk.md Co-authored-by: Cijo Thomas <[email protected]> Co-authored-by: Cijo Thomas <[email protected]> Co-authored-by: Joshua MacDonald <[email protected]>
1 parent 7cef355 commit c62fae8

File tree

1 file changed

+22
-31
lines changed

1 file changed

+22
-31
lines changed

specification/metrics/sdk.md

+22-31
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ Table of Contents
2525
* [MeterProvider](#meterprovider)
2626
* [Attribute Limits](#attribute-limits)
2727
* [MeasurementProcessor](#measurementprocessor)
28-
* [MetricProcessor](#metricprocessor)
2928
* [MetricExporter](#metricexporter)
3029
* [Push Metric Exporter](#push-metric-exporter)
3130
* [Pull Metric Exporter](#pull-metric-exporter)
@@ -44,13 +43,13 @@ to create an
4443
instance which is stored on the created `Meter`.
4544

4645
Configuration (i.e., [MeasurementProcessors](#measurementprocessor),
47-
[MetricProcessors](#metricprocessor), [MetricExporters](#metricexporter) and
48-
[`Views`](#view)) MUST be managed solely by the `MeterProvider` and the SDK MUST
49-
provide a way to configure all options that are implemented by the SDK. This MAY be done at the
50-
time of MeterProvider creation if appropriate.
46+
[MetricExporters](#metricexporter) and [`Views`](#view)) MUST be managed solely
47+
by the `MeterProvider` and the SDK MUST provide a way to configure all options
48+
that are implemented by the SDK. This MAY be done at the time of MeterProvider
49+
creation if appropriate.
5150

5251
The `MeterProvider` MAY provide methods to update the configuration. If
53-
configuration is updated (e.g., adding a `MetricProcessor`), the updated
52+
configuration is updated (e.g., adding a `MeasurementProcessor`), the updated
5453
configuration MUST also apply to all already returned `Meters` (i.e. it MUST NOT
5554
matter whether a `Meter` was obtained from the `MeterProvider` before or after
5655
the configuration change). Note: Implementation-wise, this could mean that
@@ -256,31 +255,6 @@ active span](../trace/api.md#context-interaction)).
256255
+------------------+
257256
```
258257

259-
## MetricProcessor
260-
261-
`MetricProcessor` is an interface which allows hooks for [pre-aggregated metrics
262-
data](./datamodel.md#timeseries-model).
263-
264-
Built-in metric processors are responsible for batching and conversion of
265-
metrics data to exportable representation and passing batches to exporters.
266-
267-
The following diagram shows `MetricProcessor`'s relationship to other components
268-
in the SDK:
269-
270-
```text
271-
+-----------------+ +-----------------+ +-----------------------+
272-
| | Metrics... | | Metrics... | |
273-
| In-memory state +------------> MetricProcessor +------------> MetricExporter (push) +--> Another process
274-
| | | | | |
275-
+-----------------+ +-----------------+ +-----------------------+
276-
277-
+-----------------+ +-----------------+ +-----------------------+
278-
| | Metrics... | | Metrics... | |
279-
| In-memory state +------------> MetricProcessor +------------> MetricExporter (pull) +--> Another process (scraper)
280-
| | | | | |
281-
+-----------------+ +-----------------+ +-----------------------+
282-
```
283-
284258
## MetricExporter
285259

286260
`MetricExporter` defines the interface that protocol-specific exporters MUST
@@ -291,6 +265,23 @@ The goal of the interface is to minimize burden of implementation for
291265
protocol-dependent telemetry exporters. The protocol exporter is expected to be
292266
primarily a simple telemetry data encoder and transmitter.
293267

268+
The following diagram shows `MetricExporter`'s relationship to other components
269+
in the SDK:
270+
271+
```text
272+
+-----------------+ +-----------------------+
273+
| | Metrics... | |
274+
| In-memory state +------------> MetricExporter (push) +--> Another process
275+
| | | |
276+
+-----------------+ +-----------------------+
277+
278+
+-----------------+ +-----------------------+
279+
| | Metrics... | |
280+
| In-memory state +------------> MetricExporter (pull) +--> Another process (scraper)
281+
| | | |
282+
+-----------------+ +-----------------------+
283+
```
284+
294285
Metric Exporter has access to the [pre-aggregated metrics
295286
data](./datamodel.md#timeseries-model).
296287

0 commit comments

Comments
 (0)