community.general.postgresql_user_obj_stat_info – Сбор статистики о пользовательских объектах PostgreSQL

Примечание

Этот плагин входит в коллекцию community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в книге задач укажите: community.general.postgresql_user_obj_stat_info.

Новое в версии 0.2.0: из community.general

Описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Собирает статистику о пользовательских объектах PostgreSQL.

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется данный модуль.

psycopg2

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ca_cert строка		Указывает имя файла, содержащего сертификат(ы) центра сертификации SSL. Если файл существует, сертификат сервера будет проверен на подпись одним из этих центров. Псевдонимы: 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 строка	Варианты: allow disable prefer ← require verify-ca verify-full	Определяет, будет ли и с каким приоритетом устанавливаться защищённое SSL TCP/IP-соединение с сервером. См. https://www.postgresql.org/docs/current/static/libpq-ssl.html для получения дополнительной информации о режимах. Значение по умолчанию `prefer` соответствует значению по умолчанию libpq.
trust_input булево добавлен в 0.2.0 community.general	Варианты: no yes ←	Если `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.general.postgresql_info: Официальная документация модуля community.general.postgresql_info.
community.general.postgresql_ping: Официальная документация модуля community.general.postgresql_ping.
Справочник по сбору статистики PostgreSQL: Полный справочник по документации по сбору статистики PostgreSQL.

Примеры

- name: Collect information about all supported user objects of the acme database
  community.general.postgresql_user_obj_stat_info:
    db: acme

- name: Collect information about all supported user objects in the custom schema of the acme database
  community.general.postgresql_user_obj_stat_info:
    db: acme
    schema: custom

- name: Collect information about user tables and indexes in the acme database
  community.general.postgresql_user_obj_stat_info:
    db: acme
    filter: tables, indexes

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

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

Ключ	Возвращаемое значение	Описание
functions словарь	всегда	Статистика пользовательских функций. Пример: {'public': {'inc': {'calls': 1, 'funcid': 26722, 'self_time': 0.23, 'total_time': 0.23}}}
indexes словарь	всегда	Статистика пользовательских индексов Пример: {'public': {'test_id_idx': {'...': None, 'idx_scan': 0, 'idx_tup_fetch': 0, 'idx_tup_read': 0, 'relname': 'test', 'size': 8192}}}
tables словарь	всегда	Статистика пользовательских таблиц. Пример: {'public': {'test': {'...': None, 'analyze_count': 3, 'n_dead_tup': 0, 'n_live_tup': 0, 'seq_scan': 2, 'size': 0, 'total_size': 8192}}}

Авторы

Андрей Клычков (@Andersson007)
Томас О’Донелл (@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/general/postgresql_user_obj_stat_info_module.html