From 60e82ccfd18906506a185f1880eb30c43f2c79cd Mon Sep 17 00:00:00 2001 From: David Ashpole Date: Fri, 28 Jul 2023 15:55:18 +0000 Subject: [PATCH] fix lint --- bridge/opencensus/doc.go | 9 +++++++++ bridge/opencensus/metric.go | 29 +++++++++++------------------ 2 files changed, 20 insertions(+), 18 deletions(-) diff --git a/bridge/opencensus/doc.go b/bridge/opencensus/doc.go index 80d80da6f786..d65bdef63602 100644 --- a/bridge/opencensus/doc.go +++ b/bridge/opencensus/doc.go @@ -32,4 +32,13 @@ // - Conversion of custom OpenCensus Samplers to OpenTelemetry is not // implemented. An error will be sent to the OpenTelemetry default // ErrorHandler if this is attempted. +// +// For Push Metric exporters: +// +// reader := metric.NewPeriodicReader(opencensus.NewMetricExporter(exporter)) +// +// For Prometheus Metric exporters: +// +// exporter := prometheus.NewExporter() +// exporter.Reader = opencensus.NewMetricReader() package opencensus // import "go.opentelemetry.io/otel/bridge/opencensus" diff --git a/bridge/opencensus/metric.go b/bridge/opencensus/metric.go index 0d3053514c21..53b9d2cc11cc 100644 --- a/bridge/opencensus/metric.go +++ b/bridge/opencensus/metric.go @@ -31,47 +31,40 @@ const scopeName = "go.opentelemetry.io/otel/bridge/opencensus" // NewMetricExporter returns an OpenTelemetry exporter that adds metrics from OpenCensus // before exporting to the base OpenTelemetry exporter. -// -// Usage: -// -// reader := metric.NewPeriodicReader(opencensus.NewMetricExporter(exporter)) -func NewMetricExporter(base metric.Exporter) *exporter { - return &exporter{ +func NewMetricExporter(base metric.Exporter) *Exporter { + return &Exporter{ Exporter: base, } } -// exporter wraps an OpenTelemetry exporter and adds OpenCensus metrics to it. -type exporter struct { +// Exporter wraps an OpenTelemetry exporter and adds OpenCensus metrics to it. +type Exporter struct { metric.Exporter } // Export exports a batch of metrics from the OpenTelemetry SDK, and adds // metrics from OpenCensus prior to exporting. -func (e *exporter) Export(ctx context.Context, sdkMetrics *metricdata.ResourceMetrics) error { +func (e *Exporter) Export(ctx context.Context, sdkMetrics *metricdata.ResourceMetrics) error { appendOpenCensusMetrics(sdkMetrics) return e.Exporter.Export(ctx, sdkMetrics) } // NewMetricReader wraps an existing metric reader, but overrides the Collect // function to insert metrics from OpenCensus. -// -// Usage: -// -// exporter := prometheus.NewExporter() -// exporter.Reader = opencensus.NewMetricReader() -func NewMetricReader(opts ...metric.ManualReaderOption) *reader { - return &reader{ +func NewMetricReader(opts ...metric.ManualReaderOption) *Reader { + return &Reader{ Reader: metric.NewManualReader(opts...), } } -type reader struct { +// Reader wraps a metric.Reader, and adds metrics from OpenCensus when Collect +// is invoked. +type Reader struct { metric.Reader } // Override the collect function with one that inserts metrics from OpenCensus. -func (r *reader) Collect(ctx context.Context, sdkMetrics *metricdata.ResourceMetrics) error { +func (r *Reader) Collect(ctx context.Context, sdkMetrics *metricdata.ResourceMetrics) error { // Collect metrics from the OTel SDK err := r.Reader.Collect(ctx, sdkMetrics) if err != nil {