Documentation

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.

Parameters

id

(Required) InfluxDB check ID.

name

(Required) InfluxDB check name.

type

InfluxDB check type. Default is custom.

Valid values:

  • threshold -deadman -custom

Examples

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!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more