mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-14 10:13:10 +02:00
d1aca7b167
* Split WithView from WithReader
* Accept readers and views params in newPipelines
* Update MeterProvider pipes init
* Fix WithView comment
* Fix view example MeterProvider option
* Fix With{View,Reader} option in prom exporter test
* Test Reader not required to be comparable
* Add changes to changelog
* Fix changelog option name
309 lines
10 KiB
Go
309 lines
10 KiB
Go
// 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 prometheus
|
|
|
|
import (
|
|
"context"
|
|
"os"
|
|
"testing"
|
|
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
"github.com/prometheus/client_golang/prometheus/testutil"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"go.opentelemetry.io/otel/attribute"
|
|
otelmetric "go.opentelemetry.io/otel/metric"
|
|
"go.opentelemetry.io/otel/metric/instrument"
|
|
"go.opentelemetry.io/otel/metric/unit"
|
|
"go.opentelemetry.io/otel/sdk/metric"
|
|
"go.opentelemetry.io/otel/sdk/metric/aggregation"
|
|
"go.opentelemetry.io/otel/sdk/metric/view"
|
|
"go.opentelemetry.io/otel/sdk/resource"
|
|
semconv "go.opentelemetry.io/otel/semconv/v1.12.0"
|
|
)
|
|
|
|
func TestPrometheusExporter(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
emptyResource bool
|
|
customResouceAttrs []attribute.KeyValue
|
|
recordMetrics func(ctx context.Context, meter otelmetric.Meter)
|
|
options []Option
|
|
expectedFile string
|
|
}{
|
|
{
|
|
name: "counter",
|
|
expectedFile: "testdata/counter.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
attrs := []attribute.KeyValue{
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
}
|
|
counter, err := meter.SyncFloat64().Counter(
|
|
"foo",
|
|
instrument.WithDescription("a simple counter"),
|
|
instrument.WithUnit(unit.Milliseconds),
|
|
)
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, attrs...)
|
|
counter.Add(ctx, 10.3, attrs...)
|
|
counter.Add(ctx, 9, attrs...)
|
|
|
|
attrs2 := []attribute.KeyValue{
|
|
attribute.Key("A").String("D"),
|
|
attribute.Key("C").String("B"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
}
|
|
counter.Add(ctx, 5, attrs2...)
|
|
},
|
|
},
|
|
{
|
|
name: "gauge",
|
|
expectedFile: "testdata/gauge.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
attrs := []attribute.KeyValue{
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
}
|
|
gauge, err := meter.SyncFloat64().UpDownCounter(
|
|
"bar",
|
|
instrument.WithDescription("a fun little gauge"),
|
|
instrument.WithUnit(unit.Dimensionless),
|
|
)
|
|
require.NoError(t, err)
|
|
gauge.Add(ctx, 1.0, attrs...)
|
|
gauge.Add(ctx, -.25, attrs...)
|
|
},
|
|
},
|
|
{
|
|
name: "histogram",
|
|
expectedFile: "testdata/histogram.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
attrs := []attribute.KeyValue{
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
}
|
|
histogram, err := meter.SyncFloat64().Histogram(
|
|
"histogram_baz",
|
|
instrument.WithDescription("a very nice histogram"),
|
|
instrument.WithUnit(unit.Bytes),
|
|
)
|
|
require.NoError(t, err)
|
|
histogram.Record(ctx, 23, attrs...)
|
|
histogram.Record(ctx, 7, attrs...)
|
|
histogram.Record(ctx, 101, attrs...)
|
|
histogram.Record(ctx, 105, attrs...)
|
|
},
|
|
},
|
|
{
|
|
name: "sanitized attributes to labels",
|
|
expectedFile: "testdata/sanitized_labels.txt",
|
|
options: []Option{WithoutUnits()},
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
attrs := []attribute.KeyValue{
|
|
// 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.SyncFloat64().Counter(
|
|
"foo",
|
|
instrument.WithDescription("a sanitary counter"),
|
|
// This unit is not added to
|
|
instrument.WithUnit(unit.Bytes),
|
|
)
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, attrs...)
|
|
counter.Add(ctx, 10.3, attrs...)
|
|
counter.Add(ctx, 9, attrs...)
|
|
},
|
|
},
|
|
{
|
|
name: "invalid instruments are renamed",
|
|
expectedFile: "testdata/sanitized_names.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
attrs := []attribute.KeyValue{
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
}
|
|
// Valid.
|
|
gauge, err := meter.SyncFloat64().UpDownCounter("bar", instrument.WithDescription("a fun little gauge"))
|
|
require.NoError(t, err)
|
|
gauge.Add(ctx, 100, attrs...)
|
|
gauge.Add(ctx, -25, attrs...)
|
|
|
|
// Invalid, will be renamed.
|
|
gauge, err = meter.SyncFloat64().UpDownCounter("invalid.gauge.name", instrument.WithDescription("a gauge with an invalid name"))
|
|
require.NoError(t, err)
|
|
gauge.Add(ctx, 100, attrs...)
|
|
|
|
counter, err := meter.SyncFloat64().Counter("0invalid.counter.name", instrument.WithDescription("a counter with an invalid name"))
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 100, attrs...)
|
|
|
|
histogram, err := meter.SyncFloat64().Histogram("invalid.hist.name", instrument.WithDescription("a histogram with an invalid name"))
|
|
require.NoError(t, err)
|
|
histogram.Record(ctx, 23, attrs...)
|
|
},
|
|
},
|
|
{
|
|
name: "empty resource",
|
|
emptyResource: true,
|
|
expectedFile: "testdata/empty_resource.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
attrs := []attribute.KeyValue{
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
}
|
|
counter, err := meter.SyncFloat64().Counter("foo", instrument.WithDescription("a simple counter"))
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, attrs...)
|
|
counter.Add(ctx, 10.3, attrs...)
|
|
counter.Add(ctx, 9, attrs...)
|
|
},
|
|
},
|
|
{
|
|
name: "custom resource",
|
|
customResouceAttrs: []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) {
|
|
attrs := []attribute.KeyValue{
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
}
|
|
counter, err := meter.SyncFloat64().Counter("foo", instrument.WithDescription("a simple counter"))
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, attrs...)
|
|
counter.Add(ctx, 10.3, attrs...)
|
|
counter.Add(ctx, 9, attrs...)
|
|
},
|
|
},
|
|
{
|
|
name: "without target_info",
|
|
options: []Option{WithoutTargetInfo()},
|
|
expectedFile: "testdata/without_target_info.txt",
|
|
recordMetrics: func(ctx context.Context, meter otelmetric.Meter) {
|
|
attrs := []attribute.KeyValue{
|
|
attribute.Key("A").String("B"),
|
|
attribute.Key("C").String("D"),
|
|
attribute.Key("E").Bool(true),
|
|
attribute.Key("F").Int(42),
|
|
}
|
|
counter, err := meter.SyncFloat64().Counter("foo", instrument.WithDescription("a simple counter"))
|
|
require.NoError(t, err)
|
|
counter.Add(ctx, 5, attrs...)
|
|
counter.Add(ctx, 10.3, attrs...)
|
|
counter.Add(ctx, 9, attrs...)
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
ctx := context.Background()
|
|
registry := prometheus.NewRegistry()
|
|
exporter, err := New(append(tc.options, WithRegisterer(registry))...)
|
|
require.NoError(t, err)
|
|
|
|
customBucketsView, err := view.New(
|
|
view.MatchInstrumentName("histogram_*"),
|
|
view.WithSetAggregation(aggregation.ExplicitBucketHistogram{
|
|
Boundaries: []float64{0, 5, 10, 25, 50, 75, 100, 250, 500, 1000},
|
|
}),
|
|
)
|
|
require.NoError(t, err)
|
|
defaultView, err := view.New(view.MatchInstrumentName("*"))
|
|
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.ServiceNameKey.String("prometheus_test")),
|
|
// Overwrite the semconv.TelemetrySDKVersionKey value so we don't need to update every version
|
|
resource.WithAttributes(semconv.TelemetrySDKVersionKey.String("latest")),
|
|
resource.WithAttributes(tc.customResouceAttrs...),
|
|
)
|
|
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(customBucketsView, defaultView),
|
|
)
|
|
meter := provider.Meter("testmeter")
|
|
|
|
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 TestSantitizeName(t *testing.T) {
|
|
tests := []struct {
|
|
input string
|
|
want string
|
|
}{
|
|
{"nam€_with_3_width_rune", "nam__with_3_width_rune"},
|
|
{"`", "_"},
|
|
{
|
|
`! "#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWKYZ[]\^_abcdefghijklmnopqrstuvwkyz{|}~`,
|
|
`________________0123456789:______ABCDEFGHIJKLMNOPQRSTUVWKYZ_____abcdefghijklmnopqrstuvwkyz____`,
|
|
},
|
|
|
|
// Test cases taken from
|
|
// https://github.com/prometheus/common/blob/dfbc25bd00225c70aca0d94c3c4bb7744f28ace0/model/metric_test.go#L85-L136
|
|
{"Avalid_23name", "Avalid_23name"},
|
|
{"_Avalid_23name", "_Avalid_23name"},
|
|
{"1valid_23name", "_1valid_23name"},
|
|
{"avalid_23name", "avalid_23name"},
|
|
{"Ava:lid_23name", "Ava:lid_23name"},
|
|
{"a lid_23name", "a_lid_23name"},
|
|
{":leading_colon", ":leading_colon"},
|
|
{"colon:in:the:middle", "colon:in:the:middle"},
|
|
{"", ""},
|
|
}
|
|
|
|
for _, test := range tests {
|
|
require.Equalf(t, test.want, sanitizeName(test.input), "input: %q", test.input)
|
|
}
|
|
}
|