Plugins: Add deprecation notice for /api/tsdb/query endpoint #45238
Conversation
|
This pull request was removed from the 8.4.1 milestone because 8.4.1 is currently being released. |
There was a problem hiding this comment.
LGTM, but added some comments/suggestions.
Remember to add a deprecation notice in the PR description, see instructions in Merge a pull request.
| @@ -200,13 +200,17 @@ import ( | |||
| // | |||
| // Query metrics. | |||
| // | |||
| // Please refer to [updated API](#/ds/queryMetricsWithExpressions) instead | |||
There was a problem hiding this comment.
I think that we might need to update the queryMetricsWithExpressions definition 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.
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.
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.
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": [
[
{}
]
]
}
]
}
}
}
}
}
wbrowne
added
no-backport
wbrowne
changed the title
Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
|
Thanks for the review @achatterjee-grafana! FYI I have actually decided to remove the explicit annotations for |
What this PR does / why we need it:
This PR ensures references to
/api/tsdb/queryare marked as deprecated, and includes recommendations to use the newer/api/ds/queryin its place.Deprecation notice
/api/tsdb/queryAPI has been deprecated and will be removed in a future release. Use /api/ds/query instead.