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

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

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
access -	Варианты: direct proxy ←	Режим доступа для этого источника данных.
aws_access_key - добавлено в 2.8	Значение по умолчанию: ""	Ключ доступа AWS для типа источника данных CloudWatch, когда `aws_auth_type` равно `keys`.
aws_assume_role_arn - добавлено в 2.8	Значение по умолчанию: ""	ARN роли AWS IAM для принятия роли для типа источника данных CloudWatch, когда `aws_auth_type` равно `arn`.
aws_auth_type - добавлено в 2.8	Варианты: keys ← credentials arn	Тип аутентификации AWS для типа источника данных CloudWatch (authType API Grafana).
aws_credentials_profile - добавлено в 2.8	Значение по умолчанию: ""	Профиль AWS credentials для типа источника данных CloudWatch, когда `aws_auth_type` равно `credentials`.
aws_custom_metrics_namespaces - добавлено в 2.8	Значение по умолчанию: ""	Имена пространств пользовательских метрик для типа источника данных CloudWatch.
aws_default_region - добавлено в 2.8	Варианты: ap-northeast-1 ap-northeast-2 ap-southeast-1 ap-southeast-2 ap-south-1 ca-central-1 cn-north-1 cn-northwest-1 eu-central-1 eu-west-1 eu-west-2 eu-west-3 sa-east-1 us-east-1 ← us-east-2 us-gov-west-1 us-west-1 us-west-2	Регион AWS по умолчанию для типа источника данных CloudWatch.
aws_secret_key - добавлено в 2.8	Значение по умолчанию: ""	Секретный ключ AWS для типа источника данных CloudWatch, когда `aws_auth_type` равно `keys`.
basic_auth_password -		Пароль для базовой аутентификации источника данных, когда `basic auth` равно `yes`.
basic_auth_user -		Пользователь для базовой аутентификации источника данных. Установка этого параметра вместе с basic_auth_password включит базовые аутентификационные данные.
client_cert - добавлено в 2.8		Путь к сертификату TLS, используемый Ansible для запроса API Grafana.
client_key - добавлено в 2.8		Путь к приватному ключу TLS, используемый Ansible для запроса API Grafana.
database -		Имя базы данных для источника данных. Этот параметр необходим, когда `ds_type` равно `influxdb`, `elasticsearch` (имя индекса), `mysql` или `postgres`.
ds_type - / обязательно	Варианты: graphite prometheus elasticsearch influxdb opentsdb mysql postgres cloudwatch 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_url - / обязательно		URL Grafana.
interval -	Варианты: Час День Неделя Месяц Год	Для Elasticsearch `ds_type`, это используемый шаблон индекса.
is_default boolean	Варианты: нет ← да	Установить этот источник данных по умолчанию.
max_concurrent_shard_requests -	Значение по умолчанию: 256	Начиная с Elasticsearch 5.6, вы можете указать максимальное количество одновременных запросов к фрагментам.
name - / обязательно		Имя источника данных.
org_id -	Значение по умолчанию: 1	ID организации 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.

END_OF_DOCUMENT_MARKER

tsdb_version -	Варианты: 1 ← 2 3	Версия opentsdb. Используйте `1` для <=2.1, `2` для ==2.2, `3` для ==2.3.
url - / обязательно		URL источника данных. Псевдонимы: ds_url
url_password - добавлен в 2.7	По умолчанию: "admin"	Пароль API Grafana. Псевдонимы: grafana_password
url_username - добавлен в 2.7	По умолчанию: "admin"	Пользователь API Grafana. Псевдонимы: grafana_user
use_proxy boolean добавлен в 2.8	Варианты: нет да ←	Логическое значение, указывающее, использовать ли прокси.
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: "elasticsearch"
    ds_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"
    ds_url: "https://influx.company.com:8086"
    database: "telegraf"
    time_interval: ">10s"
    tls_ca_cert: "/etc/ssl/certs/ca.pem"

- name: Create postgres datasource
  grafana_datasource:
    name: "datasource-postgres"
    grafana_url: "https://grafana.company.com"
    grafana_user: "admin"
    grafana_password: "xxxxxx"
    org_id: "1"
    ds_type: "postgres"
    ds_url: "postgres.company.com:5432"
    database: "db"
    user: "postgres"
    password: "iampgroot"
    sslmode: "verify-full"

- name: Create cloudwatch datasource
  grafana_datasource:
    name: "datasource-cloudwatch"
    grafana_url: "https://grafana.company.com"
    grafana_user: "admin"
    grafana_password: "xxxxxx"
    org_id: "1"
    ds_type: "cloudwatch"
    url: "http://monitoring.us-west-1.amazonaws.com"
    aws_auth_type: "keys"
    aws_default_region: "us-west-1"
    aws_access_key: "speakFriendAndEnter"
    aws_secret_key: "mel10n"
    aws_custom_metrics_namespaces: "n1,n2"

Значения возврата

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

Ключ	Возвращаемое значение	Описание
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)
Martin Wang (@martinwangjian)

Подсказка

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

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