Модуль community.general.statsd – Отправка метрик в StatsD

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: community.general.statsd.

Впервые в community.general 2.1.0

Описание
Требования
Параметры
Атрибуты
Примеры

Описание

Модуль statsd отправляет метрики в StatsD.
Дополнительную информацию можно найти по адресу https://statsd-metrics.readthedocs.io/en/latest/.
Поддерживаемые типы метрик: counter и gauge. В настоящее время не поддерживаются типы метрик timer, set, и gaugedelta.

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.

statsd

Параметры

Параметр	Комментарии
delta boolean	Если метрика типа `gauge`, изменить значение на `delta`. Варианты: `false` ← (по умолчанию) `true`
host string	Хост StatsD (имя хоста или IP-адрес), в который будут отправлены метрики. По умолчанию: `"localhost"`
metric string / обязательно	Имя метрики.
metric_prefix string	Префикс, добавляемый к имени метрики. По умолчанию: `""`
metric_type string / обязательно	Тип метрики. Варианты: `"counter"` `"gauge"`
port integer	Порт на `host`, на котором StatsD прослушивает подключения. По умолчанию: `8125`
protocol string	Протокол транспорта для отправки метрик. Варианты: `"udp"` ← (по умолчанию) `"tcp"`
state string	Состояние проверки, только `present` имеет смысл. Варианты: `"present"` ← (по умолчанию)
timeout float	Таймаут отправителя, применимо только если `protocol` равен `tcp`. По умолчанию: `1.0`
value integer / обязательно	Значение метрики.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может работать в режиме `check_mode` и возвращать прогнозируемый результат изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: нет	Возвращает подробности о том, что изменилось (или, возможно, требует изменения в `check_mode`), когда используется режим diff.

Примеры

- name: Increment the metric my_counter by 1
  community.general.statsd:
    host: localhost
    port: 9125
    protocol: tcp
    metric: my_counter
    metric_type: counter
    value: 1

- name: Set the gauge my_gauge to 7
  community.general.statsd:
    host: localhost
    port: 9125
    protocol: tcp
    metric: my_gauge
    metric_type: gauge
    value: 7

Авторы

Mark Mercado (@mamercad)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/statsd_module.html