mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-28 21:09:17 +02:00
1064 lines
34 KiB
Go
1064 lines
34 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package prometheus
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"io"
|
|
"os"
|
|
"sync"
|
|
"testing"
|
|
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
"github.com/prometheus/client_golang/prometheus/testutil"
|
|
dto "github.com/prometheus/client_model/go"
|
|
"github.com/prometheus/common/model"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"go.opentelemetry.io/otel"
|
|
"go.opentelemetry.io/otel/attribute"
|
|
otelmetric "go.opentelemetry.io/otel/metric"
|
|
"go.opentelemetry.io/otel/sdk/metric"
|
|
"go.opentelemetry.io/otel/sdk/resource"
|
|
semconv "go.opentelemetry.io/otel/semconv/v1.26.0"
|
|
"go.opentelemetry.io/otel/trace"
|
|
)
|
|
|
|
func TestPrometheusExporter(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
emptyResource bool
|
|
customResourceAttrs []attribute.KeyValue
|
|
recordMetrics func(ctx context.Context, meter otelmetric.Meter)
|
|
options []Option
|
|
expectedFile string
|
|
enableUTF8 bool
|
|
}{
|
|
{
|
|
name: "counter",
|
|
expectedFile: "testdata/counter.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
)
|
|
counter, err := meter.Float64Counter(
|
|
"foo",
|
|
otelmetric.WithDescription("a simple counter"),
|
|
otelmetric.WithUnit("s"),
|
|
)
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, opt)
|
|
counter.Add(ctx, 10.3, opt)
|
|
counter.Add(ctx, 9, opt)
|
|
|
|
attrs2 := attribute.NewSet(
|
|
attribute.Key("A").String("D"),
|
|
attribute.Key("C").String("B"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
)
|
|
counter.Add(ctx, 5, otelmetric.WithAttributeSet(attrs2))
|
|
},
|
|
},
|
|
{
|
|
name: "counter that already has the unit suffix",
|
|
expectedFile: "testdata/counter.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
)
|
|
counter, err := meter.Float64Counter(
|
|
"foo.seconds",
|
|
otelmetric.WithDescription("a simple counter"),
|
|
otelmetric.WithUnit("s"),
|
|
)
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, opt)
|
|
counter.Add(ctx, 10.3, opt)
|
|
counter.Add(ctx, 9, opt)
|
|
|
|
attrs2 := attribute.NewSet(
|
|
attribute.Key("A").String("D"),
|
|
attribute.Key("C").String("B"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
)
|
|
counter.Add(ctx, 5, otelmetric.WithAttributeSet(attrs2))
|
|
},
|
|
},
|
|
{
|
|
name: "counter that already has a total suffix",
|
|
expectedFile: "testdata/counter.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
)
|
|
counter, err := meter.Float64Counter(
|
|
"foo.total",
|
|
otelmetric.WithDescription("a simple counter"),
|
|
otelmetric.WithUnit("s"),
|
|
)
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, opt)
|
|
counter.Add(ctx, 10.3, opt)
|
|
counter.Add(ctx, 9, opt)
|
|
|
|
attrs2 := attribute.NewSet(
|
|
attribute.Key("A").String("D"),
|
|
attribute.Key("C").String("B"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
)
|
|
counter.Add(ctx, 5, otelmetric.WithAttributeSet(attrs2))
|
|
},
|
|
},
|
|
{
|
|
name: "counter with suffixes disabled",
|
|
expectedFile: "testdata/counter_disabled_suffix.txt",
|
|
options: []Option{WithoutCounterSuffixes()},
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
)
|
|
counter, err := meter.Float64Counter(
|
|
"foo",
|
|
otelmetric.WithDescription("a simple counter without a total suffix"),
|
|
otelmetric.WithUnit("s"),
|
|
)
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, opt)
|
|
counter.Add(ctx, 10.3, opt)
|
|
counter.Add(ctx, 9, opt)
|
|
|
|
attrs2 := attribute.NewSet(
|
|
attribute.Key("A").String("D"),
|
|
attribute.Key("C").String("B"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
)
|
|
counter.Add(ctx, 5, otelmetric.WithAttributeSet(attrs2))
|
|
},
|
|
},
|
|
{
|
|
name: "gauge",
|
|
expectedFile: "testdata/gauge.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
)
|
|
gauge, err := meter.Float64UpDownCounter(
|
|
"bar",
|
|
otelmetric.WithDescription("a fun little gauge"),
|
|
otelmetric.WithUnit("1"),
|
|
)
|
|
require.NoError(t, err)
|
|
gauge.Add(ctx, 1.0, opt)
|
|
gauge.Add(ctx, -.25, opt)
|
|
},
|
|
},
|
|
{
|
|
name: "histogram",
|
|
expectedFile: "testdata/histogram.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
)
|
|
histogram, err := meter.Float64Histogram(
|
|
"histogram_baz",
|
|
otelmetric.WithDescription("a very nice histogram"),
|
|
otelmetric.WithUnit("By"),
|
|
)
|
|
require.NoError(t, err)
|
|
histogram.Record(ctx, 23, opt)
|
|
histogram.Record(ctx, 7, opt)
|
|
histogram.Record(ctx, 101, opt)
|
|
histogram.Record(ctx, 105, opt)
|
|
},
|
|
},
|
|
{
|
|
name: "sanitized attributes to labels",
|
|
expectedFile: "testdata/sanitized_labels.txt",
|
|
options: []Option{WithoutUnits()},
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
opt := otelmetric.WithAttributes(
|
|
// exact match, value should be overwritten
|
|
attribute.Key("A.B").String("X"),
|
|
attribute.Key("A.B").String("Q"),
|
|
|
|
// unintended match due to sanitization, values should be concatenated
|
|
attribute.Key("C.D").String("Y"),
|
|
attribute.Key("C/D").String("Z"),
|
|
)
|
|
counter, err := meter.Float64Counter(
|
|
"foo",
|
|
otelmetric.WithDescription("a sanitary counter"),
|
|
// This unit is not added to
|
|
otelmetric.WithUnit("By"),
|
|
)
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, opt)
|
|
counter.Add(ctx, 10.3, opt)
|
|
counter.Add(ctx, 9, opt)
|
|
},
|
|
},
|
|
{
|
|
name: "invalid instruments are renamed",
|
|
expectedFile: "testdata/sanitized_names.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
)
|
|
// Valid.
|
|
gauge, err := meter.Float64UpDownCounter("bar", otelmetric.WithDescription("a fun little gauge"))
|
|
require.NoError(t, err)
|
|
gauge.Add(ctx, 100, opt)
|
|
gauge.Add(ctx, -25, opt)
|
|
|
|
// Invalid, will be renamed.
|
|
gauge, err = meter.Float64UpDownCounter("invalid.gauge.name", otelmetric.WithDescription("a gauge with an invalid name"))
|
|
require.NoError(t, err)
|
|
gauge.Add(ctx, 100, opt)
|
|
|
|
counter, err := meter.Float64Counter("0invalid.counter.name", otelmetric.WithDescription("a counter with an invalid name"))
|
|
require.ErrorIs(t, err, metric.ErrInstrumentName)
|
|
counter.Add(ctx, 100, opt)
|
|
|
|
histogram, err := meter.Float64Histogram("invalid.hist.name", otelmetric.WithDescription("a histogram with an invalid name"))
|
|
require.NoError(t, err)
|
|
histogram.Record(ctx, 23, opt)
|
|
},
|
|
},
|
|
{
|
|
name: "empty resource",
|
|
emptyResource: true,
|
|
expectedFile: "testdata/empty_resource.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
)
|
|
counter, err := meter.Float64Counter("foo", otelmetric.WithDescription("a simple counter"))
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, opt)
|
|
counter.Add(ctx, 10.3, opt)
|
|
counter.Add(ctx, 9, opt)
|
|
},
|
|
},
|
|
{
|
|
name: "custom resource",
|
|
customResourceAttrs: []attribute.KeyValue{
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
},
|
|
expectedFile: "testdata/custom_resource.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
)
|
|
counter, err := meter.Float64Counter("foo", otelmetric.WithDescription("a simple counter"))
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, opt)
|
|
counter.Add(ctx, 10.3, opt)
|
|
counter.Add(ctx, 9, opt)
|
|
},
|
|
},
|
|
{
|
|
name: "without target_info",
|
|
options: []Option{WithoutTargetInfo()},
|
|
expectedFile: "testdata/without_target_info.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
)
|
|
counter, err := meter.Float64Counter("foo", otelmetric.WithDescription("a simple counter"))
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, opt)
|
|
counter.Add(ctx, 10.3, opt)
|
|
counter.Add(ctx, 9, opt)
|
|
},
|
|
},
|
|
{
|
|
name: "without scope_info",
|
|
options: []Option{WithoutScopeInfo()},
|
|
expectedFile: "testdata/without_scope_info.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
)
|
|
gauge, err := meter.Int64UpDownCounter(
|
|
"bar",
|
|
otelmetric.WithDescription("a fun little gauge"),
|
|
otelmetric.WithUnit("1"),
|
|
)
|
|
require.NoError(t, err)
|
|
gauge.Add(ctx, 2, opt)
|
|
gauge.Add(ctx, -1, opt)
|
|
},
|
|
},
|
|
{
|
|
name: "without scope_info and target_info",
|
|
options: []Option{WithoutScopeInfo(), WithoutTargetInfo()},
|
|
expectedFile: "testdata/without_scope_and_target_info.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
)
|
|
counter, err := meter.Int64Counter(
|
|
"bar",
|
|
otelmetric.WithDescription("a fun little counter"),
|
|
otelmetric.WithUnit("By"),
|
|
)
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 2, opt)
|
|
counter.Add(ctx, 1, opt)
|
|
},
|
|
},
|
|
{
|
|
name: "with namespace",
|
|
expectedFile: "testdata/with_namespace.txt",
|
|
options: []Option{
|
|
WithNamespace("test"),
|
|
},
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
)
|
|
counter, err := meter.Float64Counter("foo", otelmetric.WithDescription("a simple counter"))
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, opt)
|
|
counter.Add(ctx, 10.3, opt)
|
|
counter.Add(ctx, 9, opt)
|
|
},
|
|
},
|
|
{
|
|
name: "with resource attributes filter",
|
|
expectedFile: "testdata/with_resource_attributes_filter.txt",
|
|
options: []Option{
|
|
WithResourceAsConstantLabels(attribute.NewDenyKeysFilter()),
|
|
},
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
)
|
|
counter, err := meter.Float64Counter("foo", otelmetric.WithDescription("a simple counter"))
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, opt)
|
|
counter.Add(ctx, 10.1, opt)
|
|
counter.Add(ctx, 9.8, opt)
|
|
},
|
|
},
|
|
{
|
|
name: "with some resource attributes filter",
|
|
expectedFile: "testdata/with_allow_resource_attributes_filter.txt",
|
|
options: []Option{
|
|
WithResourceAsConstantLabels(attribute.NewAllowKeysFilter("service.name")),
|
|
},
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
)
|
|
counter, err := meter.Float64Counter("foo", otelmetric.WithDescription("a simple counter"))
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, opt)
|
|
counter.Add(ctx, 5.9, opt)
|
|
counter.Add(ctx, 5.3, opt)
|
|
},
|
|
},
|
|
{
|
|
name: "counter utf-8",
|
|
expectedFile: "testdata/counter_utf8.txt",
|
|
enableUTF8: true,
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A.G").String("B"),
|
|
attribute.Key("C.H").String("D"),
|
|
attribute.Key("E.I").Bool(true),
|
|
attribute.Key("F.J").Int(42),
|
|
)
|
|
counter, err := meter.Float64Counter(
|
|
"foo.things",
|
|
otelmetric.WithDescription("a simple counter"),
|
|
otelmetric.WithUnit("s"),
|
|
)
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, opt)
|
|
counter.Add(ctx, 10.3, opt)
|
|
counter.Add(ctx, 9, opt)
|
|
|
|
attrs2 := attribute.NewSet(
|
|
attribute.Key("A.G").String("D"),
|
|
attribute.Key("C.H").String("B"),
|
|
attribute.Key("E.I").Bool(true),
|
|
attribute.Key("F.J").Int(42),
|
|
)
|
|
counter.Add(ctx, 5, otelmetric.WithAttributeSet(attrs2))
|
|
},
|
|
},
|
|
{
|
|
name: "non-monotonic sum does not add exemplars",
|
|
expectedFile: "testdata/non_monotonic_sum_does_not_add_exemplars.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
sc := trace.NewSpanContext(trace.SpanContextConfig{
|
|
SpanID: trace.SpanID{0o1},
|
|
TraceID: trace.TraceID{0o1},
|
|
TraceFlags: trace.FlagsSampled,
|
|
})
|
|
ctx = trace.ContextWithSpanContext(ctx, sc)
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
)
|
|
counter, err := meter.Float64UpDownCounter(
|
|
"foo",
|
|
otelmetric.WithDescription("a simple up down counter"),
|
|
otelmetric.WithUnit("s"),
|
|
)
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, opt)
|
|
counter.Add(ctx, 10.3, opt)
|
|
counter.Add(ctx, 9, opt)
|
|
counter.Add(ctx, -1, opt)
|
|
|
|
attrs2 := attribute.NewSet(
|
|
attribute.Key("A").String("D"),
|
|
attribute.Key("C").String("B"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
)
|
|
counter.Add(ctx, 5, otelmetric.WithAttributeSet(attrs2))
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
if tc.enableUTF8 {
|
|
model.NameValidationScheme = model.UTF8Validation
|
|
defer func() {
|
|
// Reset to defaults
|
|
model.NameValidationScheme = model.LegacyValidation
|
|
}()
|
|
}
|
|
ctx := context.Background()
|
|
registry := prometheus.NewRegistry()
|
|
exporter, err := New(append(tc.options, WithRegisterer(registry))...)
|
|
require.NoError(t, err)
|
|
|
|
var res *resource.Resource
|
|
if tc.emptyResource {
|
|
res = resource.Empty()
|
|
} else {
|
|
res, err = resource.New(ctx,
|
|
// always specify service.name because the default depends on the running OS
|
|
resource.WithAttributes(semconv.ServiceName("prometheus_test")),
|
|
// Overwrite the semconv.TelemetrySDKVersionKey value so we don't need to update every version
|
|
resource.WithAttributes(semconv.TelemetrySDKVersion("latest")),
|
|
resource.WithAttributes(tc.customResourceAttrs...),
|
|
)
|
|
require.NoError(t, err)
|
|
|
|
res, err = resource.Merge(resource.Default(), res)
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
provider := metric.NewMeterProvider(
|
|
metric.WithResource(res),
|
|
metric.WithReader(exporter),
|
|
metric.WithView(metric.NewView(
|
|
metric.Instrument{Name: "histogram_*"},
|
|
metric.Stream{Aggregation: metric.AggregationExplicitBucketHistogram{
|
|
Boundaries: []float64{0, 5, 10, 25, 50, 75, 100, 250, 500, 1000},
|
|
}},
|
|
)),
|
|
)
|
|
meter := provider.Meter(
|
|
"testmeter",
|
|
otelmetric.WithInstrumentationVersion("v0.1.0"),
|
|
otelmetric.WithInstrumentationAttributes(attribute.String("fizz", "buzz")),
|
|
)
|
|
|
|
tc.recordMetrics(ctx, meter)
|
|
|
|
file, err := os.Open(tc.expectedFile)
|
|
require.NoError(t, err)
|
|
t.Cleanup(func() { require.NoError(t, file.Close()) })
|
|
|
|
err = testutil.GatherAndCompare(registry, file)
|
|
require.NoError(t, err)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestMultiScopes(t *testing.T) {
|
|
ctx := context.Background()
|
|
registry := prometheus.NewRegistry()
|
|
exporter, err := New(WithRegisterer(registry))
|
|
require.NoError(t, err)
|
|
|
|
res, err := resource.New(ctx,
|
|
// always specify service.name because the default depends on the running OS
|
|
resource.WithAttributes(semconv.ServiceName("prometheus_test")),
|
|
// Overwrite the semconv.TelemetrySDKVersionKey value so we don't need to update every version
|
|
resource.WithAttributes(semconv.TelemetrySDKVersion("latest")),
|
|
)
|
|
require.NoError(t, err)
|
|
res, err = resource.Merge(resource.Default(), res)
|
|
require.NoError(t, err)
|
|
|
|
provider := metric.NewMeterProvider(
|
|
metric.WithReader(exporter),
|
|
metric.WithResource(res),
|
|
)
|
|
|
|
fooCounter, err := provider.Meter("meterfoo", otelmetric.WithInstrumentationVersion("v0.1.0")).
|
|
Int64Counter(
|
|
"foo",
|
|
otelmetric.WithUnit("s"),
|
|
otelmetric.WithDescription("meter foo counter"))
|
|
assert.NoError(t, err)
|
|
fooCounter.Add(ctx, 100, otelmetric.WithAttributes(attribute.String("type", "foo")))
|
|
|
|
barCounter, err := provider.Meter("meterbar", otelmetric.WithInstrumentationVersion("v0.1.0")).
|
|
Int64Counter(
|
|
"bar",
|
|
otelmetric.WithUnit("s"),
|
|
otelmetric.WithDescription("meter bar counter"))
|
|
assert.NoError(t, err)
|
|
barCounter.Add(ctx, 200, otelmetric.WithAttributes(attribute.String("type", "bar")))
|
|
|
|
file, err := os.Open("testdata/multi_scopes.txt")
|
|
require.NoError(t, err)
|
|
t.Cleanup(func() { require.NoError(t, file.Close()) })
|
|
|
|
err = testutil.GatherAndCompare(registry, file)
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
func TestDuplicateMetrics(t *testing.T) {
|
|
ab := attribute.NewSet(attribute.String("A", "B"))
|
|
withAB := otelmetric.WithAttributeSet(ab)
|
|
typeBar := attribute.NewSet(attribute.String("type", "bar"))
|
|
withTypeBar := otelmetric.WithAttributeSet(typeBar)
|
|
typeFoo := attribute.NewSet(attribute.String("type", "foo"))
|
|
withTypeFoo := otelmetric.WithAttributeSet(typeFoo)
|
|
testCases := []struct {
|
|
name string
|
|
customResourceAttrs []attribute.KeyValue
|
|
recordMetrics func(ctx context.Context, meterA, meterB otelmetric.Meter)
|
|
options []Option
|
|
possibleExpectedFiles []string
|
|
}{
|
|
{
|
|
name: "no_conflict_two_counters",
|
|
recordMetrics: func(ctx context.Context, meterA, meterB otelmetric.Meter) {
|
|
fooA, err := meterA.Int64Counter("foo",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter counter foo"))
|
|
assert.NoError(t, err)
|
|
fooA.Add(ctx, 100, withAB)
|
|
|
|
fooB, err := meterB.Int64Counter("foo",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter counter foo"))
|
|
assert.NoError(t, err)
|
|
fooB.Add(ctx, 100, withAB)
|
|
},
|
|
possibleExpectedFiles: []string{"testdata/no_conflict_two_counters.txt"},
|
|
},
|
|
{
|
|
name: "no_conflict_two_updowncounters",
|
|
recordMetrics: func(ctx context.Context, meterA, meterB otelmetric.Meter) {
|
|
fooA, err := meterA.Int64UpDownCounter("foo",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter gauge foo"))
|
|
assert.NoError(t, err)
|
|
fooA.Add(ctx, 100, withAB)
|
|
|
|
fooB, err := meterB.Int64UpDownCounter("foo",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter gauge foo"))
|
|
assert.NoError(t, err)
|
|
fooB.Add(ctx, 100, withAB)
|
|
},
|
|
possibleExpectedFiles: []string{"testdata/no_conflict_two_updowncounters.txt"},
|
|
},
|
|
{
|
|
name: "no_conflict_two_histograms",
|
|
recordMetrics: func(ctx context.Context, meterA, meterB otelmetric.Meter) {
|
|
fooA, err := meterA.Int64Histogram("foo",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter histogram foo"))
|
|
assert.NoError(t, err)
|
|
fooA.Record(ctx, 100, withAB)
|
|
|
|
fooB, err := meterB.Int64Histogram("foo",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter histogram foo"))
|
|
assert.NoError(t, err)
|
|
fooB.Record(ctx, 100, withAB)
|
|
},
|
|
possibleExpectedFiles: []string{"testdata/no_conflict_two_histograms.txt"},
|
|
},
|
|
{
|
|
name: "conflict_help_two_counters",
|
|
recordMetrics: func(ctx context.Context, meterA, meterB otelmetric.Meter) {
|
|
barA, err := meterA.Int64Counter("bar",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter a bar"))
|
|
assert.NoError(t, err)
|
|
barA.Add(ctx, 100, withTypeBar)
|
|
|
|
barB, err := meterB.Int64Counter("bar",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter b bar"))
|
|
assert.NoError(t, err)
|
|
barB.Add(ctx, 100, withTypeBar)
|
|
},
|
|
possibleExpectedFiles: []string{
|
|
"testdata/conflict_help_two_counters_1.txt",
|
|
"testdata/conflict_help_two_counters_2.txt",
|
|
},
|
|
},
|
|
{
|
|
name: "conflict_help_two_updowncounters",
|
|
recordMetrics: func(ctx context.Context, meterA, meterB otelmetric.Meter) {
|
|
barA, err := meterA.Int64UpDownCounter("bar",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter a bar"))
|
|
assert.NoError(t, err)
|
|
barA.Add(ctx, 100, withTypeBar)
|
|
|
|
barB, err := meterB.Int64UpDownCounter("bar",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter b bar"))
|
|
assert.NoError(t, err)
|
|
barB.Add(ctx, 100, withTypeBar)
|
|
},
|
|
possibleExpectedFiles: []string{
|
|
"testdata/conflict_help_two_updowncounters_1.txt",
|
|
"testdata/conflict_help_two_updowncounters_2.txt",
|
|
},
|
|
},
|
|
{
|
|
name: "conflict_help_two_histograms",
|
|
recordMetrics: func(ctx context.Context, meterA, meterB otelmetric.Meter) {
|
|
barA, err := meterA.Int64Histogram("bar",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter a bar"))
|
|
assert.NoError(t, err)
|
|
barA.Record(ctx, 100, withAB)
|
|
|
|
barB, err := meterB.Int64Histogram("bar",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter b bar"))
|
|
assert.NoError(t, err)
|
|
barB.Record(ctx, 100, withAB)
|
|
},
|
|
possibleExpectedFiles: []string{
|
|
"testdata/conflict_help_two_histograms_1.txt",
|
|
"testdata/conflict_help_two_histograms_2.txt",
|
|
},
|
|
},
|
|
{
|
|
name: "conflict_unit_two_counters",
|
|
recordMetrics: func(ctx context.Context, meterA, meterB otelmetric.Meter) {
|
|
bazA, err := meterA.Int64Counter("bar",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter bar"))
|
|
assert.NoError(t, err)
|
|
bazA.Add(ctx, 100, withTypeBar)
|
|
|
|
bazB, err := meterB.Int64Counter("bar",
|
|
otelmetric.WithUnit("s"),
|
|
otelmetric.WithDescription("meter bar"))
|
|
assert.NoError(t, err)
|
|
bazB.Add(ctx, 100, withTypeBar)
|
|
},
|
|
options: []Option{WithoutUnits()},
|
|
possibleExpectedFiles: []string{"testdata/conflict_unit_two_counters.txt"},
|
|
},
|
|
{
|
|
name: "conflict_unit_two_updowncounters",
|
|
recordMetrics: func(ctx context.Context, meterA, meterB otelmetric.Meter) {
|
|
barA, err := meterA.Int64UpDownCounter("bar",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter gauge bar"))
|
|
assert.NoError(t, err)
|
|
barA.Add(ctx, 100, withTypeBar)
|
|
|
|
barB, err := meterB.Int64UpDownCounter("bar",
|
|
otelmetric.WithUnit("s"),
|
|
otelmetric.WithDescription("meter gauge bar"))
|
|
assert.NoError(t, err)
|
|
barB.Add(ctx, 100, withTypeBar)
|
|
},
|
|
options: []Option{WithoutUnits()},
|
|
possibleExpectedFiles: []string{"testdata/conflict_unit_two_updowncounters.txt"},
|
|
},
|
|
{
|
|
name: "conflict_unit_two_histograms",
|
|
recordMetrics: func(ctx context.Context, meterA, meterB otelmetric.Meter) {
|
|
barA, err := meterA.Int64Histogram("bar",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter histogram bar"))
|
|
assert.NoError(t, err)
|
|
barA.Record(ctx, 100, withAB)
|
|
|
|
barB, err := meterB.Int64Histogram("bar",
|
|
otelmetric.WithUnit("s"),
|
|
otelmetric.WithDescription("meter histogram bar"))
|
|
assert.NoError(t, err)
|
|
barB.Record(ctx, 100, withAB)
|
|
},
|
|
options: []Option{WithoutUnits()},
|
|
possibleExpectedFiles: []string{"testdata/conflict_unit_two_histograms.txt"},
|
|
},
|
|
{
|
|
name: "conflict_type_counter_and_updowncounter",
|
|
recordMetrics: func(ctx context.Context, meterA, meterB otelmetric.Meter) {
|
|
counter, err := meterA.Int64Counter("foo",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter foo"))
|
|
assert.NoError(t, err)
|
|
counter.Add(ctx, 100, withTypeFoo)
|
|
|
|
gauge, err := meterA.Int64UpDownCounter("foo_total",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter foo"))
|
|
assert.NoError(t, err)
|
|
gauge.Add(ctx, 200, withTypeFoo)
|
|
},
|
|
options: []Option{WithoutUnits()},
|
|
possibleExpectedFiles: []string{
|
|
"testdata/conflict_type_counter_and_updowncounter_1.txt",
|
|
"testdata/conflict_type_counter_and_updowncounter_2.txt",
|
|
},
|
|
},
|
|
{
|
|
name: "conflict_type_histogram_and_updowncounter",
|
|
recordMetrics: func(ctx context.Context, meterA, meterB otelmetric.Meter) {
|
|
fooA, err := meterA.Int64UpDownCounter("foo",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter gauge foo"))
|
|
assert.NoError(t, err)
|
|
fooA.Add(ctx, 100, withAB)
|
|
|
|
fooHistogramA, err := meterA.Int64Histogram("foo",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter histogram foo"))
|
|
assert.NoError(t, err)
|
|
fooHistogramA.Record(ctx, 100, withAB)
|
|
},
|
|
possibleExpectedFiles: []string{
|
|
"testdata/conflict_type_histogram_and_updowncounter_1.txt",
|
|
"testdata/conflict_type_histogram_and_updowncounter_2.txt",
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
// initialize registry exporter
|
|
ctx := context.Background()
|
|
registry := prometheus.NewRegistry()
|
|
exporter, err := New(append(tc.options, WithRegisterer(registry))...)
|
|
require.NoError(t, err)
|
|
|
|
// initialize resource
|
|
res, err := resource.New(ctx,
|
|
resource.WithAttributes(semconv.ServiceName("prometheus_test")),
|
|
resource.WithAttributes(semconv.TelemetrySDKVersion("latest")),
|
|
)
|
|
require.NoError(t, err)
|
|
res, err = resource.Merge(resource.Default(), res)
|
|
require.NoError(t, err)
|
|
|
|
// initialize provider
|
|
provider := metric.NewMeterProvider(
|
|
metric.WithReader(exporter),
|
|
metric.WithResource(res),
|
|
)
|
|
|
|
// initialize two meter a, b
|
|
meterA := provider.Meter("ma", otelmetric.WithInstrumentationVersion("v0.1.0"))
|
|
meterB := provider.Meter("mb", otelmetric.WithInstrumentationVersion("v0.1.0"))
|
|
|
|
tc.recordMetrics(ctx, meterA, meterB)
|
|
|
|
match := false
|
|
for _, filename := range tc.possibleExpectedFiles {
|
|
file, ferr := os.Open(filename)
|
|
require.NoError(t, ferr)
|
|
t.Cleanup(func() { require.NoError(t, file.Close()) })
|
|
|
|
err = testutil.GatherAndCompare(registry, file)
|
|
if err == nil {
|
|
match = true
|
|
break
|
|
}
|
|
}
|
|
require.Truef(t, match, "expected export not produced: %v", err)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestCollectorConcurrentSafe(t *testing.T) {
|
|
// This tests makes sure that the implemented
|
|
// https://pkg.go.dev/github.com/prometheus/client_golang/prometheus#Collector
|
|
// is concurrent safe.
|
|
ctx := context.Background()
|
|
registry := prometheus.NewRegistry()
|
|
exporter, err := New(WithRegisterer(registry))
|
|
require.NoError(t, err)
|
|
provider := metric.NewMeterProvider(metric.WithReader(exporter))
|
|
meter := provider.Meter("testmeter")
|
|
cnt, err := meter.Int64Counter("foo")
|
|
require.NoError(t, err)
|
|
cnt.Add(ctx, 100)
|
|
|
|
var wg sync.WaitGroup
|
|
concurrencyLevel := 10
|
|
for i := 0; i < concurrencyLevel; i++ {
|
|
wg.Add(1)
|
|
go func() {
|
|
defer wg.Done()
|
|
_, err := registry.Gather() // this calls collector.Collect
|
|
assert.NoError(t, err)
|
|
}()
|
|
}
|
|
|
|
wg.Wait()
|
|
}
|
|
|
|
func TestIncompatibleMeterName(t *testing.T) {
|
|
defer func(orig otel.ErrorHandler) {
|
|
otel.SetErrorHandler(orig)
|
|
}(otel.GetErrorHandler())
|
|
|
|
errs := []error{}
|
|
eh := otel.ErrorHandlerFunc(func(e error) { errs = append(errs, e) })
|
|
otel.SetErrorHandler(eh)
|
|
|
|
// This test checks that Prometheus exporter ignores
|
|
// when it encounters incompatible meter name.
|
|
|
|
// Invalid label or metric name leads to error returned from
|
|
// createScopeInfoMetric.
|
|
invalidName := string([]byte{0xff, 0xfe, 0xfd})
|
|
|
|
ctx := context.Background()
|
|
registry := prometheus.NewRegistry()
|
|
exporter, err := New(WithRegisterer(registry))
|
|
require.NoError(t, err)
|
|
provider := metric.NewMeterProvider(
|
|
metric.WithResource(resource.Empty()),
|
|
metric.WithReader(exporter))
|
|
meter := provider.Meter(invalidName)
|
|
cnt, err := meter.Int64Counter("foo")
|
|
require.NoError(t, err)
|
|
cnt.Add(ctx, 100)
|
|
|
|
file, err := os.Open("testdata/TestIncompatibleMeterName.txt")
|
|
require.NoError(t, err)
|
|
t.Cleanup(func() { require.NoError(t, file.Close()) })
|
|
|
|
err = testutil.GatherAndCompare(registry, file)
|
|
require.NoError(t, err)
|
|
|
|
assert.Len(t, errs, 1)
|
|
|
|
// A second collect shouldn't trigger new errors
|
|
_, err = file.Seek(0, io.SeekStart)
|
|
assert.NoError(t, err)
|
|
err = testutil.GatherAndCompare(registry, file)
|
|
require.NoError(t, err)
|
|
assert.Len(t, errs, 1)
|
|
}
|
|
|
|
func TestShutdownExporter(t *testing.T) {
|
|
var handledError error
|
|
eh := otel.ErrorHandlerFunc(func(e error) { handledError = errors.Join(handledError, e) })
|
|
otel.SetErrorHandler(eh)
|
|
|
|
ctx := context.Background()
|
|
registry := prometheus.NewRegistry()
|
|
|
|
for i := 0; i < 3; i++ {
|
|
exporter, err := New(WithRegisterer(registry))
|
|
require.NoError(t, err)
|
|
provider := metric.NewMeterProvider(
|
|
metric.WithResource(resource.Default()),
|
|
metric.WithReader(exporter))
|
|
meter := provider.Meter("testmeter")
|
|
cnt, err := meter.Int64Counter("foo")
|
|
require.NoError(t, err)
|
|
cnt.Add(ctx, 100)
|
|
|
|
// verify that metrics added to a previously shutdown MeterProvider
|
|
// do not conflict with metrics added in this loop.
|
|
_, err = registry.Gather()
|
|
require.NoError(t, err)
|
|
|
|
// Shutdown should cause future prometheus Gather() calls to no longer
|
|
// include metrics from this loop's MeterProvider.
|
|
err = provider.Shutdown(ctx)
|
|
require.NoError(t, err)
|
|
}
|
|
// ensure we aren't unnecessarily logging errors from the shutdown MeterProvider
|
|
require.NoError(t, handledError)
|
|
}
|
|
|
|
func TestExemplars(t *testing.T) {
|
|
attrsOpt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
)
|
|
for _, tc := range []struct {
|
|
name string
|
|
recordMetrics func(ctx context.Context, meter otelmetric.Meter)
|
|
expectedExemplarValue float64
|
|
}{
|
|
{
|
|
name: "counter",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
counter, err := meter.Float64Counter("foo")
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 9, attrsOpt)
|
|
},
|
|
expectedExemplarValue: 9,
|
|
},
|
|
{
|
|
name: "histogram",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
hist, err := meter.Int64Histogram("foo")
|
|
require.NoError(t, err)
|
|
hist.Record(ctx, 9, attrsOpt)
|
|
},
|
|
expectedExemplarValue: 9,
|
|
},
|
|
} {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Setenv("OTEL_GO_X_EXEMPLAR", "true")
|
|
// initialize registry exporter
|
|
ctx := context.Background()
|
|
registry := prometheus.NewRegistry()
|
|
exporter, err := New(WithRegisterer(registry), WithoutTargetInfo(), WithoutScopeInfo())
|
|
require.NoError(t, err)
|
|
|
|
// initialize resource
|
|
res, err := resource.New(ctx,
|
|
resource.WithAttributes(semconv.ServiceName("prometheus_test")),
|
|
resource.WithAttributes(semconv.TelemetrySDKVersion("latest")),
|
|
)
|
|
require.NoError(t, err)
|
|
res, err = resource.Merge(resource.Default(), res)
|
|
require.NoError(t, err)
|
|
|
|
// initialize provider and meter
|
|
provider := metric.NewMeterProvider(
|
|
metric.WithReader(exporter),
|
|
metric.WithResource(res),
|
|
metric.WithView(metric.NewView(
|
|
metric.Instrument{Name: "*"},
|
|
metric.Stream{
|
|
// filter out all attributes so they are added as filtered
|
|
// attributes to the exemplar
|
|
AttributeFilter: attribute.NewAllowKeysFilter(),
|
|
},
|
|
)),
|
|
)
|
|
meter := provider.Meter("meter", otelmetric.WithInstrumentationVersion("v0.1.0"))
|
|
|
|
// Add a sampled span context so that measurements get exemplars added
|
|
sc := trace.NewSpanContext(trace.SpanContextConfig{
|
|
SpanID: trace.SpanID{0o1},
|
|
TraceID: trace.TraceID{0o1},
|
|
TraceFlags: trace.FlagsSampled,
|
|
})
|
|
ctx = trace.ContextWithSpanContext(ctx, sc)
|
|
// Record a single observation with the exemplar
|
|
tc.recordMetrics(ctx, meter)
|
|
|
|
// Verify that the exemplar is present in the proto version of the
|
|
// prometheus metrics.
|
|
got, done, err := prometheus.ToTransactionalGatherer(registry).Gather()
|
|
defer done()
|
|
require.NoError(t, err)
|
|
|
|
require.Len(t, got, 1)
|
|
family := got[0]
|
|
require.Len(t, family.GetMetric(), 1)
|
|
metric := family.GetMetric()[0]
|
|
var exemplar *dto.Exemplar
|
|
switch family.GetType() {
|
|
case dto.MetricType_COUNTER:
|
|
exemplar = metric.GetCounter().GetExemplar()
|
|
case dto.MetricType_HISTOGRAM:
|
|
for _, b := range metric.GetHistogram().GetBucket() {
|
|
if b.GetExemplar() != nil {
|
|
exemplar = b.GetExemplar()
|
|
continue
|
|
}
|
|
}
|
|
}
|
|
require.NotNil(t, exemplar)
|
|
require.Equal(t, tc.expectedExemplarValue, exemplar.GetValue())
|
|
expectedLabels := map[string]string{
|
|
traceIDExemplarKey: "01000000000000000000000000000000",
|
|
spanIDExemplarKey: "0100000000000000",
|
|
"A": "B",
|
|
"C": "D",
|
|
"E": "true",
|
|
"F": "42",
|
|
}
|
|
require.Equal(t, len(expectedLabels), len(exemplar.GetLabel()))
|
|
for _, label := range exemplar.GetLabel() {
|
|
val, ok := expectedLabels[label.GetName()]
|
|
require.True(t, ok)
|
|
require.Equal(t, label.GetValue(), val)
|
|
}
|
|
})
|
|
}
|
|
}
|