mirror of
https://github.com/hanzoai/telemetry.git
synced 2026-10-30 20:01:49 +00:00
9d509837f1
**Description:** This PR fixes an issue where the `debug` exporter (with `verbosity: detailed`) would print the Metric Descriptor but omit the `Metadata` field. This ensures that all parts of the Metric data model are visible during debugging. This issue was originally reported in [open-telemetry/opentelemetry-collector-contrib#46540](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/46540). This PR fixes issue: #14667 **Testing:** - [x] Added a new unit test case `metrics_with_metadata` in `metrics_test.go`. - [x] Verified locally that the output now includes the Metadata section as expected. --------- Signed-off-by: 57Ajay <[email protected]> Co-authored-by: Andrzej Stencel <[email protected]>
111 lines
2.6 KiB
Go
111 lines
2.6 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package otlptext
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"go.opentelemetry.io/collector/pdata/pmetric"
|
|
"go.opentelemetry.io/collector/pdata/testdata"
|
|
)
|
|
|
|
func TestMetricsText(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
in pmetric.Metrics
|
|
out string
|
|
}{
|
|
{
|
|
name: "empty_metrics",
|
|
in: pmetric.NewMetrics(),
|
|
out: "empty.out",
|
|
},
|
|
{
|
|
name: "metrics_with_all_types",
|
|
in: testdata.GenerateMetricsAllTypes(),
|
|
out: "metrics_with_all_types.out",
|
|
},
|
|
{
|
|
name: "two_metrics",
|
|
in: testdata.GenerateMetrics(2),
|
|
out: "two_metrics.out",
|
|
},
|
|
{
|
|
name: "invalid_metric_type",
|
|
in: testdata.GenerateMetricsMetricTypeInvalid(),
|
|
out: "invalid_metric_type.out",
|
|
},
|
|
{
|
|
name: "metrics_with_entity_refs",
|
|
in: generateMetricsWithEntityRefs(),
|
|
out: "metrics_with_entity_refs.out",
|
|
},
|
|
{
|
|
name: "metrics_with_metadata",
|
|
in: generateMetricsWithMetadata(),
|
|
out: "metrics_with_metadata.out",
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
got, err := NewTextMetricsMarshaler().MarshalMetrics(tt.in)
|
|
require.NoError(t, err)
|
|
out, err := os.ReadFile(filepath.Join("testdata", "metrics", tt.out))
|
|
require.NoError(t, err)
|
|
expected := strings.ReplaceAll(string(out), "\r", "")
|
|
assert.Equal(t, expected, string(got))
|
|
})
|
|
}
|
|
}
|
|
|
|
func generateMetricsWithEntityRefs() pmetric.Metrics {
|
|
md := pmetric.NewMetrics()
|
|
rm := md.ResourceMetrics().AppendEmpty()
|
|
|
|
setupResourceWithEntityRefs(rm.Resource())
|
|
|
|
sm := rm.ScopeMetrics().AppendEmpty()
|
|
sm.Scope().SetName("test-scope")
|
|
metric := sm.Metrics().AppendEmpty()
|
|
metric.SetName("test-metric")
|
|
metric.SetDescription("A test metric")
|
|
metric.SetUnit("1")
|
|
|
|
gauge := metric.SetEmptyGauge()
|
|
dp := gauge.DataPoints().AppendEmpty()
|
|
dp.SetDoubleValue(123.45)
|
|
dp.Attributes().PutStr("test.attribute", "test-value")
|
|
|
|
return md
|
|
}
|
|
|
|
func generateMetricsWithMetadata() pmetric.Metrics {
|
|
md := pmetric.NewMetrics()
|
|
rm := md.ResourceMetrics().AppendEmpty()
|
|
rm.Resource().Attributes().PutStr("service.name", "test-service")
|
|
|
|
sm := rm.ScopeMetrics().AppendEmpty()
|
|
sm.Scope().SetName("test-scope")
|
|
|
|
metric := sm.Metrics().AppendEmpty()
|
|
metric.SetName("test-metric-metadata")
|
|
metric.SetDescription("A test metric with metadata")
|
|
metric.SetUnit("1")
|
|
|
|
metric.Metadata().PutStr("meta.key", "meta-value")
|
|
metric.Metadata().PutInt("meta.id", 101)
|
|
|
|
gauge := metric.SetEmptyGauge()
|
|
dp := gauge.DataPoints().AppendEmpty()
|
|
dp.SetIntValue(1)
|
|
|
|
return md
|
|
}
|