Menu
Grafana Cloud Enterprise Open source

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

TestDataDataQuery

Maturity: experimental

Version: 0.0

PropertyTypeRequiredDefaultDescription
refIdstringYesA 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.
aliasstringNo
channelstringNo
csvContentstringNo
csvFileNamestringNo
csvWaveCSVWave[]No
datasourceNoFor 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
dropPercentnumberNoDrop percentage (the chance we will lose a point 0-100)
errorTypestringNoPossible values are: server_panic, frontend_exception, frontend_observable.
flamegraphDiffbooleanNo
hidebooleanNotrue 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)
labelsstringNo
levelColumnbooleanNo
linesintegerNo
nodesNodesQueryNo
pointsarray[]No
pulseWavePulseWaveQueryNo
queryTypestringNoSpecify the query flavor
TODO make this required and give it a default
rawFrameContentstringNo
scenarioIdstringNoPossible 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.
seriesCountintegerNo
simSimulationQueryNo
spanCountintegerNo
streamStreamingQueryNo
stringInputstringNo
usaUSAQueryNo

CSVWave

PropertyTypeRequiredDefaultDescription
labelsstringNo
namestringNo
timeStepintegerNo
valuesCSVstringNo

NodesQuery

PropertyTypeRequiredDefaultDescription
countintegerNo
seedintegerNo
typestringNoPossible values are: random, response_small, response_medium, random edges.

PulseWaveQuery

PropertyTypeRequiredDefaultDescription
offCountintegerNo
offValuenumberNo
onCountintegerNo
onValuenumberNo
timeStepintegerNo

SimulationQuery

PropertyTypeRequiredDefaultDescription
keyobjectYes
configobjectNo
lastbooleanNo
streambooleanNo

Config

PropertyTypeRequiredDefaultDescription

Key

PropertyTypeRequiredDefaultDescription
ticknumberYes
typestringYes
uidstringNo

StreamingQuery

PropertyTypeRequiredDefaultDescription
noiseintegerYes
speedintegerYes
spreadintegerYes
typestringYesPossible values are: signal, logs, fetch, traces.
bandsintegerNo
urlstringNo

USAQuery

PropertyTypeRequiredDefaultDescription
fieldsstring[]No
modestringNo
periodstringNo
statesstring[]No