influxdb_query - Запрос данных из InfluxDB.
Новая версия 2.5.
Описание
- Запрос данных из InfluxDB.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- influxdb >= 0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| database_name обязательно | Имя базы данных. | |
| hostname | Значение по умолчанию: localhost | Имя хоста или IP-адрес, на котором прослушивается сервер InfluxDB. С версии 2.5 значение по умолчанию — localhost. |
| password | Значение по умолчанию: root | Пароль, который будет использован для аутентификации на сервере InfluxDB. Псевдоним login_password добавлен в версии 2.5.псевдонимы: login_password |
| port | Значение по умолчанию: 8086 | Порт, на котором прослушивается сервер InfluxDB |
| proxies (добавлен в 2.5) | Значение по умолчанию: None | HTTP(S) прокси для подключения к серверу InfluxDB. |
| query обязательно | Запрос, который будет выполнен. | |
| retries (добавлен в 2.5) | Значение по умолчанию: 3 | Количество попыток, которое клиент предпримет, прежде чем прервать выполнение. 0 указывает на попытки до достижения успеха. |
| ssl (добавлен в 2.5) | Значение по умолчанию: нет | Использовать https вместо http для подключения к серверу InfluxDB. |
| timeout (добавлен в 2.5) | Значение по умолчанию: None | Количество секунд, которое Requests будет ждать, пока клиент не установит соединение. |
| udp_port (добавлен в 2.5) | Значение по умолчанию: 4444 | UDP порт для подключения к серверу InfluxDB. |
| use_udp (добавлен в 2.5) | Значение по умолчанию: нет | Использовать UDP для подключения к серверу InfluxDB. |
| username | Значение по умолчанию: root | Имя пользователя, которое будет использоваться для аутентификации на сервере InfluxDB. Псевдоним login_username добавлен в версии 2.5.псевдонимы: login_username |
| validate_certs (добавлен в 2.5) | Значение по умолчанию: да | Если установлено значение no, сертификаты SSL не будут проверены.Это значение следует устанавливать только на лично контролируемых сайтах, использующих самозаверяющие сертификаты. |
Примеры
- name: Query connections
influxdb_query:
hostname: "{{ influxdb_ip_address }}"
database_name: "{{ influxdb_database_name }}"
query: "select mean(value) from connections"
register: connection
- name: Query connections with tags filters
influxdb_query:
hostname: "{{ influxdb_ip_address }}"
database_name: "{{ influxdb_database_name }}"
query: "select mean(value) from connections where region='zue01' and host='server01'"
register: connection
- name: Print results from the query
debug:
var: connection.query_results
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| query_results список | успех | Результат запроса Пример: [{'mean': 1245.5333333333333, 'time': '1970-01-01T00:00:00Z'}] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместим.
Автор
- René Moser (@resmo)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете изменить этот документ, чтобы улучшить его.
© 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/influxdb_query_module.html
