grafana_datasource - Управление источниками данных Grafana

Новое в версии 2.5.

Описание
Параметры
Примеры
Возвращаемые значения
Статус
- Автор

Описание

Создание/обновление/удаление источников данных Grafana через API.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
access	Варианты: direct proxy ←	Режим доступа к этому источнику данных.
basic_auth_password		Пароль для базовой аутентификации источника данных, когда `basic auth` является `yes`.
basic_auth_user		Имя пользователя для базовой аутентификации источника данных. Установка этого параметра вместе с basic_auth_password включит базовую аутентификацию.
database		Имя базы данных для источника данных. Этот параметр требуется, когда `ds_type` является `influxdb`, `elasticsearch` (имя индекса), `mysql` или `postgres`.
ds_type обязательно	Варианты: elasticsearch graphite influxdb mysql opentsdb postgres prometheus	Тип источника данных.
es_version	Варианты: 2 5 56	Версия Elasticsearch (только для `ds_type = elasticsearch`). Версия 56 предназначена для Elasticsearch 5.6+ для указания параметра `max_concurrent_shard_requests`.
grafana_api_key		Ключ API Grafana. Если задан, `grafana_user` и `grafana_password` будут игнорироваться.
grafana_password	По умолчанию: admin	Пароль API Grafana.
grafana_url обязательно		URL Grafana.
grafana_user	По умолчанию: admin	Имя пользователя API Grafana.
interval	Варианты: Час День Неделя Месяц Год	Для elasticsearch `ds_type`, это шаблон индексов.
is_default	Варианты: нет ← да	Установить этот источник данных в качестве значения по умолчанию.
max_concurrent_shard_requests	По умолчанию: 256	Начиная с Elasticsearch 5.6, можно указать максимальное количество одновременных запросов к фрагментам.
name обязательно		Имя источника данных.
org_id	По умолчанию: 1	Идентификатор организации Grafana, в которой должен быть создан источник данных. Не используется, когда `grafana_api_key` задан, поскольку `grafana_api_key` относится только к одной организации.
password		Пароль для источника данных.
sslmode	Варианты: disable require verify-ca verify-full	Режим SSL для источника данных типа `postgres`.
state	Варианты: absent present ←	Статус источника данных.
time_field	По умолчанию: timestamp	Имя поля времени в источнике данных elasticsearch. Например, `@timestamp`.
time_interval		Минимальный интервал группировки для источников данных `influxdb` или `elasticsearch`. Например, `>10s`.
tls_ca_cert		Сертификат TLS CA для самозаверенных сертификатов. Используется только когда `tls_client_cert` и `tls_client_key` установлены.
tls_client_cert		Клиентский сертификат TLS. Если `tls_client_cert` и `tls_client_key` установлены, это включит TLS-аутентификацию. Начинается с ----- BEGIN CERTIFICATE -----
tls_client_key		Приватный ключ клиента TLS. Начинается с ----- BEGIN RSA PRIVATE KEY -----
tsdb_resolution	Варианты: millisecond second ←	Разрешение времени opentsdb.
tsdb_version	Варианты: 1 2 3	Версия opentsdb. Используйте `1` для <=2.1, `2` для ==2.2, `3` для ==2.3.
url обязательно		URL источника данных.
user		Имя пользователя для входа в источник данных для источников данных influxdb.
validate_certs	Варианты: нет да ←	Выполнять ли проверку сертификата Grafana.
with_credentials	Варианты: нет ← да	Передавать ли учетные данные, такие как куки или заголовки аутентификации, с межсайтовыми запросами.

Примеры

---
- name: Create elasticsearch datasource
  grafana_datasource:
    name: my_elastic
    grafana_url: http://grafana.company.com
    type: elasticsearch
    url: https://elasticsearch.company.com:9200
    database: my-index_*
    basic_auth: yes
    basic_auth_user: grafana
    basic_auth_password: xxxxxxxx
    json_data: '{"esVersion":5, "timeField": "@timestamp"}'
    state: present

Возвращаемые значения

Общие значения, возвращаемые модулем, описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
after словарь	изменённый	Обновлённый источник данных, изменённый модулем. Пример: {'name': 'grafana_datasource_test', 'database': 'test_*', 'url': 'http://elastic.company.com:9200', 'basicAuth': False, 'jsonData': {'timeField': '@timestamp', 'esVersion': 5, 'timeInterval': '10s'}, 'access': 'proxy', 'orgId': 1, 'user': '', 'password': '', 'type': 'elasticsearch', 'id': 1035, 'isDefault': False, 'withCredentials': False}
before словарь	изменённый	Источник данных, возвращённый API Grafana. Пример: {'name': 'grafana_datasource_test', 'database': 'test_*', 'url': 'http://elastic.company.com:9200', 'basicAuth': False, 'jsonData': {'timeField': '@timestamp', 'esVersion': 5, 'timeInterval': '1m'}, 'access': 'proxy', 'orgId': 1, 'user': '', 'password': '', 'type': 'elasticsearch', 'id': 1035, 'isDefault': False, 'withCredentials': False}
id целое число	успех	Идентификатор источника данных. Пример: 42
name строка	успех	Имя созданного источника данных. Пример: test-ds

Статус

Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется обратной совместимостью.

Автор

Thierry Sallé (@tsalle)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/grafana_datasource_module.html