opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-28 14:52:36 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/developers/kinds/composable/prometheus/dataquery/schema-reference.md
sam boyer 09895c26b6 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>
2023-05-30 05:56:18 -07:00

4.4 KiB
Raw Blame History

keywords title
grafana
schema
PrometheusDataQuery kind

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

PrometheusDataQuery

Maturity: experimental

Version: 0.0

Property Type Required Default Description
expr string Yes The actual expression/query that will be evaluated by Prometheus
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
editorMode string No Possible values are: code, builder.
exemplar boolean No Execute an additional query to identify interesting raw samples relevant for the given expr
format string No Possible values are: time_series, table, heatmap.
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)
instant boolean No Returns only the latest value that Prometheus has scraped for the requested time series
intervalFactor number No @deprecated Used to specify how many times to divide max data points by. We use max data points under query options
See https://github.com/grafana/grafana/issues/48081
legendFormat string No Series name override or template. Ex. {{hostname}} will be replaced with label value for hostname
queryType string No Specify the query flavor
TODO make this required and give it a default
range boolean No Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series