From 89fb56bc1125fbe078f31a87320bf5c386502dba Mon Sep 17 00:00:00 2001 From: Bruno Date: Thu, 1 Feb 2024 11:42:43 -0300 Subject: [PATCH] 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 --- .../datasource_metrics_middleware.go | 15 ++-- .../datasource_metrics_middleware_test.go | 74 +++++++++++++------ 2 files changed, 61 insertions(+), 28 deletions(-) diff --git a/pkg/infra/httpclient/httpclientprovider/datasource_metrics_middleware.go b/pkg/infra/httpclient/httpclientprovider/datasource_metrics_middleware.go index 3f8c95ac956..012755732d6 100644 --- a/pkg/infra/httpclient/httpclientprovider/datasource_metrics_middleware.go +++ b/pkg/infra/httpclient/httpclientprovider/datasource_metrics_middleware.go @@ -2,6 +2,7 @@ package httpclientprovider import ( "net/http" + "strconv" sdkhttpclient "github.com/grafana/grafana-plugin-sdk-go/backend/httpclient" "github.com/grafana/grafana/pkg/infra/httpclient" @@ -18,7 +19,7 @@ var ( Name: "datasource_request_total", 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( @@ -27,7 +28,7 @@ var ( Name: "datasource_request_duration_seconds", 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}, - }, []string{"datasource", "datasource_type", "code", "method"}, + }, []string{"datasource", "datasource_type", "code", "method", "secure_socks_ds_proxy_enabled"}, ) datasourceResponseHistogram = promauto.NewHistogramVec( @@ -36,7 +37,7 @@ var ( Name: "datasource_response_size_bytes", 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}, - }, []string{"datasource", "datasource_type"}, + }, []string{"datasource", "datasource_type", "secure_socks_ds_proxy_enabled"}, ) datasourceRequestsInFlight = promauto.NewGaugeVec( @@ -45,7 +46,7 @@ var ( Name: "datasource_request_in_flight", 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 } - 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) }) diff --git a/pkg/infra/httpclient/httpclientprovider/datasource_metrics_middleware_test.go b/pkg/infra/httpclient/httpclientprovider/datasource_metrics_middleware_test.go index 37afde4fd96..28874be941f 100644 --- a/pkg/infra/httpclient/httpclientprovider/datasource_metrics_middleware_test.go +++ b/pkg/infra/httpclient/httpclientprovider/datasource_metrics_middleware_test.go @@ -5,6 +5,7 @@ import ( "testing" "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/stretchr/testify/require" ) @@ -103,29 +104,56 @@ func TestDataSourceMetricsMiddleware(t *testing.T) { executeMiddlewareFunc = origExecuteMiddlewareFunc }) - ctx := &testContext{} - finalRoundTripper := ctx.createRoundTripper("finalrt") - mw := DataSourceMetricsMiddleware() - rt := mw.CreateMiddleware(httpclient.Options{Labels: map[string]string{"datasource_name": "My Data Source 123", "datasource_type": "prometheus"}}, 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()) + testCases := []struct { + description string + httpClientOptions httpclient.Options + expectedSecureSocksDSProxyEnabled string + }{ + { + description: "secure socks ds proxy is disabled", + httpClientOptions: httpclient.Options{ + Labels: map[string]string{"datasource_name": "My Data Source 123", "datasource_type": "prometheus"}, + }, + expectedSecureSocksDSProxyEnabled: "false", + }, + { + description: "secure socks ds proxy is enabled", + httpClientOptions: httpclient.Options{ + 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) }) }