tickscript.defineCheck() function

tickscript.defineCheck() is a user-contributed function maintained by the package author.

tickscript.defineCheck() creates custom check data required by alert() and deadman().

Function type signature
(id: A, name: B, ?type: C) => {tags: {}, _type: C, _check_name: B, _check_id: A}
For more information, see Function type signatures.



(Required) InfluxDB check ID.


(Required) InfluxDB check name.


InfluxDB check type. Default is custom.

Valid values:

  • threshold -deadman -custom


Generate InfluxDB check data

import "contrib/bonitoo-io/tickscript"

tickscript.defineCheck(id: "000000000000", name: "Example check name")// Returns:
// {
//     _check_id: 000000000000,
//     _check_name: Example check name,
//     _type: custom,
//     tags: {}
// }

Was this page helpful?

Thank you for your feedback!

Introducing InfluxDB 3.0

The new core of InfluxDB built with Rust and Apache Arrow. Available today in InfluxDB Cloud Dedicated.

Learn more

State of the InfluxDB Cloud Serverless documentation

The new documentation for InfluxDB Cloud Serverless is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.