mirror of https://github.com/grafana/grafana
Joey Tawadrous
3 years ago
committed by
GitHub
parent
f6d856f082
commit
121260e0dd
@ -0,0 +1,42 @@ |
||||
--- |
||||
keywords: |
||||
- grafana |
||||
- schema |
||||
title: ParcaDataQuery kind |
||||
--- |
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice. |
||||
|
||||
## ParcaDataQuery |
||||
|
||||
#### Maturity: experimental |
||||
#### Version: 0.0 |
||||
|
||||
|
||||
|
||||
It extends [DataQuery](#dataquery). |
||||
|
||||
| Property | Type | Required | Description | |
||||
|-----------------|---------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
||||
| `labelSelector` | string | **Yes** | Specifies the query label selectors. Default: `{}`. | |
||||
| `profileTypeId` | string | **Yes** | Specifies the type of profile to 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 | |
||||
| `hide` | boolean | No | *(Inherited from [DataQuery](#dataquery))*<br/>true if query is disabled (ie should not be returned to the dashboard) | |
||||
| `key` | string | No | *(Inherited from [DataQuery](#dataquery))*<br/>Unique, guid like, string used in explore mode | |
||||
| `queryType` | string | No | *(Inherited from [DataQuery](#dataquery))*<br/>Specify the query flavor<br/>TODO make this required and give it a default | |
||||
|
||||
### 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,50 @@ |
||||
// 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 ParcaQueryType.
|
||||
const ( |
||||
ParcaQueryTypeBoth ParcaQueryType = "both" |
||||
|
||||
ParcaQueryTypeMetrics ParcaQueryType = "metrics" |
||||
|
||||
ParcaQueryTypeProfile ParcaQueryType = "profile" |
||||
) |
||||
|
||||
// ParcaDataQuery defines model for ParcaDataQuery.
|
||||
type ParcaDataQuery 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"` |
||||
|
||||
// true if query is disabled (ie should not be returned to the dashboard)
|
||||
Hide *bool `json:"hide,omitempty"` |
||||
|
||||
// Unique, guid like, string used in explore mode
|
||||
Key *string `json:"key,omitempty"` |
||||
|
||||
// Specifies the query label selectors.
|
||||
LabelSelector string `json:"labelSelector"` |
||||
|
||||
// Specifies the type of profile to query.
|
||||
ProfileTypeId string `json:"profileTypeId"` |
||||
|
||||
// Specify the query flavor
|
||||
// TODO make this required and give it a default
|
||||
QueryType *string `json:"queryType,omitempty"` |
||||
|
||||
// A - Z
|
||||
RefId string `json:"refId"` |
||||
} |
||||
|
||||
// ParcaQueryType defines model for ParcaQueryType.
|
||||
type ParcaQueryType string |
||||
@ -0,0 +1,46 @@ |
||||
// 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: [ |
||||
// v0.0 |
||||
{ |
||||
common.DataQuery |
||||
|
||||
// Specifies the query label selectors. |
||||
labelSelector: string | *"{}" |
||||
// Specifies the type of profile to query. |
||||
profileTypeId: string |
||||
#ParcaQueryType: "metrics" | "profile" | *"both" @cuetsy(kind="type") |
||||
}, |
||||
] |
||||
}, |
||||
] |
||||
} |
||||
} |
||||
@ -0,0 +1,32 @@ |
||||
// 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 type ParcaQueryType = ('metrics' | 'profile' | 'both'); |
||||
|
||||
export const defaultParcaQueryType: ParcaQueryType = 'both'; |
||||
|
||||
export interface Parca extends common.DataQuery { |
||||
/** |
||||
* Specifies the query label selectors. |
||||
*/ |
||||
labelSelector: string; |
||||
/** |
||||
* Specifies the type of profile to query. |
||||
*/ |
||||
profileTypeId: string; |
||||
} |
||||
|
||||
export const defaultParca: Partial<Parca> = { |
||||
labelSelector: '{}', |
||||
}; |
||||
Loading…
Reference in new issue