Documentation

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


Cloud or OSS?

InfluxDB OSS 2.0 now generally available!

InfluxDB OSS 2.0 is now generally available and ready for production use. See the InfluxDB OSS 2.0 release notes.

For information about upgrading to InfluxDB OSS 2.0, see: