Files
grafana/docs/sources/developers/kinds/composable/grafanapyroscope/dataquery/schema-reference.md
Selene f06f812509 [v10.0.x] Chore: Hacky first pass on generating composable kinds within grafana/schema (#69904)
* Chore: Hacky first pass on generating composable kinds within grafana/schema (#64723)

* Super hacky first pass on gen types

* First sketchy pass at generated compo kinds in TS, grok-style

* Merge fix

* Create jenny for MajorsOrX for plugins

* Re-generate files with imports

* Delete invalid generated file

* Fix cue

* Update go.mod

* Update schemas

* Fix go-imports

* Regenerate cue files

---------

Co-authored-by: spinillos <selenepinillos@gmail.com>
(cherry picked from commit 09895c26b6)

# Conflicts:
#	go.mod
#	go.sum

* make gen-cue

---------

Co-authored-by: sam boyer <sdboyer@grafana.com>
2023-06-12 13:53:11 +03:00

5.7 KiB

keywords, title
keywords title
grafana
schema
GrafanaPyroscopeDataQuery kind

Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

GrafanaPyroscopeDataQuery

Maturity: experimental

Version: 0.0

It extends DataQuery.

Property Type Required Default Description
groupBy string[] Yes Allows to group the results.
labelSelector string Yes {} Specifies the query label selectors.
profileTypeId string Yes Specifies the type of profile to query.
refId string Yes (Inherited from DataQuery)
A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful.
datasource No (Inherited from DataQuery)
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
hide boolean No (Inherited from DataQuery)
true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc)
maxNodes integer No Sets the maximum number of nodes in the flamegraph.
queryType string No (Inherited from DataQuery)
Specify the query flavor
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 Default Description
refId string Yes A unique identifier for the query within the list of targets.
In server side expressions, the refId is used as a variable name to identify results.
By default, the UI will assign A->Z; however setting meaningful names may be useful.
datasource No 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
hide boolean No true if query is disabled (ie should not be returned to the dashboard)
Note this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc)
queryType string No Specify the query flavor
TODO make this required and give it a default