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!


New in InfluxDB 3.6

Key enhancements in InfluxDB 3.6 and the InfluxDB 3 Explorer 1.4.

See the Blog Post

InfluxDB 3.6 is now available for both Core and Enterprise. This release introduces the 1.4 update to InfluxDB 3 Explorer, featuring the beta launch of Ask AI, along with new capabilities for simple startup and expanded functionality in the Processing Engine.

For more information, check out:

InfluxDB Docker latest tag changing to InfluxDB 3 Core

On February 3, 2026, the latest tag for InfluxDB Docker images will point to InfluxDB 3 Core. To avoid unexpected upgrades, use specific version tags in your Docker deployments.

If using Docker to install and run InfluxDB, the latest tag will point to InfluxDB 3 Core. To avoid unexpected upgrades, use specific version tags in your Docker deployments. For example, if using Docker to run InfluxDB v2, replace the latest version tag with a specific version tag in your Docker pull command–for example:

docker pull influxdb:2