Skip to content

Commit 971d6c2

Browse files
authored
Merge pull request #689 from SumoLogic/zzhou-dashboard-query-fields-doc
SUMO-2097: Dashboard query schema documentation
2 parents d0b898b + d367a44 commit 971d6c2

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

website/docs/r/dashboard.html.markdown

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -370,6 +370,19 @@ for details.
370370
One of `Basic` or `Advanced`.
371371
- `metric_query_data` - (Optional) _Should only be specified for metric query_. Data format for the metric query. See
372372
[metric_query_data schema](#schema-for-metric_query_data) for details.
373+
- `parse_mode` - (Optional) This field only applies for queryType of `Logs` but other query types may be supported in the future.
374+
Define the parsing mode to scan the JSON format log messages. Possible values are:
375+
1. `Auto`
376+
2. `Manual`
377+
In AutoParse mode, the system automatically figures out fields to parse based on the search query.
378+
While in the Manual mode, no fields are parsed out automatically.
379+
For more information see [Dynamic Parsing](https://help.sumologic.com/?cid=0011).
380+
- `time_source` - This field only applies for queryType of `Logs` but other query types may be supported in the future.
381+
Define the time source of this query. Possible values are `Message` and `Receipt`.
382+
`Message` will use the timeStamp on the message, while `Receipt` will use the timestamp it was received
383+
by Sumo.
384+
- `transient` - (Optional) This field only applies for queryType of `Metrics` but other query types may be supported in the future. Determines if the row should be returned in the response. Can be used in conjunction with a join, if only the result of the join is needed, and not the intermediate rows. Setting `transient` to `true` wherever the intermediate results aren't required speeds up the computation and reduces the amount of data transferred over the network.
385+
- `output_cardinality_limit` - (Optional) This field only applies for queryType of `Metrics` but other query types may be supported in the future. Specifies the output cardinality limitations for the query, which is the maximum number of timeseries returned in the result.
373386

374387
### Schema for `metric_query_data`
375388
- `metric` - (Required) The metric of the query.

0 commit comments

Comments
 (0)