mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-12 10:04:29 +02:00
457029232d
* Concurrent collect bugfix
* Used sync.Mutex and code cleanup
* Revert "Concurrent collect bugfix"
This reverts commit 1a30f233b6.
* Used sync.Mutex and re-grouped protected members
* Added test and updated changelog
* Updated changelog
* Take care of potential panic in otel.Handle
* Extracted critical section in a separate method and fixed nil scope info
* Lock the whole scope of the func
* Moved otel.Handle out of the critical section
* Fixed calling createScopeInfoMetric twice and updated changelog
* Fixed markdown linter errors
* Added test for nil scopeinfo
* Fix merge artifacts
* Fixed linter errors
* Protect the whole validateMetrics method wity mutex
* Update CHANGELOG.md
* Update exporters/prometheus/exporter.go
Co-authored-by: Robert Pająk <pellared@hotmail.com>
* Update CHANGELOG.md
* Document that Collect is concurrent-safe
* Update exporter_test.go
* Update exporters/prometheus/exporter_test.go
* Update exporters/prometheus/exporter.go
Co-authored-by: David Ashpole <dashpole@google.com>
---------
Co-authored-by: Robert Pająk <pellared@hotmail.com>
Co-authored-by: David Ashpole <dashpole@google.com>
840 lines
26 KiB
Go
840 lines
26 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"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
"github.com/prometheus/client_golang/prometheus/testutil"
|
|
dto "github.com/prometheus/client_model/go"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"go.opentelemetry.io/otel/attribute"
|
|
otelmetric "go.opentelemetry.io/otel/metric"
|
|
"go.opentelemetry.io/otel/sdk/instrumentation"
|
|
"go.opentelemetry.io/otel/sdk/metric"
|
|
"go.opentelemetry.io/otel/sdk/metric/aggregation"
|
|
"go.opentelemetry.io/otel/sdk/resource"
|
|
semconv "go.opentelemetry.io/otel/semconv/v1.17.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) {
|
|
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("ms"),
|
|
)
|
|
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",
|
|
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) {
|
|
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)
|
|
},
|
|
},
|
|
}
|
|
|
|
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)
|
|
|
|
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.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(metric.NewView(
|
|
metric.Instrument{Name: "histogram_*"},
|
|
metric.Stream{Aggregation: aggregation.ExplicitBucketHistogram{
|
|
Boundaries: []float64{0, 5, 10, 25, 50, 75, 100, 250, 500, 1000},
|
|
}},
|
|
)),
|
|
)
|
|
meter := provider.Meter(
|
|
"testmeter",
|
|
otelmetric.WithInstrumentationVersion("v0.1.0"),
|
|
)
|
|
|
|
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
|
|
}{
|
|
{"name€_with_4_width_rune", "name__with_4_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)
|
|
}
|
|
}
|
|
|
|
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("ms"),
|
|
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("ms"),
|
|
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
|
|
customResouceAttrs []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("ms"),
|
|
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("ms"),
|
|
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("ms"),
|
|
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)
|
|
|
|
var 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 TestCollectConcurrentSafe(t *testing.T) {
|
|
registry := prometheus.NewRegistry()
|
|
cfg := newConfig(WithRegisterer(registry))
|
|
|
|
reader := metric.NewManualReader(cfg.manualReaderOptions()...)
|
|
|
|
collector := &collector{
|
|
reader: reader,
|
|
disableTargetInfo: false,
|
|
withoutUnits: true,
|
|
disableScopeInfo: cfg.disableScopeInfo,
|
|
scopeInfos: make(map[instrumentation.Scope]prometheus.Metric),
|
|
metricFamilies: make(map[string]*dto.MetricFamily),
|
|
}
|
|
|
|
err := cfg.registerer.Register(collector)
|
|
require.NoError(t, err)
|
|
|
|
ctx := context.Background()
|
|
|
|
// 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)
|
|
|
|
exporter := &Exporter{Reader: reader}
|
|
|
|
// 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"))
|
|
|
|
fooA, err := meterA.Int64Counter("foo",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter counter foo"))
|
|
assert.NoError(t, err)
|
|
|
|
opt := otelmetric.WithAttributes(
|
|
attribute.Key("A").String("B"),
|
|
)
|
|
|
|
fooA.Add(ctx, 100, opt)
|
|
|
|
fooB, err := meterB.Int64Counter("foo",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription("meter counter foo"))
|
|
assert.NoError(t, err)
|
|
fooB.Add(ctx, 100, opt)
|
|
|
|
concurrencyLevel := 100
|
|
ch := make(chan prometheus.Metric, concurrencyLevel)
|
|
|
|
for i := 0; i < concurrencyLevel; i++ {
|
|
go func() {
|
|
collector.Collect(ch)
|
|
}()
|
|
}
|
|
|
|
for ; concurrencyLevel > 0; concurrencyLevel-- {
|
|
select {
|
|
case <-ch:
|
|
concurrencyLevel--
|
|
if concurrencyLevel == 0 {
|
|
return
|
|
}
|
|
case <-time.After(time.Second):
|
|
t.Fatal("timeout")
|
|
}
|
|
}
|
|
}
|
|
|
|
func TesInvalidInsrtrumentForPrometheusIsIgnored(t *testing.T) {
|
|
registry := prometheus.NewRegistry()
|
|
cfg := newConfig(WithRegisterer(registry))
|
|
|
|
reader := metric.NewManualReader(cfg.manualReaderOptions()...)
|
|
|
|
collector := &collector{
|
|
reader: reader,
|
|
disableTargetInfo: false,
|
|
withoutUnits: true,
|
|
disableScopeInfo: false,
|
|
scopeInfos: make(map[instrumentation.Scope]prometheus.Metric),
|
|
metricFamilies: make(map[string]*dto.MetricFamily),
|
|
}
|
|
|
|
err := cfg.registerer.Register(collector)
|
|
require.NoError(t, err)
|
|
|
|
ctx := context.Background()
|
|
|
|
// 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)
|
|
|
|
exporter := &Exporter{Reader: reader}
|
|
|
|
// initialize provider
|
|
provider := metric.NewMeterProvider(
|
|
metric.WithReader(exporter),
|
|
metric.WithResource(res),
|
|
)
|
|
|
|
// invalid label or metric name leads to error returned from
|
|
// createScopeInfoMetric
|
|
invalidName := string([]byte{0xff, 0xfe, 0xfd})
|
|
validName := "validName"
|
|
|
|
meterA := provider.Meter(invalidName, otelmetric.WithInstrumentationVersion("v0.1.0"))
|
|
|
|
counterA, err := meterA.Int64Counter("with-invalid-description",
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription(invalidName))
|
|
assert.NoError(t, err)
|
|
|
|
counterA.Add(ctx, 100, otelmetric.WithAttributes(
|
|
attribute.Key(invalidName).String(invalidName),
|
|
))
|
|
|
|
meterB := provider.Meter(validName, otelmetric.WithInstrumentationVersion("v0.1.0"))
|
|
counterB, err := meterB.Int64Counter(validName,
|
|
otelmetric.WithUnit("By"),
|
|
otelmetric.WithDescription(validName))
|
|
assert.NoError(t, err)
|
|
|
|
counterB.Add(ctx, 100, otelmetric.WithAttributes(
|
|
attribute.Key(validName).String(validName),
|
|
))
|
|
|
|
ch := make(chan prometheus.Metric)
|
|
|
|
go collector.Collect(ch)
|
|
|
|
for {
|
|
select {
|
|
case m := <-ch:
|
|
require.NotNil(t, m)
|
|
|
|
if strings.Contains(m.Desc().String(), validName) {
|
|
return
|
|
}
|
|
case <-time.After(time.Second):
|
|
t.Fatalf("timeout")
|
|
}
|
|
}
|
|
}
|