community.general.sensu_check module – Manage Sensu checks
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.sensu_check
.
Synopsis
Manage the checks that should be run on a machine by Sensu.
Most options do not have a default and will not be added to the check definition unless specified.
All defaults except
path
,state
,backup
andmetric
are not managed by this module,they are simply specified for your convenience.
Aliases: monitoring.sensu.sensu_check
Parameters
Parameter |
Comments |
---|---|
Classifies the check as an aggregate check, making it available via the aggregate API Default is Choices:
|
|
Create a backup file (if yes), including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. Choices:
|
|
Path to the sensu check to run (not required when |
|
A hash/dictionary of custom parameters for mixing to the configuration. You can’t rewrite others module parameters using this |
|
Other checks this check depends on, if dependencies fail handling of this check will be disabled |
|
Whether the check should be handled or not Default is Choices:
|
|
List of handlers to notify when the check fails |
|
The high threshold for flap detection |
|
Check interval in seconds |
|
The low threshold for flap detection |
|
Whether the check is a metric Choices:
|
|
The name of the check This is the key that is used to determine whether a check exists |
|
Number of event occurrences before the handler should take action If not specified, defaults to 1. |
|
Path to the json file of the check to be added/removed. Will be created if it does not exist (unless The parent folders need to exist when Default: |
|
Whether the check should be scheduled at all. You can still issue it via the sensu api Default is Choices:
|
|
Number of seconds handlers should wait before taking second action |
|
The check source, used to create a JIT Sensu client for an external resource (e.g. a network switch). |
|
Whether the check should be scheduled by the sensu client or server This option obviates the need for specifying the Default is Choices:
|
|
Whether the check should be present or not Choices:
|
|
When to disable handling of check failures |
|
When to enable handling of check failures |
|
List of subscribers/channels this check should run for See sensu_subscribers to subscribe a machine to a channel |
|
Timeout for the check If not specified, it defaults to 10. |
|
Time to live in seconds until the check is considered stale |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
# Fetch metrics about the CPU load every 60 seconds,
# the sensu server has a handler called 'relay' which forwards stats to graphite
- name: Get cpu metrics
community.general.sensu_check:
name: cpu_load
command: /etc/sensu/plugins/system/cpu-mpstat-metrics.rb
metric: true
handlers: relay
subscribers: common
interval: 60
# Check whether nginx is running
- name: Check nginx process
community.general.sensu_check:
name: nginx_running
command: /etc/sensu/plugins/processes/check-procs.rb -f /var/run/nginx.pid
handlers: default
subscribers: nginx
interval: 60
# Stop monitoring the disk capacity.
# Note that the check will still show up in the sensu dashboard,
# to remove it completely you need to issue a DELETE request to the sensu api.
- name: Check disk
community.general.sensu_check:
name: check_disk_capacity
state: absent