-
Notifications
You must be signed in to change notification settings - Fork 576
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
autoexport: Add support for metrics (#4229)
- Loading branch information
Showing
13 changed files
with
479 additions
and
349 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package autoexport // import "go.opentelemetry.io/contrib/exporters/autoexport" | ||
|
|
||
| import ( | ||
| "context" | ||
| "os" | ||
|
|
||
| "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc" | ||
| "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp" | ||
| "go.opentelemetry.io/otel/sdk/metric" | ||
| ) | ||
|
|
||
| // MetricOption applies an autoexport configuration option. | ||
| type MetricOption = option[metric.Reader] | ||
|
|
||
| // WithFallbackMetricReader sets the fallback exporter to use when no exporter | ||
| // is configured through the OTEL_METRICS_EXPORTER environment variable. | ||
| func WithFallbackMetricReader(exporter metric.Reader) MetricOption { | ||
| return withFallback[metric.Reader](exporter) | ||
| } | ||
|
|
||
| // NewMetricReader returns a configured [go.opentelemetry.io/otel/sdk/metric.Reader] | ||
| // defined using the environment variables described below. | ||
| // | ||
| // OTEL_METRICS_EXPORTER defines the metrics exporter; supported values: | ||
| // - "none" - "no operation" exporter | ||
| // - "otlp" (default) - OTLP exporter; see [go.opentelemetry.io/otel/exporters/otlp/otlpmetric] | ||
| // | ||
| // OTEL_EXPORTER_OTLP_PROTOCOL defines OTLP exporter's transport protocol; | ||
| // supported values: | ||
| // - "grpc" - protobuf-encoded data using gRPC wire format over HTTP/2 connection; | ||
| // see: [go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc] | ||
| // - "http/protobuf" (default) - protobuf-encoded data over HTTP connection; | ||
| // see: [go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp] | ||
| // | ||
| // An error is returned if an environment value is set to an unhandled value. | ||
| // | ||
| // Use [RegisterMetricReader] to handle more values of OTEL_METRICS_EXPORTER. | ||
| // | ||
| // Use [WithFallbackMetricReader] option to change the returned exporter | ||
| // when OTEL_TRACES_EXPORTER is unset or empty. | ||
| // | ||
| // Use [IsNoneMetricReader] to check if the retured exporter is a "no operation" exporter. | ||
| func NewMetricReader(ctx context.Context, opts ...MetricOption) (metric.Reader, error) { | ||
| return metricsSignal.create(ctx, opts...) | ||
| } | ||
|
|
||
| // RegisterMetricReader sets the MetricReader factory to be used when the | ||
| // OTEL_METRICS_EXPORTERS environment variable contains the exporter name. This | ||
| // will panic if name has already been registered. | ||
| func RegisterMetricReader(name string, factory func(context.Context) (metric.Reader, error)) { | ||
| must(metricsSignal.registry.store(name, factory)) | ||
| } | ||
|
|
||
| var metricsSignal = newSignal[metric.Reader]("OTEL_METRICS_EXPORTER") | ||
|
|
||
| func init() { | ||
| RegisterMetricReader("otlp", func(ctx context.Context) (metric.Reader, error) { | ||
| proto := os.Getenv(otelExporterOTLPProtoEnvKey) | ||
| if proto == "" { | ||
| proto = "http/protobuf" | ||
| } | ||
|
|
||
| switch proto { | ||
| case "grpc": | ||
| r, err := otlpmetricgrpc.New(ctx) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return metric.NewPeriodicReader(r), nil | ||
| case "http/protobuf": | ||
| r, err := otlpmetrichttp.New(ctx) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return metric.NewPeriodicReader(r), nil | ||
| default: | ||
| return nil, errInvalidOTLPProtocol | ||
| } | ||
| }) | ||
| RegisterMetricReader("none", func(ctx context.Context) (metric.Reader, error) { | ||
| return newNoopMetricReader(), nil | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package autoexport // import "go.opentelemetry.io/contrib/exporters/autoexport" | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "reflect" | ||
| "testing" | ||
|
|
||
| "go.opentelemetry.io/otel/sdk/metric" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestMetricExporterNone(t *testing.T) { | ||
| t.Setenv("OTEL_METRICS_EXPORTER", "none") | ||
| got, err := NewMetricReader(context.Background()) | ||
| assert.NoError(t, err) | ||
| assert.True(t, IsNoneMetricReader(got)) | ||
| } | ||
|
|
||
| func TestMetricExporterOTLP(t *testing.T) { | ||
| t.Setenv("OTEL_METRICS_EXPORTER", "otlp") | ||
|
|
||
| for _, tc := range []struct { | ||
| protocol, exporterType string | ||
| }{ | ||
| {"http/protobuf", "*otlpmetrichttp.Exporter"}, | ||
| {"", "*otlpmetrichttp.Exporter"}, | ||
| {"grpc", "*otlpmetricgrpc.Exporter"}, | ||
| } { | ||
| t.Run(fmt.Sprintf("protocol=%q", tc.protocol), func(t *testing.T) { | ||
| t.Setenv("OTEL_EXPORTER_OTLP_PROTOCOL", tc.protocol) | ||
|
|
||
| got, err := NewMetricReader(context.Background()) | ||
| assert.NoError(t, err) | ||
| assert.IsType(t, &metric.PeriodicReader{}, got) | ||
|
|
||
| // Implementation detail hack. This may break when bumping OTLP exporter modules as it uses unexported API. | ||
| exporterType := reflect.Indirect(reflect.ValueOf(got)).FieldByName("exporter").Elem().Type() | ||
| assert.Equal(t, tc.exporterType, exporterType.String()) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestMetricExporterOTLPOverInvalidProtocol(t *testing.T) { | ||
| t.Setenv("OTEL_METRICS_EXPORTER", "otlp") | ||
| t.Setenv("OTEL_EXPORTER_OTLP_PROTOCOL", "invalid-protocol") | ||
|
|
||
| _, err := NewMetricReader(context.Background()) | ||
| assert.Error(t, err) | ||
| } |
Oops, something went wrong.