The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
grafana/docs/sources/developers/kinds/composable/testdata/dataquery/schema-reference.md

20 KiB

keywords labels title
[grafana schema] [{products [cloud enterprise oss]}] TestDataDataQuery kind

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

TestDataDataQuery

Maturity: experimental

Version: 0.0

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.
alias string No
channel string No
csvContent string No
csvFileName string No
csvWave CSVWave[] No
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
dropPercent number No Drop percentage (the chance we will lose a point 0-100)
errorType string No Possible values are: server_panic, frontend_exception, frontend_observable.
flamegraphDiff boolean No
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)
labels string No
levelColumn boolean No
lines integer No
nodes NodesQuery No
points array[] No
pulseWave PulseWaveQuery No
queryType string No Specify the query flavor
TODO make this required and give it a default
rawFrameContent string No
scenarioId string No Possible values are: random_walk, slow_query, random_walk_with_error, random_walk_table, exponential_heatmap_bucket_data, linear_heatmap_bucket_data, no_data_points, datapoints_outside_range, csv_metric_values, predictable_pulse, predictable_csv_wave, streaming_client, simulation, usa, live, grafana_api, arrow, annotations, table_static, server_error_500, logs, node_graph, flame_graph, raw_frame, csv_file, csv_content, trace, manual_entry, variables-query.
seriesCount integer No
sim SimulationQuery No
spanCount integer No
stream StreamingQuery No
stringInput string No
usa USAQuery No

CSVWave

Property Type Required Default Description
labels string No
name string No
timeStep integer No
valuesCSV string No

NodesQuery

Property Type Required Default Description
count integer No
type string No Possible values are: random, response, random edges.

PulseWaveQuery

Property Type Required Default Description
offCount integer No
offValue number No
onCount integer No
onValue number No
timeStep integer No

SimulationQuery

Property Type Required Default Description
key object Yes
config object No
last boolean No
stream boolean No

Config

Property Type Required Default Description

Key

Property Type Required Default Description
tick number Yes
type string Yes
uid string No

StreamingQuery

Property Type Required Default Description
noise integer Yes
speed integer Yes
spread integer Yes
type string Yes Possible values are: signal, logs, fetch.
bands integer No
url string No

USAQuery

Property Type Required Default Description
fields string[] No
mode string No
period string No
states string[] No