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

Примечание

Этот модуль является частью коллекции community.postgresql (версия 3.6.1).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.postgresql. Для использования этого модуля требуются дополнительные зависимости, см. Требования для подробностей.

Чтобы использовать его в книге задач, укажите: community.postgresql.postgresql_user_obj_stat_info.

Новое в community.postgresql 0.2.0

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

Обзор

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

Требования

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

psycopg2 >= 2.5.1

Параметры

Параметр	Комментарии
ca_cert псевдонимы: ssl_rootcert строка	Указывает имя файла, содержащего сертификат(ы) сертификационного центра (CA) SSL. Если файл существует, сертификат сервера будет проверен на подпись одним из этих центров.
connect_params словарь добавлен в community.postgresql 2.3.0	Любые дополнительные параметры, которые нужно передать libpg. Эти параметры имеют приоритет. По умолчанию: `{}`
db псевдонимы: login_db строка	Имя базы данных для подключения.
filter список / элементы=строка	Ограничить собранную информацию запятой или списком YAML. Допустимые значения `functions`, `indexes`, `tables`. По умолчанию собирает все подмножества. Неподдерживаемые значения игнорируются.
login_host псевдонимы: host строка	Хост, на котором работает база данных. Если у вас проблемы с подключением при использовании `localhost`, попробуйте использовать `127.0.0.1`. По умолчанию: `""`
login_password строка	Пароль, который должен использовать этот модуль для создания сессии PostgreSQL. По умолчанию: `""`
login_unix_socket псевдонимы: unix_socket строка	Путь к Unix-сокету для локальных подключений. По умолчанию: `""`
login_user псевдонимы: login строка	Имя пользователя, которое должен использовать этот модуль для создания сессии PostgreSQL. По умолчанию: `"postgres"`
port псевдонимы: login_port целое число	Порт базы данных для подключения. По умолчанию: `5432`
schema строка	Ограничить вывод определенной схемой.
session_role строка	Переключиться на session_role после подключения. Указанная session_role должна быть ролью, членом которой является текущий login_user. Проверка разрешений для команд SQL выполняется так, как будто session_role была той, которая первоначально вошла в систему.
ssl_cert путь добавлен в community.postgresql 2.4.0	Указывает имя файла клиента SSL-сертификат.
ssl_key путь добавлен в community.postgresql 2.4.0	Указывает местоположение секретного ключа, используемого для клиентского сертификата.
ssl_mode строка	Определяет, будет ли установлено безопасное SSL TCP/IP-соединение с сервером и с каким приоритетом. См. https://www.postgresql.org/docs/current/static/libpq-ssl.html для получения дополнительной информации о режимах. Значение по умолчанию `prefer` соответствует значению по умолчанию libpq. Варианты: `"allow"` `"disable"` `"prefer"` ← (по умолчанию) `"require"` `"verify-ca"` `"verify-full"`
trust_input булево добавлен в community.postgresql 0.2.0	Если `false`, проверьте, что значение session_role потенциально опасно. Имеет смысл использовать `false` только тогда, когда возможны SQL-инъекции через session_role. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме check_mode и возвращать прогноз измененного состояния без изменения целевого объекта.

Примечания

Примечание

size и total_size возвращаемые значения представлены в байтах.
Для отслеживания статистики функций параметр PostgreSQL track_functions должен быть включён. Для получения дополнительной информации см. https://www.postgresql.org/docs/current/runtime-config-statistics.html.
По умолчанию аутентификация предполагает, что вы входите в систему как пользователь postgres на хосте или используете sudo.
Чтобы избежать ошибки «Ошибка аутентификации пользователя peer для пользователя postgres», используйте пользователя postgres в качестве become_user.
Этот модуль использует psycopg, адаптер базы данных Python PostgreSQL. Необходимо убедиться, что psycopg2 >= 2.5.1 или psycopg3 >= 3.1.8 установлены на хосте перед использованием этого модуля.
Если удалённый хост — это сервер PostgreSQL (что является стандартным случаем), то PostgreSQL также должен быть установлен на удалённом хосте.
Для систем на базе Ubuntu установите пакеты postgresql, libpq-dev и python3-psycopg2 на удалённом хосте перед использованием этого модуля.

См. также

community.postgresql.postgresql_info: Сбор информации о серверах PostgreSQL.
community.postgresql.postgresql_ping: Проверка доступности удалённого сервера PostgreSQL.
Справочник по сборщику статистики 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": {"...": null, "idx_scan": 0, "idx_tup_fetch": 0, "idx_tup_read": 0, "relname": "test", "size": 8192}}}`
tables словарь	Статистика таблиц пользователя. Возвращаемое значение: успех Пример: `{"public": {"test": {"...": null, "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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/postgresql/postgresql_user_obj_stat_info_module.html