Spec-Zone.ru › Ansible

community.grafana.grafana_annotations обратный вызов – отправка событий ansible в виде аннотаций на графики в Grafana через http-api.

Примечание

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

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

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

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

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

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

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

Описание

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

Требования

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

  • включение в конфигурацию

Параметры

Параметр

Комментарии

grafana_api_key

строка

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

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

  • Запись INI:

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

grafana_dashboard_id

целое число

Идентификатор панели Grafana, где будет создана аннотация.

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

  • Запись INI:

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

grafana_panel_ids

список / элементы=целое число

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

Значение по умолчанию: []

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

  • Запись INI:

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

grafana_password

строка

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

Значение по умолчанию: "ansible"

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

  • Запись INI:

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

grafana_url

строка / обязательно

URL API Grafana для аннотаций

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

  • Запись INI:

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

grafana_user

строка

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

Значение по умолчанию: "ansible"

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

  • Запись INI:

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

http_agent

строка

Значение 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

логическое

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

Варианты:

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

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

  • Записи INI:

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

Авторы

  • Rémi REY (@rrey)

Подсказка

Записи конфигурации для каждого типа записи имеют порядок приоритета от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределяет переменную, расположенную выше.

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

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (источники)

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

Spec-Zone.ru

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