Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[influxdb] add documentation for verbatim setting. #32695

Closed
wants to merge 2 commits into from
Closed

[influxdb] add documentation for verbatim setting. #32695

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8883420
[influxdb] add documentation for `verbatim` setting.
planetmarshall May 12, 2024
dec18d1
[influxdb] add metadata to `verbatim` config
planetmarshall May 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions source/_integrations/influxdb.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,7 @@ queries_flux:
required: false
range_start:
type: string
description: "Duration or time value to start range from. All Flux queries require a `range` filter, one is automatically added to the beginning of your Flux query in the form of `range(start: {range_start}, stop: {range_stop})`."
description: "Duration or time value to start range from. All Flux queries require a `range` filter, one is automatically added to the beginning of your Flux query in the form of `range(start: {range_start}, stop: {range_stop})`, unless `verbatim` is specified."
required: false
default: -15m
range_stop:
Expand All @@ -476,7 +476,7 @@ queries_flux:
required: true
group_function:
type: string
description: "The group function to be used. If provided, this will add a filter to the end of your query like this `{group_function}(column: \"_value\")`. Note that unlike the 1.xx queries, this **does not** default to mean. You can omit if you wish to use your own aggregator, which takes additional/different parameters or want to act on a different column. If omitted, then a filter of `limit(n: 1)` will be added to the end instead to restrict to one result per table."
description: "The group function to be used. If provided, this will add a filter to the end of your query like this `{group_function}(column: \"_value\")`. Note that unlike the 1.xx queries, this **does not** default to mean. You can omit if you wish to use your own aggregator, which takes additional/different parameters or want to act on a different column. If omitted, then a filter of `limit(n: 1)` will be added to the end instead to restrict to one result per table, unless `verbatim` is specified."
required: false
value_template:
type: template
Expand All @@ -491,6 +491,11 @@ queries_flux:
type: [string, list]
description: Libraries to import in order to execute your query. Ex. `strings`, `date`, `experimental/query`, etc.
required: false
verbatim:
type: boolean
description: Send the query 'as is' to InfluxDB (templates will still be respected). `bucket`, `imports`, `range_start`, `range_stop`, and `group_function` will be ignored, these should be specified inline in the query. Allows the specification of queries that would otherwise be syntactically incorrect.
required: false
default: false
{% endconfiguration %}

## Examples
Expand Down