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 - / обязательно	Варианты: graphite prometheus elasticsearch influxdb opentsdb mysql postgres alexanderzobnin-zabbix-datasource	Тип источника данных.
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 boolean	Варианты: нет ← да	Сделать этот источник данных по умолчанию.
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 -----
tls_skip_verify boolean добавлено в 2.6	Варианты: нет ← да	Пропустить проверку сертификата TLS источника данных.
trends boolean добавлено в 2.6	Варианты: нет да	Использовать тренды или нет для типа источника данных zabbix
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 boolean	Варианты: нет да ←	Выполнять ли проверку сертификата Grafana.
with_credentials boolean	Варианты: нет ← да	Отправлять ли учетные данные, такие как куки или заголовки аутентификации, с межсайтовыми запросами.

Примеры

---
- name: Create elasticsearch datasource
  grafana_datasource:
    name: "datasource-elastic"
    grafana_url: "https://grafana.company.com"
    grafana_user: "admin"
    grafana_password: "xxxxxx"
    org_id: "1"
    ds_type: "elasticisearch"
    url: "https://elastic.company.com:9200"
    database: "[logstash_]YYYY.MM.DD"
    basic_auth_user: "grafana"
    basic_auth_password: "******"
    time_field: "@timestamp"
    time_interval: "1m"
    interval: "Daily"
    es_version: 56
    max_concurrent_shard_requests: 42
    tls_ca_cert: "/etc/ssl/certs/ca.pem"

- name: Create influxdb datasource
  grafana_datasource:
    name: "datasource-influxdb"
    grafana_url: "https://grafana.company.com"
    grafana_user: "admin"
    grafana_password: "xxxxxx"
    org_id: "1"
    ds_type: "influxdb"
    url: "https://influx.company.com:8086"
    database: "telegraf"
    time_interval: ">10s"
    tls_ca_cert: "/etc/ssl/certs/ca.pem"

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

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

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

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Данный модуль поддерживается сообществом Ansible. [community]

Авторы

Thierry Sallé (@seuf)

Подсказка

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

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