From 440fafd813e65d29f5ee15d0610e95be900ded1a Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Tue, 15 Dec 2020 11:37:42 -0700 Subject: [PATCH 1/2] updated description of monitor.check data --- .../cloud/reference/flux/stdlib/monitor/check.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/content/influxdb/cloud/reference/flux/stdlib/monitor/check.md b/content/influxdb/cloud/reference/flux/stdlib/monitor/check.md index 4dd932c14..4402eba48 100644 --- a/content/influxdb/cloud/reference/flux/stdlib/monitor/check.md +++ b/content/influxdb/cloud/reference/flux/stdlib/monitor/check.md @@ -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.** +Meta data 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 From 0be93ee4cdf404a1a3fce6ae6109d19ef093ad32 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Tue, 15 Dec 2020 11:41:01 -0700 Subject: [PATCH 2/2] fixed typo in monitor.check --- content/influxdb/cloud/reference/flux/stdlib/monitor/check.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/influxdb/cloud/reference/flux/stdlib/monitor/check.md b/content/influxdb/cloud/reference/flux/stdlib/monitor/check.md index 4402eba48..c8874bc8e 100644 --- a/content/influxdb/cloud/reference/flux/stdlib/monitor/check.md +++ b/content/influxdb/cloud/reference/flux/stdlib/monitor/check.md @@ -66,7 +66,7 @@ The message is stored in the `_message` column. _**Data type:** Function_ ### data -Meta data used to identify this check and append tags to each row. +Metadata used to identify this check and append tags to each row. _**Data type:** Record_