community.general.sensu_check 模块 – 管理 Sensu 检查

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定：community.general.sensu_check。

概要

  • 管理应该由 *Sensu* 在机器上运行的检查。

  • 大多数选项没有默认值，除非指定，否则不会添加到检查定义中。

  • 除了 path、state、backup 和 metric 之外的所有默认值都不由此模块管理，

  • 它们只是为了方便您而指定。

参数

参数

注释

aggregate

布尔值

将检查分类为聚合检查，

使其可通过聚合 API 获得

默认值为 false。

选项

  • false

  • true

backup

布尔值

创建一个备份文件（如果为 yes），包括时间戳信息，以便

如果以某种方式错误地损坏了它，您可以恢复原始文件。

选项

  • false ← （默认）

  • true

command

字符串

要运行的 sensu 检查的路径（当 state=absent 时不需要）

custom

字典

用于混合到配置中的自定义参数的哈希/字典。

您不能使用此参数重写其他模块参数

dependencies

列表 / 元素=字符串

此检查依赖的其他检查，如果依赖项失败，将禁用对此检查的处理

handle

布尔值

是否应该处理此检查

默认值为 false。

选项

  • false

  • true

handlers

列表 / 元素=字符串

检查失败时要通知的处理程序列表

high_flap_threshold

整数

抖动检测的高阈值

interval

整数

检查间隔（秒）

low_flap_threshold

整数

抖动检测的低阈值

metric

布尔值

此检查是否为指标

选项

  • false ← （默认）

  • true

name

字符串 / 必需

检查的名称

这是用于确定检查是否存在的键

occurrences

整数

处理程序应采取操作之前的事件发生次数

如果未指定，则默认为 1。

path

字符串

要添加/删除的检查的 json 文件路径。

如果它不存在（除非 state=absent），则将创建它。

当 state=present 时，父文件夹需要存在，否则将抛出错误

默认值： "/etc/sensu/conf.d/checks.json"

publish

布尔值

是否应该安排此检查。

您仍然可以通过 sensu api 发出它

默认值为 false。

选项

  • false

  • true

refresh

整数

处理程序在采取第二次操作之前应等待的秒数

source

字符串

检查源，用于为外部资源（例如，网络交换机）创建 JIT Sensu 客户端。

standalone

布尔值

是否应由 sensu 客户端或服务器安排此检查

此选项消除了指定 subscribers 选项的需要

默认值为 false。

选项

  • false

  • true

state

字符串

检查是否应该存在

选项

  • "present" ← （默认）

  • "缺席"

subdue_begin

字符串

何时禁用检查失败的处理

subdue_end

字符串

何时启用检查失败的处理

订阅者

列表 / 元素=字符串

此检查应该运行的订阅者/通道列表

请参阅 sensu_subscribers 将机器订阅到通道

超时

整数

检查的超时时间

如果未指定，则默认为 10。

ttl

整数

检查被认为是过时的存活时间（以秒为单位）

属性

属性

支持

描述

check_mode

支持: 完全

可以在 check_mode 中运行并返回更改状态预测，而无需修改目标。

diff_mode

支持: 无

在 diff 模式下，将返回有关已更改的内容（或可能需要在 check_mode 中更改的内容）的详细信息。

示例

# 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

作者

  • Anders Ingemann (@andsens)