IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Plugins: Remove deprecated /api/tsdb/query metrics endpoint (#49916)

Browse Source 
* remove /api/tsdb/query

* revert changes to alert rules

* regenerate spec based on 9.0.x
This commit is contained in:
Will Browne
2022-06-01 13:05:15 +02:00
committed by GitHub
parent 63303eb4ba
commit abfc711c53
13 changed files with 869 additions and 546 deletions
Download Patch File Download Diff File Expand all files Collapse all files

596
public/api-spec.json
View File

@@ -7464,45 +7464,6 @@
}
}
},
"/tsdb/query": {
"post": {
"description": "Please refer to [updated API](#/ds/queryMetricsWithExpressions) instead\n\nQueries a data source having backend implementation.\n\nMost of Grafana’s builtin data sources have backend implementation.\n\nIf you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:query`.",
"tags": ["datasources"],
"summary": "Query metrics.",
"operationId": "queryDatasource",
"deprecated": true,
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MetricRequest"
}
}
],
"responses": {
"200": {
"$ref": "#/responses/queryDatasourceResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
},
"401": {
"$ref": "#/responses/unauthorisedError"
},
"403": {
"$ref": "#/responses/forbiddenError"
},
"404": {
"$ref": "#/responses/notFoundError"
},
"500": {
"$ref": "#/responses/internalServerError"
}
}
}
},
"/user": {
"get": {
"tags": ["signed_in_user"],
@@ -9099,6 +9060,12 @@
},
"x-go-package": "github.com/grafana/grafana/pkg/models"
},
"ConfFloat64": {
"description": "ConfFloat64 is a float64. It Marshals float64 values of NaN of Inf\nto null.",
"type": "number",
"format": "double",
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"ConfigDTO": {
"description": "ConfigDTO is model representation in transfer",
"type": "object",
@@ -10053,67 +10020,39 @@
},
"x-go-package": "github.com/grafana/grafana/pkg/models"
},
"DataFrames": {
"description": "See NewDecodedDataFrames and NewEncodedDataFrames for more information.",
"type": "object",
"title": "DataFrames is an interface for retrieving encoded and decoded data frames.",
"x-go-package": "github.com/grafana/grafana/pkg/tsdb/legacydata"
},
"DataQueryResult": {
"description": "Deprecated: DataQueryResult should use backend.QueryDataResponse",
"DataLink": {
"description": "DataLink define what",
"type": "object",
"properties": {
"dataframes": {
"$ref": "#/definitions/DataFrames"
"targetBlank": {
"type": "boolean",
"x-go-name": "TargetBlank"
},
"error": {
"title": {
"type": "string",
"x-go-name": "ErrorString"
"x-go-name": "Title"
},
"meta": {
"$ref": "#/definitions/Json"
},
"refId": {
"url": {
"type": "string",
"x-go-name": "RefID"
},
"series": {
"$ref": "#/definitions/DataTimeSeriesSlice"
},
"tables": {
"type": "array",
"items": {
"$ref": "#/definitions/DataTable"
},
"x-go-name": "Tables"
"x-go-name": "URL"
}
},
"x-go-package": "github.com/grafana/grafana/pkg/tsdb/legacydata"
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"DataResponse": {
"description": "Deprecated: DataResponse -- this structure is deprecated, all new work should use backend.QueryDataResponse",
"description": "A map of RefIDs (unique query identifers) to this type makes up the Responses property of a QueryDataResponse.\nThe Error property is used to allow for partial success responses from the containing QueryDataResponse.",
"type": "object",
"title": "DataResponse contains the results from a DataQuery.",
"properties": {
"message": {
"type": "string",
"x-go-name": "Message"
"Error": {
"description": "Error is a property to be set if the the corresponding DataQuery has an error.",
"type": "string"
},
"results": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/DataQueryResult"
},
"x-go-name": "Results"
"Frames": {
"$ref": "#/definitions/Frames"
}
},
"x-go-package": "github.com/grafana/grafana/pkg/tsdb/legacydata"
},
"DataRowValues": {
"type": "array",
"items": {
"type": "object"
},
"x-go-package": "github.com/grafana/grafana/pkg/tsdb/legacydata"
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/backend"
},
"DataSource": {
"type": "object",
@@ -10285,78 +10224,6 @@
},
"x-go-package": "github.com/grafana/grafana/pkg/api/dtos"
},
"DataTable": {
"type": "object",
"properties": {
"columns": {
"type": "array",
"items": {
"$ref": "#/definitions/DataTableColumn"
},
"x-go-name": "Columns"
},
"rows": {
"type": "array",
"items": {
"$ref": "#/definitions/DataRowValues"
},
"x-go-name": "Rows"
}
},
"x-go-package": "github.com/grafana/grafana/pkg/tsdb/legacydata"
},
"DataTableColumn": {
"type": "object",
"properties": {
"text": {
"type": "string",
"x-go-name": "Text"
}
},
"x-go-package": "github.com/grafana/grafana/pkg/tsdb/legacydata"
},
"DataTimePoint": {
"type": "array",
"items": {
"$ref": "#/definitions/Float"
},
"x-go-package": "github.com/grafana/grafana/pkg/tsdb/legacydata"
},
"DataTimeSeries": {
"description": "DataTimeSeries -- this structure is deprecated, all new work should use DataFrames from the SDK",
"type": "object",
"properties": {
"name": {
"type": "string",
"x-go-name": "Name"
},
"points": {
"$ref": "#/definitions/DataTimeSeriesPoints"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"x-go-name": "Tags"
}
},
"x-go-package": "github.com/grafana/grafana/pkg/tsdb/legacydata"
},
"DataTimeSeriesPoints": {
"type": "array",
"items": {
"$ref": "#/definitions/DataTimePoint"
},
"x-go-package": "github.com/grafana/grafana/pkg/tsdb/legacydata"
},
"DataTimeSeriesSlice": {
"type": "array",
"items": {
"$ref": "#/definitions/DataTimeSeries"
},
"x-go-package": "github.com/grafana/grafana/pkg/tsdb/legacydata"
},
"DeleteTokenCommand": {
"type": "object",
"properties": {
@@ -10438,6 +10305,119 @@
},
"x-go-package": "github.com/grafana/grafana/pkg/extensions/ldapsync"
},
"Field": {
"description": "A Field is essentially a slice of various types with extra properties and methods.\nSee NewField() for supported types.\n\nThe slice data in the Field is a not exported, so methods on the Field are used to to manipulate its data.",
"type": "object",
"title": "Field represents a typed column of data within a Frame.",
"properties": {
"config": {
"$ref": "#/definitions/FieldConfig"
},
"labels": {
"$ref": "#/definitions/Labels"
},
"name": {
"description": "Name is default identifier of the field. The name does not have to be unique, but the combination\nof name and Labels should be unique for proper behavior in all situations.",
"type": "string",
"x-go-name": "Name"
}
},
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"FieldConfig": {
"type": "object",
"title": "FieldConfig represents the display properties for a Field.",
"properties": {
"color": {
"description": "Map values to a display color\nNOTE: this interface is under development in the frontend... so simple map for now",
"type": "object",
"additionalProperties": {
"type": "object"
},
"x-go-name": "Color"
},
"custom": {
"description": "Panel Specific Values",
"type": "object",
"additionalProperties": {
"type": "object"
},
"x-go-name": "Custom"
},
"decimals": {
"type": "integer",
"format": "uint16",
"x-go-name": "Decimals"
},
"description": {
"description": "Description is human readable field metadata",
"type": "string",
"x-go-name": "Description"
},
"displayName": {
"description": "DisplayName overrides Grafana default naming, should not be used from a data source",
"type": "string",
"x-go-name": "DisplayName"
},
"displayNameFromDS": {
"description": "DisplayNameFromDS overrides Grafana default naming in a better way that allows users to override it easily.",
"type": "string",
"x-go-name": "DisplayNameFromDS"
},
"filterable": {
"description": "Filterable indicates if the Field's data can be filtered by additional calls.",
"type": "boolean",
"x-go-name": "Filterable"
},
"interval": {
"description": "Interval indicates the expected regular step between values in the series.\nWhen an interval exists, consumers can identify \"missing\" values when the expected value is not present.\nThe grafana timeseries visualization will render disconnected values when missing values are found it the time field.\nThe interval uses the same units as the values. For time.Time, this is defined in milliseconds.",
"type": "number",
"format": "double",
"x-go-name": "Interval"
},
"links": {
"description": "The behavior when clicking on a result",
"type": "array",
"items": {
"$ref": "#/definitions/DataLink"
},
"x-go-name": "Links"
},
"mappings": {
"$ref": "#/definitions/ValueMappings"
},
"max": {
"$ref": "#/definitions/ConfFloat64"
},
"min": {
"$ref": "#/definitions/ConfFloat64"
},
"noValue": {
"description": "Alternative to empty string",
"type": "string",
"x-go-name": "NoValue"
},
"path": {
"description": "Path is an explicit path to the field in the datasource. When the frame meta includes a path,\nthis will default to `${frame.meta.path}/${field.name}\n\nWhen defined, this value can be used as an identifier within the datasource scope, and\nmay be used as an identifier to update values in a subsequent request",
"type": "string",
"x-go-name": "Path"
},
"thresholds": {
"$ref": "#/definitions/ThresholdsConfig"
},
"unit": {
"description": "Numeric Options",
"type": "string",
"x-go-name": "Unit"
},
"writeable": {
"description": "Writeable indicates that the datasource knows how to update this value",
"type": "boolean",
"x-go-name": "Writeable"
}
},
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"FindTagsResult": {
"type": "object",
"title": "FindTagsResult is the result of a tags search.",
@@ -10552,6 +10532,101 @@
},
"x-go-package": "github.com/grafana/grafana/pkg/api/dtos"
},
"Frame": {
"description": "Each Field is well typed by its FieldType and supports optional Labels.\n\nA Frame is a general data container for Grafana. A Frame can be table data\nor time series data depending on its content and field types.",
"type": "object",
"title": "Frame is a columnar data structure where each column is a Field.",
"properties": {
"Fields": {
"description": "Fields are the columns of a frame.\nAll Fields must be of the same the length when marshalling the Frame for transmission.",
"type": "array",
"items": {
"$ref": "#/definitions/Field"
}
},
"Meta": {
"$ref": "#/definitions/FrameMeta"
},
"Name": {
"description": "Name is used in some Grafana visualizations.",
"type": "string"
},
"RefID": {
"description": "RefID is a property that can be set to match a Frame to its originating query.",
"type": "string"
}
},
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"FrameMeta": {
"description": "https://github.com/grafana/grafana/blob/master/packages/grafana-data/src/types/data.ts#L11\nNOTE -- in javascript this can accept any `[key: string]: any;` however\nthis interface only exposes the values we want to be exposed",
"type": "object",
"title": "FrameMeta matches:",
"properties": {
"channel": {
"description": "Channel is the path to a stream in grafana live that has real-time updates for this data.",
"type": "string",
"x-go-name": "Channel"
},
"custom": {
"description": "Custom datasource specific values.",
"type": "object",
"x-go-name": "Custom"
},
"executedQueryString": {
"description": "ExecutedQueryString is the raw query sent to the underlying system. All macros and templating\nhave been applied. When metadata contains this value, it will be shown in the query inspector.",
"type": "string",
"x-go-name": "ExecutedQueryString"
},
"notices": {
"description": "Notices provide additional information about the data in the Frame that\nGrafana can display to the user in the user interface.",
"type": "array",
"items": {
"$ref": "#/definitions/Notice"
},
"x-go-name": "Notices"
},
"path": {
"description": "Path is a browsable path on the datasource.",
"type": "string",
"x-go-name": "Path"
},
"pathSeparator": {
"description": "PathSeparator defines the separator pattern to decode a hiearchy. The default separator is '/'.",
"type": "string",
"x-go-name": "PathSeparator"
},
"preferredVisualisationType": {
"$ref": "#/definitions/VisType"
},
"stats": {
"description": "Stats is an array of query result statistics.",
"type": "array",
"items": {
"$ref": "#/definitions/QueryStat"
},
"x-go-name": "Stats"
},
"type": {
"$ref": "#/definitions/FrameType"
}
},
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"FrameType": {
"description": "A FrameType string, when present in a frame's metadata, asserts that the\nframe's structure conforms to the FrameType's specification.\nThis property is currently optional, so FrameType may be FrameTypeUnknown even if the properties of\nthe Frame correspond to a defined FrameType.",
"type": "string",
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"Frames": {
"description": "It is the main data container within a backend.DataResponse.",
"type": "array",
"title": "Frames is a slice of Frame pointers.",
"items": {
"$ref": "#/definitions/Frame"
},
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"GetAnnotationTagsResponse": {
"type": "object",
"title": "GetAnnotationTagsResponse is a response struct for FindTagsResult.",
@@ -10799,6 +10874,12 @@
},
"x-go-package": "github.com/grafana/grafana/pkg/services/dashboardimport"
},
"InspectType": {
"type": "integer",
"format": "int64",
"title": "InspectType is a type for the Inspect property of a Notice.",
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"ItemDTO": {
"type": "object",
"properties": {
@@ -10896,6 +10977,14 @@
"type": "object",
"x-go-package": "github.com/grafana/grafana/pkg/components/simplejson"
},
"Labels": {
"description": "Labels are used to add metadata to an object. The JSON will always be sorted keys",
"type": "object",
"additionalProperties": {
"type": "string"
},
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"LibraryElementConnectionDTO": {
"type": "object",
"title": "LibraryElementConnectionDTO is the frontend DTO for element connections.",
@@ -11239,6 +11328,35 @@
},
"x-go-package": "github.com/grafana/grafana/pkg/api/dtos"
},
"Notice": {
"type": "object",
"title": "Notice provides a structure for presenting notifications in Grafana's user interface.",
"properties": {
"inspect": {
"$ref": "#/definitions/InspectType"
},
"link": {
"description": "Link is an optional link for display in the user interface and can be an\nabsolute URL or a path relative to Grafana's root url.",
"type": "string",
"x-go-name": "Link"
},
"severity": {
"$ref": "#/definitions/NoticeSeverity"
},
"text": {
"description": "Text is freeform descriptive text for the notice.",
"type": "string",
"x-go-name": "Text"
}
},
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"NoticeSeverity": {
"type": "integer",
"format": "int64",
"title": "NoticeSeverity is a type for the Severity property of a Notice.",
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"NotificationTestCommand": {
"type": "object",
"properties": {
@@ -11673,6 +11791,106 @@
},
"x-go-package": "github.com/grafana/grafana/pkg/services/preference"
},
"QueryStat": {
"description": "The embedded FieldConfig's display name must be set.\nIt corresponds to the QueryResultMetaStat on the frontend (https://github.com/grafana/grafana/blob/master/packages/grafana-data/src/types/data.ts#L53).",
"type": "object",
"title": "QueryStat is used for storing arbitrary statistics metadata related to a query and its result, e.g. total request time, data processing time.",
"properties": {
"color": {
"description": "Map values to a display color\nNOTE: this interface is under development in the frontend... so simple map for now",
"type": "object",
"additionalProperties": {
"type": "object"
},
"x-go-name": "Color"
},
"custom": {
"description": "Panel Specific Values",
"type": "object",
"additionalProperties": {
"type": "object"
},
"x-go-name": "Custom"
},
"decimals": {
"type": "integer",
"format": "uint16",
"x-go-name": "Decimals"
},
"description": {
"description": "Description is human readable field metadata",
"type": "string",
"x-go-name": "Description"
},
"displayName": {
"description": "DisplayName overrides Grafana default naming, should not be used from a data source",
"type": "string",
"x-go-name": "DisplayName"
},
"displayNameFromDS": {
"description": "DisplayNameFromDS overrides Grafana default naming in a better way that allows users to override it easily.",
"type": "string",
"x-go-name": "DisplayNameFromDS"
},
"filterable": {
"description": "Filterable indicates if the Field's data can be filtered by additional calls.",
"type": "boolean",
"x-go-name": "Filterable"
},
"interval": {
"description": "Interval indicates the expected regular step between values in the series.\nWhen an interval exists, consumers can identify \"missing\" values when the expected value is not present.\nThe grafana timeseries visualization will render disconnected values when missing values are found it the time field.\nThe interval uses the same units as the values. For time.Time, this is defined in milliseconds.",
"type": "number",
"format": "double",
"x-go-name": "Interval"
},
"links": {
"description": "The behavior when clicking on a result",
"type": "array",
"items": {
"$ref": "#/definitions/DataLink"
},
"x-go-name": "Links"
},
"mappings": {
"$ref": "#/definitions/ValueMappings"
},
"max": {
"$ref": "#/definitions/ConfFloat64"
},
"min": {
"$ref": "#/definitions/ConfFloat64"
},
"noValue": {
"description": "Alternative to empty string",
"type": "string",
"x-go-name": "NoValue"
},
"path": {
"description": "Path is an explicit path to the field in the datasource. When the frame meta includes a path,\nthis will default to `${frame.meta.path}/${field.name}\n\nWhen defined, this value can be used as an identifier within the datasource scope, and\nmay be used as an identifier to update values in a subsequent request",
"type": "string",
"x-go-name": "Path"
},
"thresholds": {
"$ref": "#/definitions/ThresholdsConfig"
},
"unit": {
"description": "Numeric Options",
"type": "string",
"x-go-name": "Unit"
},
"value": {
"type": "number",
"format": "double",
"x-go-name": "Value"
},
"writeable": {
"description": "Writeable indicates that the datasource knows how to update this value",
"type": "boolean",
"x-go-name": "Writeable"
}
},
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"RecordingRuleJSON": {
"description": "RecordingRuleJSON is the external representation of a recording rule",
"type": "object",
@@ -12332,6 +12550,47 @@
"type": "string",
"x-go-package": "github.com/grafana/grafana/pkg/models"
},
"Threshold": {
"description": "Threshold a single step on the threshold list",
"type": "object",
"properties": {
"color": {
"type": "string",
"x-go-name": "Color"
},
"state": {
"type": "string",
"x-go-name": "State"
},
"value": {
"$ref": "#/definitions/ConfFloat64"
}
},
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"ThresholdsConfig": {
"description": "ThresholdsConfig setup thresholds",
"type": "object",
"properties": {
"mode": {
"$ref": "#/definitions/ThresholdsMode"
},
"steps": {
"description": "Must be sorted by 'value', first value is always -Infinity",
"type": "array",
"items": {
"$ref": "#/definitions/Threshold"
},
"x-go-name": "Steps"
}
},
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"ThresholdsMode": {
"description": "ThresholdsMode absolute or percentage",
"type": "string",
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"TimeRangeDTO": {
"type": "object",
"properties": {
@@ -13186,6 +13445,23 @@
}
},
"x-go-package": "github.com/grafana/grafana/pkg/models"
},
"ValueMapping": {
"description": "ValueMapping allows mapping input values to text and color",
"type": "object",
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"ValueMappings": {
"type": "array",
"items": {
"$ref": "#/definitions/ValueMapping"
},
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
},
"VisType": {
"type": "string",
"title": "VisType is used to indicate how the data should be visualized in explore.",
"x-go-package": "github.com/grafana/grafana-plugin-sdk-go/data"
}
},
"responses": {
@@ -14073,12 +14349,6 @@
"$ref": "#/definitions/QueryDataResponse"
}
},
"queryDatasourceResponse": {
"description": "",
"schema": {
"$ref": "#/definitions/DataResponse"
}
},
"recordingRuleResponse": {
"description": "",
"schema": {