Skip to content

Commit 4e4d3b2

Browse files
authored
Add notes about MetricExporter naming (#2286)
If the implementors choose to implement pull metric exporters modeled as a metric reader, the only variant for metric exporter interface is push metric exporter. While the pull metric exporter is modeled as a "metric reader", the better naming for the genric "metric exporter" interface may be "push metric exporter". Just open this PR to see if there are similar naming confusions with other SDK implementors. If so, I'd believe the metric exporter and metric reader section need a re-structure in a follow-up PR since how the pull metric exporter is modeled is important to the naming of the metric exporter interface. Related: - open-telemetry/opentelemetry-js#2707 - open-telemetry/opentelemetry-js#2589 (comment)
1 parent 9ffad66 commit 4e4d3b2

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

specification/metrics/sdk.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -876,7 +876,9 @@ Implementors MAY choose the best idiomatic design for their language. For
876876
example, they could generalize the [Push Metric Exporter
877877
interface](#push-metric-exporter) design and use that for consistency, they
878878
could model the pull exporter as [MetricReader](#metricreader), or they could
879-
design a completely different pull exporter interface.
879+
design a completely different pull exporter interface. If the pull exporter is
880+
modeled as MetricReader, implementors MAY name the MetricExporter interface as
881+
PushMetricExporter to prevent naming confusion.
880882

881883
The following diagram gives some examples on how `Pull Metric Exporter` can be
882884
modeled to interact with other components in the SDK:

0 commit comments

Comments
 (0)