mirror of
https://github.com/luxfi/metric.git
synced 2026-10-30 16:19:50 +00:00
zooqueenandHanzo Dev
d3ba598ff7
exporter_otelzap.go was the only file in the root package importing go.opentelemetry.io, and it made the root package link 34 OpenTelemetry SDK packages. Nothing else in the root package wants them: the registry, the text encoder and the ZAP exporter are pure luxfi/zap. That cost was not paid by the root package alone. github.com/zap-proto/zip imports this module for the registry, EncodeText and NewZAPExporter, and passes on whatever the root package links to each of the 125 programs built on it. The ruling is native ZAP only, so nothing a plugin inherits may carry the OpenTelemetry SDK. The adapter is now package github.com/luxfi/metric/otel, and the two symbols it exports lose the prefixes that only existed to disambiguate them inside the root package: metric.NewOTelZAPExporter(cfg) -> otel.New(cfg) *metric.OTelZAPExporter -> *otel.Exporter The configuration type stays metric.ZAPExporterConfig, since it belongs to the ZAP exporter this adapter builds on. No alias is left behind in the root package — one that re-imported the moved package would link the SDK again and undo the change. Callers of the adapter add the otel import and drop the prefixes. Proof, rather than a grep for import lines: go list -deps . | grep -c go.opentelemetry.io -> 0 go list -deps ./otel | grep -c go.opentelemetry.io -> 34 0 holds under the default tags, -tags metrics and -tags metrics_noop alike. A program importing zip v1.25.0 against this module resolves 0 as well, measured with a replace directive. The conversion had no tests, so the move now pins it: counter and gauge shapes, the drop of an aggregation these shapes cannot carry, and the arithmetic that matters — OpenTelemetry reports a count per bucket where Prometheus reports a running total. The metrics_noop defaults are untouched; recording stays the default and the no-op stays opt-in. Build, vet and test -race are green under all three tag sets. Co-authored-by: Hanzo Dev <[email protected]>
118 lines
3.7 KiB
Go
118 lines
3.7 KiB
Go
// Copyright (C) 2019-2026, Lux Industries Inc. All rights reserved.
|
|
// See the file LICENSE for licensing terms.
|
|
|
|
package otel
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/luxfi/metric"
|
|
"go.opentelemetry.io/otel/attribute"
|
|
"go.opentelemetry.io/otel/sdk/metric/metricdata"
|
|
)
|
|
|
|
// TestToFamilySum checks that a monotonic sum arrives as a counter carrying its
|
|
// attributes as label pairs, because that pairing is what the o11y query plane
|
|
// reads.
|
|
func TestToFamilySum(t *testing.T) {
|
|
fam := toFamily(metricdata.Metrics{
|
|
Name: "requests_total",
|
|
Description: "Total requests",
|
|
Data: metricdata.Sum[int64]{
|
|
DataPoints: []metricdata.DataPoint[int64]{{
|
|
Attributes: attribute.NewSet(attribute.String("route", "/v1/health")),
|
|
Value: 7,
|
|
}},
|
|
},
|
|
})
|
|
if fam == nil {
|
|
t.Fatal("sum converted to nil family")
|
|
}
|
|
if fam.Name != "requests_total" || fam.Help != "Total requests" {
|
|
t.Errorf("name/help = %q/%q", fam.Name, fam.Help)
|
|
}
|
|
if fam.Type != metric.MetricTypeCounter {
|
|
t.Errorf("type = %v, want counter", fam.Type)
|
|
}
|
|
if len(fam.Metrics) != 1 || fam.Metrics[0].Value.Value != 7 {
|
|
t.Fatalf("metrics = %+v", fam.Metrics)
|
|
}
|
|
want := []metric.LabelPair{{Name: "route", Value: "/v1/health"}}
|
|
if got := fam.Metrics[0].Labels; len(got) != 1 || got[0] != want[0] {
|
|
t.Errorf("labels = %+v, want %+v", got, want)
|
|
}
|
|
}
|
|
|
|
// TestToFamilyGauge checks the float gauge path, the one instrument whose value
|
|
// is read straight through with no conversion.
|
|
func TestToFamilyGauge(t *testing.T) {
|
|
fam := toFamily(metricdata.Metrics{
|
|
Name: "queue_depth",
|
|
Data: metricdata.Gauge[float64]{
|
|
DataPoints: []metricdata.DataPoint[float64]{{
|
|
Attributes: *attribute.EmptySet(),
|
|
Value: 2.5,
|
|
}},
|
|
},
|
|
})
|
|
if fam == nil || fam.Type != metric.MetricTypeGauge {
|
|
t.Fatalf("family = %+v, want a gauge", fam)
|
|
}
|
|
if fam.Metrics[0].Value.Value != 2.5 {
|
|
t.Errorf("value = %v, want 2.5", fam.Metrics[0].Value.Value)
|
|
}
|
|
}
|
|
|
|
// TestToFamilyHistogramBucketsAccumulate pins the one piece of arithmetic in
|
|
// this package: OpenTelemetry reports a count per bucket, Prometheus reports a
|
|
// running total, so the counts must be summed as the bounds are walked.
|
|
func TestToFamilyHistogramBucketsAccumulate(t *testing.T) {
|
|
fam := toFamily(metricdata.Metrics{
|
|
Name: "request_seconds",
|
|
Data: metricdata.Histogram[float64]{
|
|
DataPoints: []metricdata.HistogramDataPoint[float64]{{
|
|
Attributes: *attribute.EmptySet(),
|
|
Count: 9,
|
|
Sum: 4.5,
|
|
Bounds: []float64{0.1, 0.5, 1},
|
|
BucketCounts: []uint64{2, 3, 4, 0},
|
|
}},
|
|
},
|
|
})
|
|
if fam == nil || fam.Type != metric.MetricTypeHistogram {
|
|
t.Fatalf("family = %+v, want a histogram", fam)
|
|
}
|
|
pt := fam.Metrics[0]
|
|
if pt.Value.SampleCount != 9 || pt.Value.SampleSum != 4.5 {
|
|
t.Errorf("count/sum = %v/%v, want 9/4.5", pt.Value.SampleCount, pt.Value.SampleSum)
|
|
}
|
|
want := []metric.Bucket{
|
|
{UpperBound: 0.1, CumulativeCount: 2},
|
|
{UpperBound: 0.5, CumulativeCount: 5},
|
|
{UpperBound: 1, CumulativeCount: 9},
|
|
}
|
|
if len(pt.Value.Buckets) != len(want) {
|
|
t.Fatalf("buckets = %+v, want %+v", pt.Value.Buckets, want)
|
|
}
|
|
for i, b := range pt.Value.Buckets {
|
|
if b != want[i] {
|
|
t.Errorf("bucket %d = %+v, want %+v", i, b, want[i])
|
|
}
|
|
}
|
|
}
|
|
|
|
// TestToFamilyUnsupported checks that an aggregation these shapes cannot carry
|
|
// is dropped rather than converted to an empty family, so it never reaches the
|
|
// query plane looking like a metric that reported nothing.
|
|
func TestToFamilyUnsupported(t *testing.T) {
|
|
fam := toFamily(metricdata.Metrics{
|
|
Name: "request_seconds",
|
|
Data: metricdata.ExponentialHistogram[float64]{
|
|
DataPoints: []metricdata.ExponentialHistogramDataPoint[float64]{{Count: 1}},
|
|
},
|
|
})
|
|
if fam != nil {
|
|
t.Errorf("family = %+v, want nil", fam)
|
|
}
|
|
}
|