mirror of https://github.com/grafana/grafana
loki: implement schema for loki query (#62114)
* loki: implement schema for loki query * removed forgotten code * better types * adjust cue-maturity-level Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com> * sync docs to schema change * removed forgotten go code * updated schema docs Co-authored-by: J Stickler <julie.stickler@grafana.com> * updated schema docs Co-authored-by: J Stickler <julie.stickler@grafana.com> * update schema docs Co-authored-by: J Stickler <julie.stickler@grafana.com> * update schema docs Co-authored-by: J Stickler <julie.stickler@grafana.com> * updated schema docs Co-authored-by: J Stickler <julie.stickler@grafana.com> * updated schema docs * add documentation to the resolution field * move direction-field to schema * loki: cue: moved deprecated fields to the bottom --------- Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com> Co-authored-by: J Stickler <julie.stickler@grafana.com>pull/62809/head
Gábor Farkas
2 years ago
committed by
GitHub
parent
753c84f825
commit
48a374f50b
@ -0,0 +1,47 @@ |
||||
--- |
||||
keywords: |
||||
- grafana |
||||
- schema |
||||
title: LokiDataQuery kind |
||||
--- |
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice. |
||||
|
||||
## LokiDataQuery |
||||
|
||||
#### Maturity: experimental |
||||
#### Version: 0.0 |
||||
|
||||
|
||||
|
||||
It extends [DataQuery](#dataquery). |
||||
|
||||
| Property | Type | Required | Description | |
||||
|----------------|---------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
||||
| `expr` | string | **Yes** | The LogQL query. | |
||||
| `refId` | string | **Yes** | *(Inherited from [DataQuery](#dataquery))*<br/>A - Z | |
||||
| `datasource` | | No | *(Inherited from [DataQuery](#dataquery))*<br/>For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef | null | |
||||
| `editorMode` | string | No | Possible values are: `code`, `builder`. | |
||||
| `hide` | boolean | No | *(Inherited from [DataQuery](#dataquery))*<br/>true if query is disabled (ie should not be returned to the dashboard) | |
||||
| `instant` | boolean | No | @deprecated, now use queryType. | |
||||
| `key` | string | No | *(Inherited from [DataQuery](#dataquery))*<br/>Unique, guid like, string used in explore mode | |
||||
| `legendFormat` | string | No | Used to override the name of the series. | |
||||
| `maxLines` | integer | No | Used to limit the number of log rows returned. | |
||||
| `queryType` | string | No | *(Inherited from [DataQuery](#dataquery))*<br/>Specify the query flavor<br/>TODO make this required and give it a default | |
||||
| `range` | boolean | No | @deprecated, now use queryType. | |
||||
| `resolution` | integer | No | Used to scale the interval value. | |
||||
|
||||
### DataQuery |
||||
|
||||
These are the common properties available to all queries in all datasources. |
||||
Specific implementations will *extend* this interface, adding the required |
||||
properties for the given context. |
||||
|
||||
| Property | Type | Required | Description | |
||||
|--------------|---------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
||||
| `refId` | string | **Yes** | A - Z | |
||||
| `datasource` | | No | For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef | null | |
||||
| `hide` | boolean | No | true if query is disabled (ie should not be returned to the dashboard) | |
||||
| `key` | string | No | Unique, guid like, string used in explore mode | |
||||
| `queryType` | string | No | Specify the query flavor<br/>TODO make this required and give it a default | |
||||
|
||||
|
||||
@ -0,0 +1,105 @@ |
||||
// Code generated - EDITING IS FUTILE. DO NOT EDIT.
|
||||
//
|
||||
// Generated by:
|
||||
// public/app/plugins/gen.go
|
||||
// Using jennies:
|
||||
// PluginGoTypesJenny
|
||||
//
|
||||
// Run 'make gen-cue' from repository root to regenerate.
|
||||
|
||||
package dataquery |
||||
|
||||
// Defines values for EditorMode.
|
||||
const ( |
||||
EditorModeBuilder EditorMode = "builder" |
||||
|
||||
EditorModeCode EditorMode = "code" |
||||
) |
||||
|
||||
// Defines values for LokiQueryDirection.
|
||||
const ( |
||||
LokiQueryDirectionBackward LokiQueryDirection = "backward" |
||||
|
||||
LokiQueryDirectionForward LokiQueryDirection = "forward" |
||||
) |
||||
|
||||
// Defines values for LokiQueryType.
|
||||
const ( |
||||
LokiQueryTypeInstant LokiQueryType = "instant" |
||||
|
||||
LokiQueryTypeRange LokiQueryType = "range" |
||||
|
||||
LokiQueryTypeStream LokiQueryType = "stream" |
||||
) |
||||
|
||||
// Defines values for QueryEditorMode.
|
||||
const ( |
||||
QueryEditorModeBuilder QueryEditorMode = "builder" |
||||
|
||||
QueryEditorModeCode QueryEditorMode = "code" |
||||
) |
||||
|
||||
// Defines values for SupportingQueryType.
|
||||
const ( |
||||
SupportingQueryTypeDataSample SupportingQueryType = "dataSample" |
||||
|
||||
SupportingQueryTypeLogsSample SupportingQueryType = "logsSample" |
||||
|
||||
SupportingQueryTypeLogsVolume SupportingQueryType = "logsVolume" |
||||
) |
||||
|
||||
// LokiDataQuery defines model for LokiDataQuery.
|
||||
type LokiDataQuery struct { |
||||
// For mixed data sources the selected datasource is on the query level.
|
||||
// For non mixed scenarios this is undefined.
|
||||
// TODO find a better way to do this ^ that's friendly to schema
|
||||
// TODO this shouldn't be unknown but DataSourceRef | null
|
||||
Datasource *interface{} `json:"datasource,omitempty"` |
||||
EditorMode *EditorMode `json:"editorMode,omitempty"` |
||||
|
||||
// The LogQL query.
|
||||
Expr string `json:"expr"` |
||||
|
||||
// true if query is disabled (ie should not be returned to the dashboard)
|
||||
Hide *bool `json:"hide,omitempty"` |
||||
|
||||
// @deprecated, now use queryType.
|
||||
Instant *bool `json:"instant,omitempty"` |
||||
|
||||
// Unique, guid like, string used in explore mode
|
||||
Key *string `json:"key,omitempty"` |
||||
|
||||
// Used to override the name of the series.
|
||||
LegendFormat *string `json:"legendFormat,omitempty"` |
||||
|
||||
// Used to limit the number of log rows returned.
|
||||
MaxLines *int64 `json:"maxLines,omitempty"` |
||||
|
||||
// Specify the query flavor
|
||||
// TODO make this required and give it a default
|
||||
QueryType *string `json:"queryType,omitempty"` |
||||
|
||||
// @deprecated, now use queryType.
|
||||
Range *bool `json:"range,omitempty"` |
||||
|
||||
// A - Z
|
||||
RefId string `json:"refId"` |
||||
|
||||
// Used to scale the interval value.
|
||||
Resolution *int64 `json:"resolution,omitempty"` |
||||
} |
||||
|
||||
// EditorMode defines model for LokiDataQuery.EditorMode.
|
||||
type EditorMode string |
||||
|
||||
// LokiQueryDirection defines model for LokiQueryDirection.
|
||||
type LokiQueryDirection string |
||||
|
||||
// LokiQueryType defines model for LokiQueryType.
|
||||
type LokiQueryType string |
||||
|
||||
// QueryEditorMode defines model for QueryEditorMode.
|
||||
type QueryEditorMode string |
||||
|
||||
// SupportingQueryType defines model for SupportingQueryType.
|
||||
type SupportingQueryType string |
||||
@ -0,0 +1,61 @@ |
||||
// Copyright 2023 Grafana Labs |
||||
// |
||||
// Licensed under the Apache License, Version 2.0 (the "License"); |
||||
// you may not use this file except in compliance with the License. |
||||
// You may obtain a copy of the License at |
||||
// |
||||
// http://www.apache.org/licenses/LICENSE-2.0 |
||||
// |
||||
// Unless required by applicable law or agreed to in writing, software |
||||
// distributed under the License is distributed on an "AS IS" BASIS, |
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
// See the License for the specific language governing permissions and |
||||
// limitations under the License. |
||||
|
||||
package grafanaplugin |
||||
|
||||
import ( |
||||
"github.com/grafana/grafana/packages/grafana-schema/src/common" |
||||
"github.com/grafana/grafana/pkg/plugins/pfs" |
||||
) |
||||
|
||||
// This file (with its sibling .cue files) implements pfs.GrafanaPlugin |
||||
pfs.GrafanaPlugin |
||||
|
||||
composableKinds: DataQuery: { |
||||
maturity: "experimental" |
||||
|
||||
lineage: { |
||||
seqs: [ |
||||
{ |
||||
schemas: [ |
||||
{ |
||||
common.DataQuery |
||||
|
||||
// The LogQL query. |
||||
expr: string |
||||
// Used to override the name of the series. |
||||
legendFormat?: string |
||||
// Used to limit the number of log rows returned. |
||||
maxLines?: int64 |
||||
// Used to scale the interval value. |
||||
resolution?: int64 |
||||
editorMode?: #QueryEditorMode |
||||
// @deprecated, now use queryType. |
||||
range?: bool |
||||
// @deprecated, now use queryType. |
||||
instant?: bool |
||||
|
||||
#QueryEditorMode: "code" | "builder" @cuetsy(kind="enum") |
||||
|
||||
#LokiQueryType: "range" | "instant" | "stream" @cuetsy(kind="enum") |
||||
|
||||
#SupportingQueryType: "logsVolume" | "logsSample" | "dataSample" @cuetsy(kind="enum") |
||||
|
||||
#LokiQueryDirection: "forward" | "backward" @cuetsy(kind="enum") |
||||
}, |
||||
] |
||||
}, |
||||
] |
||||
} |
||||
} |
||||
@ -0,0 +1,63 @@ |
||||
// Code generated - EDITING IS FUTILE. DO NOT EDIT.
|
||||
//
|
||||
// Generated by:
|
||||
// public/app/plugins/gen.go
|
||||
// Using jennies:
|
||||
// TSTypesJenny
|
||||
// PluginTSTypesJenny
|
||||
//
|
||||
// Run 'make gen-cue' from repository root to regenerate.
|
||||
|
||||
import * as common from '@grafana/schema'; |
||||
|
||||
export const DataQueryModelVersion = Object.freeze([0, 0]); |
||||
|
||||
export enum QueryEditorMode { |
||||
Builder = 'builder', |
||||
Code = 'code', |
||||
} |
||||
|
||||
export enum LokiQueryType { |
||||
Instant = 'instant', |
||||
Range = 'range', |
||||
Stream = 'stream', |
||||
} |
||||
|
||||
export enum SupportingQueryType { |
||||
DataSample = 'dataSample', |
||||
LogsSample = 'logsSample', |
||||
LogsVolume = 'logsVolume', |
||||
} |
||||
|
||||
export enum LokiQueryDirection { |
||||
Backward = 'backward', |
||||
Forward = 'forward', |
||||
} |
||||
|
||||
export interface Loki extends common.DataQuery { |
||||
editorMode?: QueryEditorMode; |
||||
/** |
||||
* The LogQL query. |
||||
*/ |
||||
expr: string; |
||||
/** |
||||
* @deprecated, now use queryType. |
||||
*/ |
||||
instant?: boolean; |
||||
/** |
||||
* Used to override the name of the series. |
||||
*/ |
||||
legendFormat?: string; |
||||
/** |
||||
* Used to limit the number of log rows returned. |
||||
*/ |
||||
maxLines?: number; |
||||
/** |
||||
* @deprecated, now use queryType. |
||||
*/ |
||||
range?: boolean; |
||||
/** |
||||
* Used to scale the interval value. |
||||
*/ |
||||
resolution?: number; |
||||
} |
||||
Loading…
Reference in new issue