Menu
Grafana Cloud
Enterprise
Open source
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 | |
scope | object | No |
Scope
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
matchers | string | Yes |
Was this page helpful?
Related resources from Grafana Labs
Getting started with the Grafana LGTM Stack
In this webinar, we’ll demo how to get started using the LGTM Stack: Loki for logs, Grafana for visualization, Tempo for traces, and Mimir for metrics.
Getting started with Grafana dashboard design
In this webinar, you'll learn how to design stylish and easily accessible Grafana dashboards that tell a story.
Building advanced Grafana dashboards
In this webinar, we’ll demo how to build and format Grafana dashboards.