Skip to content

Commit

Permalink
fix: do not overwrite registries when publishing otel metrics to beats (
Browse files Browse the repository at this point in the history
#15517) (#15537)

* fix: do not overwrite registries when publishing otel metrics to beats

update apm-server registry mapping logic to avoid overwriting
onkey handlers

* test: add unit test for apm-server mapping logic

(cherry picked from commit 9350ef5)

Co-authored-by: kruskall <[email protected]>
  • Loading branch information
mergify[bot] and kruskall authored Feb 4, 2025
1 parent fadcc78 commit 07ed0e2
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 8 deletions.
36 changes: 28 additions & 8 deletions internal/beatcmd/beat.go
Original file line number Diff line number Diff line change
Expand Up @@ -573,21 +573,41 @@ func getScalarInt64(data metricdata.Aggregation) (int64, bool) {
}

func addAPMServerMetrics(v monitoring.Visitor, sm metricdata.ScopeMetrics) {
beatsMetrics := make(map[string]any)
for _, m := range sm.Metrics {
if suffix, ok := strings.CutPrefix(m.Name, "apm-server."); ok {
if value, ok := getScalarInt64(m.Data); ok {
keys := strings.Split(suffix, ".")
for i := 0; i < len(keys)-1; i++ {
v.OnRegistryStart()
v.OnKey(keys[i])
}
monitoring.ReportInt(v, keys[len(keys)-1], value)
for i := 0; i < len(keys)-1; i++ {
v.OnRegistryFinished()
current := beatsMetrics
suffixSlice := strings.Split(suffix, ".")
for i := 0; i < len(suffixSlice)-1; i++ {
k := suffixSlice[i]
if _, ok := current[k]; !ok {
current[k] = make(map[string]any)
}
if currentmap, ok := current[k].(map[string]any); ok {
current = currentmap
}
}
current[suffixSlice[len(suffixSlice)-1]] = value
}
}
}

reportOnKey(v, beatsMetrics)
}

func reportOnKey(v monitoring.Visitor, m map[string]any) {
for key, value := range m {
if valueMap, ok := value.(map[string]any); ok {
v.OnRegistryStart()
v.OnKey(key)
reportOnKey(v, valueMap)
v.OnRegistryFinished()
}
if valueMetric, ok := value.(int64); ok {
monitoring.ReportInt(v, key, valueMetric)
}
}
}

// Adapt go-docappender's OTel metrics to beats stack monitoring metrics,
Expand Down
41 changes: 41 additions & 0 deletions internal/beatcmd/beat_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import (

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.opentelemetry.io/otel/sdk/metric/metricdata"
"golang.org/x/sync/errgroup"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
Expand Down Expand Up @@ -266,6 +267,46 @@ func TestLibbeatMetrics(t *testing.T) {
}, snapshot)
}

func TestAddAPMServerMetrics(t *testing.T) {
r := monitoring.NewRegistry()
sm := metricdata.ScopeMetrics{
Metrics: []metricdata.Metrics{
{
Name: "apm-server.foo.request",
Data: metricdata.Sum[int64]{
DataPoints: []metricdata.DataPoint[int64]{
{
Value: 1,
},
},
},
},
{
Name: "apm-server.foo.response",
Data: metricdata.Sum[int64]{
DataPoints: []metricdata.DataPoint[int64]{
{
Value: 1,
},
},
},
},
},
}

monitoring.NewFunc(r, "apm-server", func(m monitoring.Mode, v monitoring.Visitor) {
addAPMServerMetrics(v, sm)
})

snapshot := monitoring.CollectStructSnapshot(r, monitoring.Full, false)
assert.Equal(t, map[string]any{
"foo": map[string]any{
"request": int64(1),
"response": int64(1),
},
}, snapshot)
}

func TestUnmanagedOutputRequired(t *testing.T) {
b := newBeat(t, "", func(args RunnerParams) (Runner, error) {
panic("unreachable")
Expand Down

0 comments on commit 07ed0e2

Please sign in to comment.