Expose HTTP/gRPC metrics to OpenTelemetry as well #11564
+298
−52
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -18,36 +18,79 @@ | ||
| package middleware | ||
|
|
||
| import ( | ||
| "context" | ||
| "net/http" | ||
|
|
||
| "go.opentelemetry.io/otel" | ||
| "go.opentelemetry.io/otel/metric" | ||
|
|
||
| "github.com/elastic/apm-server/internal/beater/request" | ||
| "github.com/elastic/elastic-agent-libs/monitoring" | ||
| ) | ||
|
|
||
| type monitoringMiddleware struct { | ||
| meter metric.Meter | ||
|
|
||
| ints map[request.ResultID]*monitoring.Int | ||
| counters map[request.ResultID]metric.Int64Counter | ||
| } | ||
|
|
||
| func (m *monitoringMiddleware) Middleware() Middleware { | ||
| return func(h request.Handler) (request.Handler, error) { | ||
| return func(c *request.Context) { | ||
| ctx := context.Background() | ||
|
|
||
| m.getMetric(request.IDRequestCount).Add(ctx, 1) | ||
| m.inc(request.IDRequestCount) | ||
|
|
||
| h(c) | ||
|
|
||
| m.getMetric(request.IDResponseCount).Add(ctx, 1) | ||
| m.inc(request.IDResponseCount) | ||
| if c.Result.StatusCode >= http.StatusBadRequest { | ||
| m.getMetric(request.IDResponseErrorsCount).Add(ctx, 1) | ||
| m.inc(request.IDResponseErrorsCount) | ||
| } else { | ||
| m.getMetric(request.IDResponseValidCount).Add(ctx, 1) | ||
| m.inc(request.IDResponseValidCount) | ||
| } | ||
|
|
||
| m.getMetric(c.Result.ID).Add(ctx, 1) | ||
| m.inc(c.Result.ID) | ||
| }, nil | ||
|
|
||
| } | ||
| } | ||
|
|
||
| func (m *monitoringMiddleware) inc(id request.ResultID) { | ||
| if counter, ok := m.ints[id]; ok { | ||
| counter.Inc() | ||
| } | ||
| } | ||
|
|
||
| func (m *monitoringMiddleware) getMetric(n request.ResultID) metric.Int64Counter { | ||
| name := "http.server." + n | ||
|
There was a problem hiding this comment. I named those metrics We can rename those metrics in the local exporter. |
||
| if met, ok := m.counters[name]; ok { | ||
| return met | ||
| } | ||
|
|
||
| nm, _ := m.meter.Int64Counter(string(name)) | ||
| m.counters[name] = nm | ||
| return nm | ||
| } | ||
|
|
||
| // MonitoringMiddleware returns a middleware that increases monitoring counters for collecting metrics | ||
| // about request processing. As input parameter it takes a map capable of mapping a request.ResultID to a counter. | ||
| func MonitoringMiddleware(m map[request.ResultID]*monitoring.Int, mp metric.MeterProvider) Middleware { | ||
| if mp == nil { | ||
| mp = otel.GetMeterProvider() | ||
| } | ||
|
|
||
| mid := &monitoringMiddleware{ | ||
| meter: mp.Meter("internal/beater/middleware"), | ||
| ints: m, | ||
| counters: map[request.ResultID]metric.Int64Counter{}, | ||
| } | ||
|
|
||
| return mid.Middleware() | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| // Licensed to Elasticsearch B.V. under one or more contributor | ||
| // license agreements. See the NOTICE file distributed with | ||
| // this work for additional information regarding copyright | ||
| // ownership. Elasticsearch B.V. licenses this file to you 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 monitoringtest | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| sdkmetric "go.opentelemetry.io/otel/sdk/metric" | ||
| "go.opentelemetry.io/otel/sdk/metric/metricdata" | ||
| ) | ||
|
|
||
| func ExpectOtelMetrics(t *testing.T, reader sdkmetric.Reader, expectedMetrics map[string]int64) { | ||
| t.Helper() | ||
|
|
||
| var rm metricdata.ResourceMetrics | ||
| assert.NoError(t, reader.Collect(context.Background(), &rm)) | ||
|
|
||
| assert.NotEqual(t, 0, len(rm.ScopeMetrics)) | ||
| foundMetrics := []string{} | ||
| for _, sm := range rm.ScopeMetrics { | ||
|
|
||
| for _, m := range sm.Metrics { | ||
| switch d := m.Data.(type) { | ||
| case metricdata.Sum[int64]: | ||
| assert.Equal(t, 1, len(d.DataPoints)) | ||
| foundMetrics = append(foundMetrics, m.Name) | ||
|
|
||
| if v, ok := expectedMetrics[m.Name]; ok { | ||
| assert.Equal(t, v, d.DataPoints[0].Value, m.Name) | ||
| } else { | ||
| assert.Fail(t, "unexpected metric", m.Name) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| expectedMetricsKeys := []string{} | ||
| for k := range expectedMetrics { | ||
| expectedMetricsKeys = append(expectedMetricsKeys, k) | ||
| } | ||
| assert.ElementsMatch(t, expectedMetricsKeys, foundMetrics) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
question: why do we have an additional
IDResponseErrorsInternalin monitoringInt ?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't really figured out why, but nothing can set it from this interceptor, so I suspect it's because something elsewhere sets it, only for monitoring.Int.
The only location that sets it though is jaeger, and it's not executed here. So it may be state from a previous test?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have removed the metric from monitoring.Int, and the test doesn't fail either. So it does seem it's not being incremented in that interceptor (and the monitoring.Int test doesn't check for metrics that aren't emitted).