Spec-Zone.ru › Ansible

Обратный вызов community.grafana.grafana_annotations — отправка событий Ansible в Grafana в виде аннотаций на графиках через HTTP API.

Примечание

Этот плагин обратного вызова входит в коллекцию community.grafana (версия 2.3.0).

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

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

Чтобы использовать его в плейбуке, укажите: community.grafana.grafana_annotations.

  • Плагин обратного вызова
  • Краткое описание
  • Требования
  • Параметры

Плагин обратного вызова

Этот плагин является плагином обратного вызова для уведомлений. Он отправляет информацию о запуске плейбука в другие приложения, службы или системы. Дополнительные сведения о плагинах обратного вызова см. в разделе Плагины обратного вызова.

Краткое описание

  • Этот плагин сообщает о событиях запуска, сбоя и статистики в Grafana в виде аннотаций (https://grafana.com)

Требования

Следующие требования необходимы на локальном управляющем узле, который выполняет этот плагин обратного вызова.

  • добавление в белый список в конфигурации

Параметры

Параметр

Комментарии

grafana_api_key

string

Ключ API Grafana, используемый для аутентификации при отправке запросов через HTTP API. Если он не указан, потребуются grafana_login и grafana_password.

Конфигурация:

  • Запись INI:

    [callback_grafana_annotations]
    grafana_api_key = VALUE
    
  • Переменная окружения: GRAFANA_API_KEY

grafana_dashboard_id

integer

Идентификатор панели мониторинга Grafana, на которой нужно создать аннотацию.

Конфигурация:

  • Запись INI:

    [callback_grafana_annotations]
    grafana_dashboard_id = VALUE
    
  • Переменная окружения: GRAFANA_DASHBOARD_ID

grafana_panel_ids

list / elements=integer

Идентификаторы панелей Grafana, на которых нужно создать аннотацию. Укажите одно целое число или разделённый запятыми список целых чисел.

По умолчанию: []

Конфигурация:

  • Запись INI:

    [callback_grafana_annotations]
    grafana_panel_ids =
    
  • Переменная окружения: GRAFANA_PANEL_IDS

grafana_password

string

Пароль Grafana, используемый для аутентификации. Игнорируется, если указан grafana_api_key.

По умолчанию: "ansible"

Конфигурация:

  • Запись INI:

    [callback_grafana_annotations]
    grafana_password = ansible
    
  • Переменная окружения: GRAFANA_PASSWORD

grafana_url

string / обязательный

URL API аннотаций Grafana

Конфигурация:

  • Запись INI:

    [callback_grafana_annotations]
    grafana_url = VALUE
    
  • Переменная окружения: GRAFANA_URL

grafana_user

string

Пользователь Grafana, используемый для аутентификации. Игнорируется, если указан grafana_api_key.

По умолчанию: "ansible"

Конфигурация:

  • Запись INI:

    [callback_grafana_annotations]
    grafana_user = ansible
    
  • Переменная окружения: GRAFANA_USER

http_agent

string

Значение HTTP-заголовка «User-Agent», указываемое в HTTP-запросах.

По умолчанию: "Ansible (grafana_annotations callback)"

Конфигурация:

  • Запись INI:

    [callback_grafana_annotations]
    http_agent = Ansible (grafana_annotations callback)
    
  • Переменная окружения: HTTP_AGENT

validate_certs

псевдонимы: validate_grafana_certs

boolean

Проверять SSL-сертификат сервера Grafana (для URL HTTPS).

Варианты:

  • false
  • true ← (по умолчанию)

Конфигурация:

  • Записи INI:

    [callback_grafana_annotations]
    validate_grafana_certs = true
    
    [callback_grafana_annotations]
    validate_certs = true
    
  • Переменная окружения: GRAFANA_VALIDATE_CERT

Примечание

Указанные выше записи конфигурации для каждого типа записи (переменная Ansible, переменная окружения и т. д.) упорядочены от низкого к высокому приоритету. Например, переменная, расположенная ниже в списке, переопределяет переменную, расположенную выше. Типы записей также упорядочены по приоритету от низкого к высокому. Например, запись в ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).

Авторы

  • Rémi REY (@rrey)

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 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/grafana/grafana_annotations_callback.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API