Merge pull request #1989 from influxdata/flux-check-data

Updated description of monitor.check data
pull/1994/head
Scott Anderson 2020-12-15 11:42:33 -07:00 committed by GitHub
commit ae89bd4fe5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 3 deletions

View File

@ -66,12 +66,22 @@ The message is stored in the `_message` column.
_**Data type:** Function_
### data
Meta data used to identify this check.
**InfluxDB populates check data.**
Metadata used to identify this check and append tags to each row.
_**Data type:** Record_
The data record should contain the following fields:
- **_check_id**: check ID
- **_check_name**: check name
- **_type**: check type (threshold, deadman, or custom)
- **tags**: tags to append to each checked record (for example: `{foo: "bar", baz: "quz"}`)
The InfluxDB monitoring and alerting system uses `monitor.check()` to store information
about checks and automatically assigns the `_check_id` and `_check_name` values.
If writing a custom check task, we recommend using **unique arbitrary** values
for `_check_id` and `_check_name`.
## Examples
### Monitor disk usage