docs-v2/content/flux/v0/stdlib/contrib/bonitoo-io/tickscript/definecheck.md

title	description	menu	weight
tickscript.defineCheck() function	`tickscript.defineCheck()` creates custom check data required by `alert()` and `deadman()`.	flux_v0_ref name parent identifier tickscript.defineCheck contrib/bonitoo-io/tickscript contrib/bonitoo-io/tickscript/defineCheck	301

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}

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

id

({{< req >}}) InfluxDB check ID.

name

({{< req >}}) 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: {}
// }