salt.modules.kapacitor module

Kapacitor execution module.

configuration:

This module accepts connection configuration details either as parameters or as configuration settings in /etc/salt/minion on the relevant minions:

kapacitor.host: 'localhost'
kapacitor.port: 9092

This data can also be passed into pillar. Options passed into opts will overwrite options passed into pillar.

New in version 2016.11.0.

salt.modules.kapacitor.define_task(name, tick_script, task_type=u'stream', database=None, retention_policy=u'default')

Define a task. Serves as both create/update.

name
Name of the task.
tick_script
Path to the TICK script for the task. Can be a salt:// source.
task_type
Task type. Defaults to 'stream'
database
Which database to fetch data from. Defaults to None, which will use the default database in InfluxDB.
retention_policy
Which retention policy to fetch data from. Defaults to 'default'.

CLI Example:

salt '*' kapacitor.define_task cpu salt://kapacitor/cpu.tick database=telegraf
salt.modules.kapacitor.delete_task(name)

Delete a kapacitor task.

name
Name of the task to delete.

CLI Example:

salt '*' kapacitor.delete_task cpu
salt.modules.kapacitor.disable_task(name)

Disable a kapacitor task.

name
Name of the task to disable.

CLI Example:

salt '*' kapacitor.disable_task cpu
salt.modules.kapacitor.enable_task(name)

Enable a kapacitor task.

name
Name of the task to enable.

CLI Example:

salt '*' kapacitor.enable_task cpu
salt.modules.kapacitor.get_task(name)

Get a dict of data on a task.

name
Name of the task to get information about.

CLI Example:

salt '*' kapacitor.get_task cpu
salt.modules.kapacitor.version(*args, **kwargs)

Get the kapacitor version.