community.postgresql.postgresql_user_obj_stat_info – Сбор статистики о пользовательских объектах PostgreSQL
Примечание
Этот плагин входит в коллекцию community.postgresql (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install community.postgresql.
Для использования в книге задач, укажите: community.postgresql.postgresql_user_obj_stat_info.
Введено в версии 0.2.0: коллекции community.postgresql
Обзор
- Сбор статистики о пользовательских объектах PostgreSQL.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- psycopg2
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ca_cert строка | Указывает имя файла, содержащего сертификат(ы) центра сертификации SSL (CA). Если файл существует, сертификат сервера будет проверен на подпись одним из этих центров. Псевдонимы: ssl_rootcert | |
| db строка | Имя базы данных для подключения. Псевдонимы: login_db | |
| filter список / элементы=строка | Ограничение собираемой информации через запятую или списком YAML. Допустимые значения: functions, indexes, tables.По умолчанию собираются все подмножества. Неподдерживаемые значения игнорируются. | |
| login_host строка | Хост, на котором выполняется база данных. | |
| login_password строка | Пароль для аутентификации. | |
| login_unix_socket строка | Путь к сокету Unix для локальных соединений. | |
| login_user строка | По умолчанию: "postgres" | Имя пользователя для аутентификации. |
| port целое число | По умолчанию: 5432 | Порт базы данных для подключения. Псевдонимы: login_port |
| schema строка | Ограничение вывода определенным схемой. | |
| session_role строка | Переключение на роль session_role после подключения. Указанная роль session_role должна быть ролью, членом которой является текущий пользователь login_user. Проверка разрешений для SQL-команд выполняется так, как будто роль session_role была той, которая изначально вошла в систему. | |
| ssl_mode строка |
| Определяет, будет ли и с каким приоритетом устанавливаться защищенное соединение SSL TCP/IP с сервером. См. https://www.postgresql.org/docs/current/static/libpq-ssl.html для получения дополнительной информации о режимах. Значение по умолчанию prefer соответствует значению по умолчанию libpq. |
| trust_input логическое добавлено в 0.2.0 community.postgresql |
| Если no, проверяется, что значение session_role потенциально опасно.Использование no целесообразно только в тех случаях, когда возможны SQL-инъекции через session_role. |
Примечания
Примечание
-
sizeиtotal_sizeвозвращаемые значения представлены в байтах. - Для отслеживания статистики функций параметр PostgreSQL
track_functionsдолжен быть включен. Для получения дополнительной информации см. https://www.postgresql.org/docs/current/runtime-config-statistics.html. - Аутентификация по умолчанию предполагает, что вы входите в систему как или используете sudo для учетной записи
postgresна хосте. - Чтобы избежать ошибки «Ошибка проверки подлинности клиента для пользователя postgres», используйте пользователя postgres в качестве become_user.
- Этот модуль использует psycopg2, адаптер Python для базы данных PostgreSQL. Необходимо убедиться, что psycopg2 установлен на хосте перед использованием этого модуля.
- Если удаленный хост является сервером PostgreSQL (что является стандартным случаем), то PostgreSQL также должен быть установлен на удаленном хосте.
- Для систем на основе Ubuntu установите пакеты postgresql, libpq-dev и python-psycopg2 на удаленном хосте перед использованием этого модуля.
- Параметр ca_cert требует по крайней мере версию Postgres 8.4 и psycopg2 версии 2.4.3.
См. также
См. также
- community.postgresql.postgresql_info
-
Официальная документация по модулю community.postgresql.postgresql_info.
- community.postgresql.postgresql_ping
-
Официальная документация по модулю community.postgresql.postgresql_ping.
- Ссылка на справку по сборщику статистики PostgreSQL
-
Полная справочная информация по документации сборщика статистики PostgreSQL.
Примеры
- name: Collect information about all supported user objects of the acme database
community.postgresql.postgresql_user_obj_stat_info:
db: acme
- name: Collect information about all supported user objects in the custom schema of the acme database
community.postgresql.postgresql_user_obj_stat_info:
db: acme
schema: custom
- name: Collect information about user tables and indexes in the acme database
community.postgresql.postgresql_user_obj_stat_info:
db: acme
filter: tables, indexes
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| functions словарь | всегда | Статистика пользовательских функций. Пример: {'public': {'inc': {'вызовы': 1, 'funcid': 26722, 'время_самостоятельно': 0.23, 'общее_время': 0.23}}} |
| indexes словарь | всегда | Статистика пользовательских индексов Пример: {'public': {'test_id_idx': {'...': None, 'сканирование_индекса': 0, 'получение_строки_индекса': 0, 'чтение_строки_индекса': 0, 'relname': 'test', 'размер': 8192}}} |
| tables словарь | всегда | Статистика пользовательских таблиц. Пример: {'public': {'test': {'...': None, 'количество_анализов': 3, 'число_мертвых_строк': 0, 'число_живых_строк': 0, 'последовательное_сканирование': 2, 'размер': 0, 'общий_размер': 8192}}} |
Авторы
- Andrew Klychkov (@Andersson007)
- Thomas O’Donnell (@andytom)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/postgresql/postgresql_user_obj_stat_info_module.html