grafana_datasource - Управление источниками данных Grafana
Новое в версии 2.5.
Обзор
- Создание/обновление/удаление источников данных Grafana через API.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| access |
| Режим доступа к этому источнику данных. |
| basic_auth_password | Пароль проверки подлинности basic для источника данных, когда basic auth является yes. | |
| basic_auth_user | Пользователь проверки подлинности basic для источника данных. Установка этого параметра вместе с basic_auth_password включит проверку подлинности basic. | |
| database | Имя базы данных для источника данных. Этот параметр требуется, когда ds_type является influxdb, elasticsearch (имя индекса), mysql или postgres. | |
| ds_type обязательно |
| Тип источника данных. |
| es_version |
| Версия 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 bool |
| Сделать этот источник данных по умолчанию. |
| max_concurrent_shard_requests | Значение по умолчанию: 256 | Начиная с Elasticsearch 5.6, можно указать максимальное количество одновременных запросов к фрагментам. |
| name обязательно | Название источника данных. | |
| org_id | Значение по умолчанию: 1 | Идентификатор организации Grafana, в которой должен быть создан источник данных. Не используется, когда grafana_api_key задан, так как grafana_api_key принадлежит только одной организации. |
| password | Пароль источника данных. | |
| sslmode |
| Режим SSL для типа источника данных postgres. |
| state |
| Статус источника данных. |
| 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 bool (добавлен в 2.6) |
| Пропустить проверку сертификата источника данных TLS. |
| trends bool (добавлен в 2.6) |
| Использовать или нет тренды для типа источника данных zabbix. |
| tsdb_resolution |
| Разрешение времени opentsdb. |
| tsdb_version |
| Версия opentsdb. Используйте 1 для <=2.1, 2 для ==2.2, 3 для ==2.3. |
| url обязательно | URL источника данных. | |
| user | Логин пользователя источника данных для influxdb источников данных. | |
| validate_certs bool |
| Нужно ли проверять сертификат Grafana. |
| with_credentials bool |
| Нужно ли отправлять учетные данные, такие как куки или заголовки аутентификации, с межсайтовыми запросами. |
Примеры
---
- 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 dict | изменено | источник данных, обновленный модулем Пример: {'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 dict | изменено | источник данных, возвращенный 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 int | успех | Идентификатор источника данных Пример: 42 |
| name строка | успех | Имя созданного источника данных. Пример: test-ds |
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/grafana_datasource_module.html
