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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или о том, что может потребоваться изменить в `check_mode`).

Примеры

- 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/statsd_module.html