tickscript.defineCheck() function
The tickscript.defineCheck()
function is a user-contributed function maintained by
the package author and can
be updated or removed at any time.
The tickscript.defineCheck()
function creates and returns a record with custom check data required by
tickscript.alert()
and
tickscript.deadman()
.
This check data specifies information about the check in the InfluxDB monitoring system.
import "contrib/bonitoo-io/tickscript"
tickscript.defineCheck(
id: "000000000000",
name: "Example check name",
type: "custom"
)
Parameters
id
(Required) InfluxDB check ID.
Data type: String
name
(Required) InfluxDB check name.
Data type: String
type
InfluxDB check type.
Default is custom
.
Data type: String
Supported values:
- threshold
- deadman
- custom
Examples
Generate InfluxDB check data
import "contrib/bonitoo-io/tickscript"
tickscript.defineCheck(
id: "000000000000",
name: "Example check name",
)
// The function above returns: {
// _check_id: "000000000000",
// _check_name: "Example check name",
// _type: "custom",
// tags: {}
// }
Package author and maintainer
Github: @bonitoo-io, @alespour
InfluxDB Slack: @Ales Pour
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, the following resources are available:
InfluxDB Cloud and InfluxDB Enterprise customers can contact InfluxData Support.