sensu.sensu_go.check – Manage Sensu checks¶
Note
This plugin is part of the sensu.sensu_go collection (version 1.9.4).
To install it use: ansible-galaxy collection install sensu.sensu_go
.
To use it in a playbook, specify: sensu.sensu_go.check
.
New in version 1.0.0: of sensu.sensu_go
Synopsis¶
Create, update or delete Sensu Go check.
For more information, refer to the Sensu Go documentation at https://docs.sensu.io/sensu-go/latest/reference/checks/.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.7
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
annotations
dictionary
|
Custom metadata fields with fewer restrictions, as key/value pairs.
These are preserved by Sensu but not accessible as tokens or identifiers, and are mainly intended for use with external tools.
|
||
auth
dictionary
|
Authentication parameters. Can define each of them with ENV as well.
|
||
api_key
string
added in 1.3.0 of sensu.sensu_go
|
The API key that should be used when authenticating. If this is not set, the value of the SENSU_API_KEY environment variable will be checked.
This replaces auth.user and auth.password parameters.
For more information about the API key, refer to the official Sensu documentation at https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.
|
||
ca_path
path
added in 1.5.0 of sensu.sensu_go
|
Path to the CA bundle that should be used to validate the backend certificate.
If this parameter is not set, module will use the CA bundle that python is using.
It is also possible to set this parameter via the SENSU_CA_PATH environment variable.
|
||
password
string
|
Default: "P@ssw0rd!"
|
The Sensu user's password. If this is not set the value of the SENSU_PASSWORD environment variable will be checked.
This parameter is ignored if the auth.api_key parameter is set.
|
|
url
string
|
Default: "http://localhost:8080"
|
Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked.
|
|
user
string
|
Default: "admin"
|
The username to use for connecting to the Sensu API. If this is not set the value of the SENSU_USER environment variable will be checked.
This parameter is ignored if the auth.api_key parameter is set.
|
|
verify
boolean
added in 1.5.0 of sensu.sensu_go
|
|
Flag that controls the certificate validation.
If you are using self-signed certificates, you can set this parameter to
false .ONLY USE THIS PARAMETER IN DEVELOPMENT SCENARIOS! In you use self-signed certificates in production, see the auth.ca_path parameter.
It is also possible to set this parameter via the SENSU_VERIFY environment variable.
|
|
check_hooks
dictionary
|
A mapping of response codes to hooks which will be run by the agent when that code is returned.
Note that the structure of this parameter is a bit different from the one described at https://docs.sensu.io/sensu-go/latest/reference/checks/#check-hooks-attribute.
See check hooks example below for more information on exact mapping structure.
|
||
command
string
|
Check command to run.
Required if state is
present . |
||
cron
string
|
Schedule check requests using crontab syntax.
Cannot be used when interval option is used.
|
||
env_vars
dictionary
|
A mapping of environment variable names and values to use with command execution.
|
||
handlers
list
/ elements=string
|
List of handlers which receive check results.
|
||
high_flap_threshold
integer
|
High flap threshold.
|
||
interval
integer
|
Check request interval.
Cannot be used when cron option is used.
|
||
labels
dictionary
|
Custom metadata fields that can be accessed within Sensu, as key/value pairs.
|
||
low_flap_threshold
integer
|
Low flap threshold.
|
||
name
string
/ required
|
The Sensu resource's name. This name (in combination with the namespace where applicable) uniquely identifies the resource that Ansible operates on.
If the resource with selected name already exists, Ansible module will update it to match the specification in the task.
Consult the name metadata attribute specification in the upstream docs on https://docs.sensu.io/sensu-go/latest/reference/ for more details about valid names and other restrictions.
|
||
namespace
string
|
Default: "default"
|
RBAC namespace to operate in. If this is not set the value of the SENSU_NAMESPACE environment variable will be used.
|
|
output_metric_format
string
|
|
Enable parsing of metrics in the specified format from this check's output.
|
|
output_metric_handlers
list
/ elements=string
|
List of handlers which receive check results. I'm not sure why this exists.
|
||
proxy_entity_name
string
|
Entity name to associate this check with instead of the agent it ran on.
|
||
proxy_requests
dictionary
|
Allows you to assign the check to run for multiple entities according to their entity_attributes.
|
||
entity_attributes
list
/ elements=string
|
List of attribute checks for determining which proxy entities this check should be scheduled against.
|
||
splay
boolean
|
|
Enables or disables splaying of check request scheduling.
|
|
splay_coverage
integer
|
Percentage of the
interval over which to splay checks. |
||
publish
boolean
|
|
Enables or disables scheduled publication of check requests.
|
|
round_robin
boolean
|
|
An array of environment variables to use with command execution.
|
|
runtime_assets
list
/ elements=string
|
List of runtime assets required to run the check.
|
||
secrets
list
/ elements=dictionary
added in 1.6.0 of sensu.sensu_go
|
List of secrets that are available to the command.
|
||
name
string
/ required
added in 1.6.0 of sensu.sensu_go
|
Variable name that will contain the sensitive data.
|
||
secret
string
/ required
added in 1.6.0 of sensu.sensu_go
|
Name of the secret that contains sensitive data.
|
||
state
string
|
|
Target state of the Sensu object.
|
|
stdin
boolean
|
|
Enables writing of serialized JSON data to the check command's stdin.
Only usable with checks written specifically for Sensu Go.
|
|
subscriptions
list
/ elements=string
|
List of subscriptions which receive check requests.
Required if state is
present . |
||
timeout
integer
|
Check execution timeout.
|
||
ttl
integer
|
Amount of time after which a check result is considered stale.
|
See Also¶
See also
- sensu.sensu_go.check_info
The official documentation on the sensu.sensu_go.check_info module.
Examples¶
- name: Check executing command every 30 seconds
sensu.sensu_go.check:
name: check
command: check-cpu.sh -w 75 -c 90
subscriptions:
- checks
interval: 30
publish: yes
- name: Check executing command with cron scheduler
sensu.sensu_go.check:
name: check
command: check-cpu.sh -w 75 -c 90
subscriptions:
- systems
handlers:
- slack
cron: "* * * * *"
publish: yes
- name: Ad-hoc scheduling
sensu.sensu_go.check:
name: check
command: check-cpu.sh -w 75 -c 90
subscriptions:
- systems
handlers:
- slack
interval: 60
publish: no
- name: Report events under proxy entity name instead of agent entity
sensu.sensu_go.check:
name: check
command: http_check.sh https://sensu.io
subscriptions:
- proxy
handlers:
- slack
interval: 60
proxy_entity_name: sensu-site
round_robin: yes
publish: yes
- name: Event that triggers hooks
sensu.sensu_go.check:
name: check
command: http_check.sh https://sensu.io
subscriptions: [ proxy ]
# The upstream JSON payload for the hooks below would look like this:
#
# "check_hooks": [
# {"0": ["passing-hook", "always-run-this-hook"]},
# {"critical": ["failing-hook", "always-run-this-hook"]}
# ]
#
# Ansible task simplifies this structure into a simple mapping:
check_hooks:
"0":
- passing-hook
- always-run-this-hook
critical:
- failing-hook
- always-run-this-hook
- name: Remove check
sensu.sensu_go.check:
name: my-check
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Paul Arthur (@flowerysong)
Aljaz Kosir (@aljazkosir)
Miha Plesko (@miha-plesko)
Tadej Borovsak (@tadeboro)