Skip to content

Commit 84e5c3a

Browse files
kylebrandtbohandley
kylebrandt
and
bohandley
authored
Prometheus/Promlib: Remove the PrometheusDataplane feature so always enabled (grafana#92218)
This has been default behavior since v10 --------- Co-authored-by: Brendan O'Handley <[email protected]>
1 parent fa95eb8 commit 84e5c3a

File tree

17 files changed

+106
-138
lines changed

17 files changed

+106
-138
lines changed

‎docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md

Lines changed: 47 additions & 48 deletions
Large diffs are not rendered by default.

‎packages/grafana-data/src/types/featureToggles.gen.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,6 @@ export interface FeatureToggles {
5959
influxqlStreamingParser?: boolean;
6060
influxdbRunQueriesInParallel?: boolean;
6161
prometheusRunQueriesInParallel?: boolean;
62-
prometheusDataplane?: boolean;
6362
lokiMetricDataplane?: boolean;
6463
lokiLogsDataplane?: boolean;
6564
dataplaneFrontendFallback?: boolean;

‎packages/grafana-prometheus/src/result_transformer.test.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,6 @@ jest.mock('@grafana/runtime', () => ({
2929
},
3030
};
3131
},
32-
config: {
33-
featureToggles: {
34-
prometheusDataplane: true,
35-
},
36-
},
3732
}));
3833

3934
describe('Prometheus Result Transformer', () => {

‎packages/grafana-prometheus/src/result_transformer.ts

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import {
1717
TIME_SERIES_TIME_FIELD_NAME,
1818
TIME_SERIES_VALUE_FIELD_NAME,
1919
} from '@grafana/data';
20-
import { config, getDataSourceSrv } from '@grafana/runtime';
20+
import { getDataSourceSrv } from '@grafana/runtime';
2121

2222
import { ExemplarTraceIdDestination, PromMetric, PromQuery, PromValue } from './types';
2323

@@ -54,21 +54,19 @@ export function transformV2(
5454
options: { exemplarTraceIdDestinations?: ExemplarTraceIdDestination[] }
5555
) {
5656
// migration for dataplane field name issue
57-
if (config.featureToggles.prometheusDataplane) {
58-
// update displayNameFromDS in the field config
59-
response.data.forEach((f: DataFrame) => {
60-
const target = request.targets.find((t) => t.refId === f.refId);
61-
// check that the legend is selected as auto
62-
if (target && target.legendFormat === '__auto') {
63-
f.fields.forEach((field) => {
64-
if (field.labels?.__name__ && field.labels?.__name__ === field.name) {
65-
const fieldCopy = { ...field, name: TIME_SERIES_VALUE_FIELD_NAME };
66-
field.config.displayNameFromDS = getFieldDisplayName(fieldCopy, f, response.data);
67-
}
68-
});
69-
}
70-
});
71-
}
57+
// update displayNameFromDS in the field config
58+
response.data.forEach((f: DataFrame) => {
59+
const target = request.targets.find((t) => t.refId === f.refId);
60+
// check that the legend is selected as auto
61+
if (target && target.legendFormat === '__auto') {
62+
f.fields.forEach((field) => {
63+
if (field.labels?.__name__ && field.labels?.__name__ === field.name) {
64+
const fieldCopy = { ...field, name: TIME_SERIES_VALUE_FIELD_NAME };
65+
field.config.displayNameFromDS = getFieldDisplayName(fieldCopy, f, response.data);
66+
}
67+
});
68+
}
69+
});
7270

7371
const [tableFrames, framesWithoutTable] = partition<DataFrame>(response.data, (df) => isTableResult(df, request));
7472
const processedTableFrames = transformDFToTable(tableFrames);

‎pkg/promlib/querydata/request.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ func (s *QueryData) rangeQuery(ctx context.Context, c *client.Client, q *models.
242242
}
243243
}()
244244

245-
return s.parseResponse(ctx, q, res, enablePrometheusDataplaneFlag)
245+
return s.parseResponse(ctx, q, res)
246246
}
247247

248248
func (s *QueryData) instantQuery(ctx context.Context, c *client.Client, q *models.Query, enablePrometheusDataplaneFlag bool) backend.DataResponse {
@@ -268,7 +268,7 @@ func (s *QueryData) instantQuery(ctx context.Context, c *client.Client, q *model
268268
}
269269
}()
270270

271-
return s.parseResponse(ctx, q, res, enablePrometheusDataplaneFlag)
271+
return s.parseResponse(ctx, q, res)
272272
}
273273

274274
func (s *QueryData) exemplarQuery(ctx context.Context, c *client.Client, q *models.Query, enablePrometheusDataplaneFlag bool) backend.DataResponse {
@@ -285,7 +285,7 @@ func (s *QueryData) exemplarQuery(ctx context.Context, c *client.Client, q *mode
285285
s.log.Warn("Failed to close response body", "error", err)
286286
}
287287
}()
288-
return s.parseResponse(ctx, q, res, enablePrometheusDataplaneFlag)
288+
return s.parseResponse(ctx, q, res)
289289
}
290290

291291
func addDataResponse(res *backend.DataResponse, dr *backend.DataResponse) {

‎pkg/promlib/querydata/request_test.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ func TestPrometheus_parseTimeSeriesResponse(t *testing.T) {
137137
require.Equal(t, "Time", res[0].Fields[0].Name)
138138
require.Len(t, res[0].Fields[1].Labels, 2)
139139
require.Equal(t, "app=Application, tag2=tag2", res[0].Fields[1].Labels.String())
140-
require.Equal(t, "legend Application", res[0].Name)
140+
require.Equal(t, "legend Application", res[0].Fields[1].Config.DisplayNameFromDS)
141141

142142
// Ensure the timestamps are UTC zoned
143143
testValue := res[0].Fields[0].At(0)
@@ -231,7 +231,7 @@ func TestPrometheus_parseTimeSeriesResponse(t *testing.T) {
231231
require.Equal(t, res[0].Fields[0].Name, "Time")
232232
require.Len(t, res[0].Fields[1].Labels, 2)
233233
require.Equal(t, res[0].Fields[1].Labels.String(), "app=Application, tag2=tag2")
234-
require.Equal(t, "{app=\"Application\", tag2=\"tag2\"}", res[0].Name)
234+
require.Equal(t, `{app="Application", tag2="tag2"}`, res[0].Fields[1].Config.DisplayNameFromDS)
235235
})
236236

237237
t.Run("matrix response with NaN value should be changed to null", func(t *testing.T) {
@@ -269,7 +269,7 @@ func TestPrometheus_parseTimeSeriesResponse(t *testing.T) {
269269
res, err := execute(tctx, query, result)
270270
require.NoError(t, err)
271271

272-
require.Equal(t, "{app=\"Application\"}", res[0].Name)
272+
require.Equal(t, `{app="Application"}`, res[0].Fields[1].Config.DisplayNameFromDS)
273273
require.True(t, math.IsNaN(res[0].Fields[1].At(0).(float64)))
274274
})
275275

@@ -308,7 +308,7 @@ func TestPrometheus_parseTimeSeriesResponse(t *testing.T) {
308308
require.Equal(t, res[0].Fields[0].Name, "Time")
309309
require.Len(t, res[0].Fields[1].Labels, 2)
310310
require.Equal(t, res[0].Fields[1].Labels.String(), "app=Application, tag2=tag2")
311-
require.Equal(t, "legend Application", res[0].Name)
311+
require.Equal(t, "legend Application", res[0].Fields[1].Config.DisplayNameFromDS)
312312

313313
// Ensure the timestamps are UTC zoned
314314
testValue := res[0].Fields[0].At(0)

‎pkg/promlib/querydata/response.go

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import (
1818
"github.com/grafana/grafana/pkg/promlib/utils"
1919
)
2020

21-
func (s *QueryData) parseResponse(ctx context.Context, q *models.Query, res *http.Response, enablePrometheusDataplaneFlag bool) backend.DataResponse {
21+
func (s *QueryData) parseResponse(ctx context.Context, q *models.Query, res *http.Response) backend.DataResponse {
2222
defer func() {
2323
if err := res.Body.Close(); err != nil {
2424
s.log.FromContext(ctx).Error("Failed to close response body", "err", err)
@@ -29,9 +29,7 @@ func (s *QueryData) parseResponse(ctx context.Context, q *models.Query, res *htt
2929
defer endSpan()
3030

3131
iter := jsoniter.Parse(jsoniter.ConfigDefault, res.Body, 1024)
32-
r := converter.ReadPrometheusStyleResult(iter, converter.Options{
33-
Dataplane: enablePrometheusDataplaneFlag,
34-
})
32+
r := converter.ReadPrometheusStyleResult(iter, converter.Options{Dataplane: true})
3533
r.Status = backend.Status(res.StatusCode)
3634

3735
// Add frame to attach metadata
@@ -41,7 +39,7 @@ func (s *QueryData) parseResponse(ctx context.Context, q *models.Query, res *htt
4139

4240
// The ExecutedQueryString can be viewed in QueryInspector in UI
4341
for i, frame := range r.Frames {
44-
addMetadataToMultiFrame(q, frame, enablePrometheusDataplaneFlag)
42+
addMetadataToMultiFrame(q, frame)
4543
if i == 0 {
4644
frame.Meta.ExecutedQueryString = executedQueryString(q)
4745
}
@@ -106,7 +104,7 @@ func (s *QueryData) processExemplars(ctx context.Context, q *models.Query, dr ba
106104
}
107105
}
108106

109-
func addMetadataToMultiFrame(q *models.Query, frame *data.Frame, enableDataplane bool) {
107+
func addMetadataToMultiFrame(q *models.Query, frame *data.Frame) {
110108
if frame.Meta == nil {
111109
frame.Meta = &data.FrameMeta{}
112110
}
@@ -120,13 +118,9 @@ func addMetadataToMultiFrame(q *models.Query, frame *data.Frame, enableDataplane
120118
frame.Fields[1].Config = &data.FieldConfig{DisplayNameFromDS: customName}
121119
}
122120

123-
if enableDataplane {
124-
valueField := frame.Fields[1]
125-
if n, ok := valueField.Labels["__name__"]; ok {
126-
valueField.Name = n
127-
}
128-
} else {
129-
frame.Name = customName
121+
valueField := frame.Fields[1]
122+
if n, ok := valueField.Labels["__name__"]; ok {
123+
valueField.Name = n
130124
}
131125
}
132126

‎pkg/promlib/querydata/response_test.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,39 +19,39 @@ func TestQueryData_parseResponse(t *testing.T) {
1919
t.Run("resultType is before result the field must parsed normally", func(t *testing.T) {
2020
resBody := `{"data":{"resultType":"vector", "result":[{"metric":{"__name__":"some_name","environment":"some_env","id":"some_id","instance":"some_instance:1234","job":"some_job","name":"another_name","region":"some_region"},"value":[1.1,"2"]}]},"status":"success"}`
2121
res := &http.Response{Body: io.NopCloser(bytes.NewBufferString(resBody))}
22-
result := qd.parseResponse(context.Background(), &models.Query{}, res, false)
22+
result := qd.parseResponse(context.Background(), &models.Query{}, res)
2323
assert.Nil(t, result.Error)
2424
assert.Len(t, result.Frames, 1)
2525
})
2626

2727
t.Run("resultType is after the result field must parsed normally", func(t *testing.T) {
2828
resBody := `{"data":{"result":[{"metric":{"__name__":"some_name","environment":"some_env","id":"some_id","instance":"some_instance:1234","job":"some_job","name":"another_name","region":"some_region"},"value":[1.1,"2"]}],"resultType":"vector"},"status":"success"}`
2929
res := &http.Response{Body: io.NopCloser(bytes.NewBufferString(resBody))}
30-
result := qd.parseResponse(context.Background(), &models.Query{}, res, false)
30+
result := qd.parseResponse(context.Background(), &models.Query{}, res)
3131
assert.Nil(t, result.Error)
3232
assert.Len(t, result.Frames, 1)
3333
})
3434

3535
t.Run("no resultType is existed in the data", func(t *testing.T) {
3636
resBody := `{"data":{"result":[{"metric":{"__name__":"some_name","environment":"some_env","id":"some_id","instance":"some_instance:1234","job":"some_job","name":"another_name","region":"some_region"},"value":[1.1,"2"]}]},"status":"success"}`
3737
res := &http.Response{Body: io.NopCloser(bytes.NewBufferString(resBody))}
38-
result := qd.parseResponse(context.Background(), &models.Query{}, res, false)
38+
result := qd.parseResponse(context.Background(), &models.Query{}, res)
3939
assert.Error(t, result.Error)
4040
assert.Equal(t, result.Error.Error(), "no resultType found")
4141
})
4242

4343
t.Run("resultType is set as empty string before result", func(t *testing.T) {
4444
resBody := `{"data":{"resultType":"", "result":[{"metric":{"__name__":"some_name","environment":"some_env","id":"some_id","instance":"some_instance:1234","job":"some_job","name":"another_name","region":"some_region"},"value":[1.1,"2"]}]},"status":"success"}`
4545
res := &http.Response{Body: io.NopCloser(bytes.NewBufferString(resBody))}
46-
result := qd.parseResponse(context.Background(), &models.Query{}, res, false)
46+
result := qd.parseResponse(context.Background(), &models.Query{}, res)
4747
assert.Error(t, result.Error)
4848
assert.Equal(t, result.Error.Error(), "unknown result type: ")
4949
})
5050

5151
t.Run("resultType is set as empty string after result", func(t *testing.T) {
5252
resBody := `{"data":{"result":[{"metric":{"__name__":"some_name","environment":"some_env","id":"some_id","instance":"some_instance:1234","job":"some_job","name":"another_name","region":"some_region"},"value":[1.1,"2"]}],"resultType":""},"status":"success"}`
5353
res := &http.Response{Body: io.NopCloser(bytes.NewBufferString(resBody))}
54-
result := qd.parseResponse(context.Background(), &models.Query{}, res, false)
54+
result := qd.parseResponse(context.Background(), &models.Query{}, res)
5555
assert.Error(t, result.Error)
5656
assert.Equal(t, result.Error.Error(), "unknown result type: ")
5757
})

‎pkg/promlib/testdata/range_auto.result.golden.jsonc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
// "type": "timeseries-multi",
55
// "typeVersion": [
66
// 0,
7-
// 0
7+
// 1
88
// ],
99
// "custom": {
1010
// "resultType": "matrix"
1111
// },
1212
// "executedQueryString": "Expr: histogram_quantile(0.95, sum(rate(tns_request_duration_seconds_bucket[4s])) by (le))\nStep: 1s"
1313
// }
14-
// Name: histogram_quantile(0.95, sum(rate(tns_request_duration_seconds_bucket[4s])) by (le))
14+
// Name:
1515
// Dimensions: 2 Fields by 301 Rows
1616
// +-----------------------------------+----------------------+
1717
// | Name: Time | Name: Value |
@@ -37,12 +37,11 @@
3737
"frames": [
3838
{
3939
"schema": {
40-
"name": "histogram_quantile(0.95, sum(rate(tns_request_duration_seconds_bucket[4s])) by (le))",
4140
"meta": {
4241
"type": "timeseries-multi",
4342
"typeVersion": [
4443
0,
45-
0
44+
1
4645
],
4746
"custom": {
4847
"resultType": "matrix"

‎pkg/promlib/testdata/range_infinity.result.golden.jsonc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
// "type": "timeseries-multi",
55
// "typeVersion": [
66
// 0,
7-
// 0
7+
// 1
88
// ],
99
// "custom": {
1010
// "resultType": "matrix"
1111
// },
1212
// "executedQueryString": "Expr: 1 / 0\nStep: 1s"
1313
// }
14-
// Name: 1 / 0
14+
// Name:
1515
// Dimensions: 2 Fields by 3 Rows
1616
// +-------------------------------+-----------------+
1717
// | Name: Time | Name: Value |
@@ -30,12 +30,11 @@
3030
"frames": [
3131
{
3232
"schema": {
33-
"name": "1 / 0",
3433
"meta": {
3534
"type": "timeseries-multi",
3635
"typeVersion": [
3736
0,
38-
0
37+
1
3938
],
4039
"custom": {
4140
"resultType": "matrix"

0 commit comments

Comments
 (0)