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.
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Plugins: Add deprecation notice for /api/tsdb/query endpoint #45238
Plugins: Add deprecation notice for /api/tsdb/query endpoint #45238
Changes from all commits
286b75db0d6f66bc11a7518ef8a80520d71c09cbd65e83aa20a02280038fd4cb5518ddee31489f21b97548863b7547fbe3bc06246222dbc4a83b96fb9b8c99f6fa77619ec3eccad678afa6a8e16a4c9ebc8547a4da971d4a89edfae47d1e1e0b415606a5b3dFile filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
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 think that we might need to update the
queryMetricsWithExpressionsdefinition to make it output proper response example in open api spec because the data frames conversion to JSON is custom, but I might be wrong?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.
Do you mean when it returns encoded arrow? AFAIK everything is JSON nowadays https://github.com/grafana/grafana/blob/main/pkg/api/metrics.go#L98
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.
Was referring to JSON, but haven't checked swagger or the generated open api spec so not sure. Mainly referring to this https://github.com/grafana/grafana-plugin-sdk-go/blob/a6e537820b7b4554637de588e87ca2d77b8cad90/backend/data.go#L74-L82 that writes the JSON in a custom way by iterating the responses/frames.
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.
Checked using swagger now, http://localhost:3000/swagger-ui. This might be a bigger problem than just this endpoint and potentially something we might attack later. But here it goes.
The request body example includes the following:
{ "debug": true, "from": "now-1h", "queries": [ { "datasourceId": 86, "format": "table", "intervalMs": 86400000, "maxDataPoints": 1092, "rawSql": "SELECT 1 as valueOne, 2 as valueTwo", "refId": "A" } ], "to": "now" }The 200 response includes the following:
Details
{ "Responses": { "additionalProp1": { "message": "string", "results": { "additionalProp1": { "dataframes": {}, "error": "string", "meta": {}, "refId": "string", "series": [ { "name": "string", "points": [ [ { "Float64": 0, "Valid": true } ] ], "tags": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } ], "tables": [ { "columns": [ { "text": "string" } ], "rows": [ [ {} ] ] } ] }, "additionalProp2": { "dataframes": {}, "error": "string", "meta": {}, "refId": "string", "series": [ { "name": "string", "points": [ [ { "Float64": 0, "Valid": true } ] ], "tags": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } ], "tables": [ { "columns": [ { "text": "string" } ], "rows": [ [ {} ] ] } ] }, "additionalProp3": { "dataframes": {}, "error": "string", "meta": {}, "refId": "string", "series": [ { "name": "string", "points": [ [ { "Float64": 0, "Valid": true } ] ], "tags": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } ], "tables": [ { "columns": [ { "text": "string" } ], "rows": [ [ {} ] ] } ] } } }, "additionalProp2": { "message": "string", "results": { "additionalProp1": { "dataframes": {}, "error": "string", "meta": {}, "refId": "string", "series": [ { "name": "string", "points": [ [ { "Float64": 0, "Valid": true } ] ], "tags": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } ], "tables": [ { "columns": [ { "text": "string" } ], "rows": [ [ {} ] ] } ] }, "additionalProp2": { "dataframes": {}, "error": "string", "meta": {}, "refId": "string", "series": [ { "name": "string", "points": [ [ { "Float64": 0, "Valid": true } ] ], "tags": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } ], "tables": [ { "columns": [ { "text": "string" } ], "rows": [ [ {} ] ] } ] }, "additionalProp3": { "dataframes": {}, "error": "string", "meta": {}, "refId": "string", "series": [ { "name": "string", "points": [ [ { "Float64": 0, "Valid": true } ] ], "tags": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } ], "tables": [ { "columns": [ { "text": "string" } ], "rows": [ [ {} ] ] } ] } } }, "additionalProp3": { "message": "string", "results": { "additionalProp1": { "dataframes": {}, "error": "string", "meta": {}, "refId": "string", "series": [ { "name": "string", "points": [ [ { "Float64": 0, "Valid": true } ] ], "tags": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } ], "tables": [ { "columns": [ { "text": "string" } ], "rows": [ [ {} ] ] } ] }, "additionalProp2": { "dataframes": {}, "error": "string", "meta": {}, "refId": "string", "series": [ { "name": "string", "points": [ [ { "Float64": 0, "Valid": true } ] ], "tags": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } ], "tables": [ { "columns": [ { "text": "string" } ], "rows": [ [ {} ] ] } ] }, "additionalProp3": { "dataframes": {}, "error": "string", "meta": {}, "refId": "string", "series": [ { "name": "string", "points": [ [ { "Float64": 0, "Valid": true } ] ], "tags": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } ], "tables": [ { "columns": [ { "text": "string" } ], "rows": [ [ {} ] ] } ] } } } } }