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

Примечание

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

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

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

Введено в версии 0.2.0: of 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 строка	Варианты: 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 of community.postgresql	Варианты: 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 для получения дополнительной информации.
Поддерживает check_mode.
Аутентификация по умолчанию предполагает, что вы либо входите в систему как, либо используете sudo для учетной записи postgres на хосте.
Чтобы избежать ошибки «Peer authentication failed for user 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': {'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}}}

Авторы

Andrew Klychkov (@Andersson007)
Thomas O’Donnell (@andytom)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/postgresql/postgresql_user_obj_stat_info_module.html