Add secureSocksDSProxyEnabled label to grafana_datasource_request_duration_seconds (#80910)

* Add secureSocksDSProxyEnabled label to grafana_datasource_request_duration_seconds

* rename label from secureSocksDSProxyEnabled to secure_socks_ds_proxy_enabled

* DataSourceMetricsMiddleware: add secure_socks_ds_proxy_enabled label to every metric
This commit is contained in:
Bruno 2024-02-01 11:42:43 -03:00 committed by GitHub
parent 2332bfb007
commit 89fb56bc11
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 61 additions and 28 deletions

View File

@ -2,6 +2,7 @@ package httpclientprovider
import ( import (
"net/http" "net/http"
"strconv"
sdkhttpclient "github.com/grafana/grafana-plugin-sdk-go/backend/httpclient" sdkhttpclient "github.com/grafana/grafana-plugin-sdk-go/backend/httpclient"
"github.com/grafana/grafana/pkg/infra/httpclient" "github.com/grafana/grafana/pkg/infra/httpclient"
@ -18,7 +19,7 @@ var (
Name: "datasource_request_total", Name: "datasource_request_total",
Help: "A counter for outgoing requests for a data source", Help: "A counter for outgoing requests for a data source",
}, },
[]string{"datasource", "datasource_type", "code", "method"}, []string{"datasource", "datasource_type", "code", "method", "secure_socks_ds_proxy_enabled"},
) )
datasourceRequestHistogram = promauto.NewHistogramVec( datasourceRequestHistogram = promauto.NewHistogramVec(
@ -27,7 +28,7 @@ var (
Name: "datasource_request_duration_seconds", Name: "datasource_request_duration_seconds",
Help: "histogram of durations of outgoing data source requests sent from Grafana", Help: "histogram of durations of outgoing data source requests sent from Grafana",
Buckets: []float64{.005, .01, .025, .05, .1, .25, .5, 1, 2.5, 5, 10, 25, 50, 100}, Buckets: []float64{.005, .01, .025, .05, .1, .25, .5, 1, 2.5, 5, 10, 25, 50, 100},
}, []string{"datasource", "datasource_type", "code", "method"}, }, []string{"datasource", "datasource_type", "code", "method", "secure_socks_ds_proxy_enabled"},
) )
datasourceResponseHistogram = promauto.NewHistogramVec( datasourceResponseHistogram = promauto.NewHistogramVec(
@ -36,7 +37,7 @@ var (
Name: "datasource_response_size_bytes", Name: "datasource_response_size_bytes",
Help: "histogram of data source response sizes returned to Grafana", Help: "histogram of data source response sizes returned to Grafana",
Buckets: []float64{128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 131072, 262144, 524288, 1048576}, Buckets: []float64{128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 131072, 262144, 524288, 1048576},
}, []string{"datasource", "datasource_type"}, }, []string{"datasource", "datasource_type", "secure_socks_ds_proxy_enabled"},
) )
datasourceRequestsInFlight = promauto.NewGaugeVec( datasourceRequestsInFlight = promauto.NewGaugeVec(
@ -45,7 +46,7 @@ var (
Name: "datasource_request_in_flight", Name: "datasource_request_in_flight",
Help: "A gauge of outgoing data source requests currently being sent by Grafana", Help: "A gauge of outgoing data source requests currently being sent by Grafana",
}, },
[]string{"datasource", "datasource_type"}, []string{"datasource", "datasource_type", "secure_socks_ds_proxy_enabled"},
) )
) )
@ -82,7 +83,11 @@ func DataSourceMetricsMiddleware() sdkhttpclient.Middleware {
return next return next
} }
labels := prometheus.Labels{"datasource": datasourceLabelName, "datasource_type": datasourceLabelType} labels := prometheus.Labels{
"datasource": datasourceLabelName,
"datasource_type": datasourceLabelType,
"secure_socks_ds_proxy_enabled": strconv.FormatBool(opts.ProxyOptions != nil && opts.ProxyOptions.Enabled),
}
return executeMiddlewareFunc(next, labels) return executeMiddlewareFunc(next, labels)
}) })

View File

@ -5,6 +5,7 @@ import (
"testing" "testing"
"github.com/grafana/grafana-plugin-sdk-go/backend/httpclient" "github.com/grafana/grafana-plugin-sdk-go/backend/httpclient"
"github.com/grafana/grafana-plugin-sdk-go/backend/proxy"
"github.com/prometheus/client_golang/prometheus" "github.com/prometheus/client_golang/prometheus"
"github.com/stretchr/testify/require" "github.com/stretchr/testify/require"
) )
@ -103,29 +104,56 @@ func TestDataSourceMetricsMiddleware(t *testing.T) {
executeMiddlewareFunc = origExecuteMiddlewareFunc executeMiddlewareFunc = origExecuteMiddlewareFunc
}) })
ctx := &testContext{} testCases := []struct {
finalRoundTripper := ctx.createRoundTripper("finalrt") description string
mw := DataSourceMetricsMiddleware() httpClientOptions httpclient.Options
rt := mw.CreateMiddleware(httpclient.Options{Labels: map[string]string{"datasource_name": "My Data Source 123", "datasource_type": "prometheus"}}, finalRoundTripper) expectedSecureSocksDSProxyEnabled string
require.NotNil(t, rt) }{
middlewareName, ok := mw.(httpclient.MiddlewareName) {
require.True(t, ok) description: "secure socks ds proxy is disabled",
require.Equal(t, DataSourceMetricsMiddlewareName, middlewareName.MiddlewareName()) httpClientOptions: httpclient.Options{
Labels: map[string]string{"datasource_name": "My Data Source 123", "datasource_type": "prometheus"},
req, err := http.NewRequest(http.MethodGet, "http://", nil) },
require.NoError(t, err) expectedSecureSocksDSProxyEnabled: "false",
res, err := rt.RoundTrip(req) },
require.NoError(t, err) {
require.NotNil(t, res) description: "secure socks ds proxy is enabled",
if res.Body != nil { httpClientOptions: httpclient.Options{
require.NoError(t, res.Body.Close()) Labels: map[string]string{"datasource_name": "My Data Source 123", "datasource_type": "prometheus"},
ProxyOptions: &proxy.Options{Enabled: true},
},
expectedSecureSocksDSProxyEnabled: "true",
},
}
for _, tt := range testCases {
t.Run(tt.description, func(t *testing.T) {
ctx := &testContext{}
finalRoundTripper := ctx.createRoundTripper("finalrt")
mw := DataSourceMetricsMiddleware()
rt := mw.CreateMiddleware(tt.httpClientOptions, finalRoundTripper)
require.NotNil(t, rt)
middlewareName, ok := mw.(httpclient.MiddlewareName)
require.True(t, ok)
require.Equal(t, DataSourceMetricsMiddlewareName, middlewareName.MiddlewareName())
req, err := http.NewRequest(http.MethodGet, "http://", nil)
require.NoError(t, err)
res, err := rt.RoundTrip(req)
require.NoError(t, err)
require.NotNil(t, res)
if res.Body != nil {
require.NoError(t, res.Body.Close())
}
require.Len(t, ctx.callChain, 1)
require.ElementsMatch(t, []string{"finalrt"}, ctx.callChain)
require.True(t, executeMiddlewareCalled)
require.Len(t, labels, 3)
require.Equal(t, "My_Data_Source_123", labels["datasource"])
require.Equal(t, "prometheus", labels["datasource_type"])
require.Equal(t, tt.expectedSecureSocksDSProxyEnabled, labels["secure_socks_ds_proxy_enabled"])
require.True(t, middlewareCalled)
})
} }
require.Len(t, ctx.callChain, 1)
require.ElementsMatch(t, []string{"finalrt"}, ctx.callChain)
require.True(t, executeMiddlewareCalled)
require.Len(t, labels, 2)
require.Equal(t, "My_Data_Source_123", labels["datasource"])
require.Equal(t, "prometheus", labels["datasource_type"])
require.True(t, middlewareCalled)
}) })
} }