Утилита sos report

1. Введение

Утилита sos report обеспечивает сбор диагностической информации, которая необходима при расследовании проблем.

Использование sos report позволяет избежать множества запросов вывода отдельных команд.

В общем случае, рекомендуется использовать утилиту hdreport, которая включает, в том числе результаты выполнения sos report.

Подробнее об использовании утилиты hdreport см. в руководстве администратора.

2. Установка и запуск утилиты sos report

Утилита sos report включена в среду исполнения zVirt Node, поэтому дополнительные действия по установке не требуются.

Для запуска утилиты с параметрами по умолчанию используйте одну из следующих команд:

sosreport (1)
sos report

1	Данный синтаксис является устаревшим и будет приводить к появлению предупреждения `Redirecting to 'sos report'`.

Для корректного сбора данных команде sos report требуются права root. В настоящее время не существует механизма, позволяющего выполнять команду sos report без прав root.

Обычно команда выполняется в течение нескольких минут. В зависимости от локальной конфигурации и указанных опций в некоторых случаях выполнение команды может занять больше времени.

После завершения работы sos report создаст сжатый файл в каталоге /var/tmp. Этот файл следует предоставить представителю службы поддержки (обычно в качестве вложения к открытому тикету).

3. Параметры запуска sos report

3.1. Пакетный и интерактивный режимы

По умолчанию команда sos report запускается в интерактивном режиме, при котором пользователю необходимо ответить на ряд вопросов в процессе выполнения.

Чтобы избежать необходимости ввода информации о пользователе и учетной записи, команду можно запустить в пакетном режиме, используя опцию --batch. В этом случае, информация о пользователе извлекается из файлов конфигурации среды исполнения:

sos report --batch

3.2. Плагины sos report

3.2.1. Общие сведения о плагинах

Команда sos report имеет структуру плагинов и позволяет пользователю включать и отключать плагины, а также указывать параметры плагинов в командной строке. Список доступных плагинов и их опций можно получить, выполнив следующую команду:

sos report -l

#или

sos report --list-plugins

Список плагинов содержит несколько категорий:

Включенные плагины и их краткое описание:

The following plugins are currently enabled:

 alternatives         System alternatives
 anaconda             Anaconda installer
 anacron              Anacron job scheduling service
...

Отключенные плагины и их краткое описание:

The following plugins are currently disabled:

 abrt                 inactive       Automatic Bug Reporting Tool
 acpid                inactive       ACPI daemon information
...

Список глобальных опций (применяются ко всем плагинам) с описанием и их значений:

The following options are available for ALL plugins:
 timeout                   300      Timeout in seconds for plugin to finish all collections
 cmd-timeout               300      Timeout in seconds for individual commands to finish
 postproc                  True     Enable post-processing of collected data
...

Список опций с описанием и их значений для конкретных плагинов:

The following plugin options are available:
 apache.log                off             gathers all apache logs
 boot.all-images           off             collect lsinitrd for all images
 dnf.history-info          off             collect detailed transaction history
...

Список доступных профилей:

Profiles: apache, boot, cluster, container, debug, desktop, hardware,
           identity, java, kernel, mail, memory, network, nfs,
           openshift, openstack, openstack_controller, packagemanager,
           performance, perl, sap, security, services, storage, sysmgmt,
           system, virt, webserver

Профиль - это набор плагинов, относящихся к определенной категории. Например, профиль hardware содержит плагины для сбора сведений об оборудовании.

Для получения списка доступных профилей и включенных в них плагинов выполните следующую команду:

sos report --list-profiles

3.2.2. Включение и отключение плагинов

В следующей таблице перечислены опции, позволяющие активировать/деактивировать необходимые плагины при запуске утилиты.

Опция Описание Пример

Опция	Описание	Пример
`--enable-plugins <ENABLE_PLUGINS>`	Запускает утилиту с включенными по умолчанию плагинами, а также активацией указанных. Допустимо указание как одного, так и нескольких плагинов через запятую.	`sos report --enable-plugins ovn_central,ovn_host`
`--only-plugins <ONLY_PLUGINS>`	Запускает утилиту с активацией только указанных плагинов.	`sos report --only-plugins boot,grub2`
`--profile <PROFILES>` или `--profiles <PROFILES>`	Запускает утилиту с активацией плагинов, включенных в указанном профиле(ях). Допустимо указание как одного, так и нескольких профилей через запятую.	`sos report --profiles boot,debug`
`--skip-plugins <SKIP_PLUGINS>`	Запускает утилиту с деактивацией указанных плагинов. Допустимо указание как одного, так и нескольких плагинов через запятую.	`sos report --skip-plugins devices,dracut`

--enable-plugins <ENABLE_PLUGINS>

Запускает утилиту с включенными по умолчанию плагинами, а также активацией указанных. Допустимо указание как одного, так и нескольких плагинов через запятую.

sos report --enable-plugins ovn_central,ovn_host

--only-plugins <ONLY_PLUGINS>

Запускает утилиту с активацией только указанных плагинов.

sos report --only-plugins boot,grub2

--profile <PROFILES>

или

--profiles <PROFILES>

Запускает утилиту с активацией плагинов, включенных в указанном профиле(ях). Допустимо указание как одного, так и нескольких профилей через запятую.

sos report --profiles boot,debug

--skip-plugins <SKIP_PLUGINS>

Запускает утилиту с деактивацией указанных плагинов. Допустимо указание как одного, так и нескольких плагинов через запятую.

sos report --skip-plugins devices,dracut

Для более гибкой настройки выполнения команды, можно комбинировать различные опции, например, следующая команда будет запущена с плагинами, включенными в профилях boot и debug, но деактивирует плагины devices и dracut:

sos report --profiles boot,debug --skip-plugins devices,dracut

3.2.3. Настройка параметров плагинов

Для настройки параметров плагинов можно использовать следующие опции:

--alloptions - включает все опции для загруженных плагинов.
--plugin-option <PLUGOPTS> или --plugopts <PLUGOPTS> - позволяет указать значения для конкретных опций в формате имя_плагина.опция=значение. Например:
```
sos report --profile boot --plugin-option boot.all-images=on
```

3.3. Дополнительные параметры

В следующей таблице представлены дополнительные, параметры, позволяющие контролировать работу утилиты:

Опция Описание

Опция	Описание
`--batch`	Активирует пакетный режим выполнения команды.
`--quiet`	При выполнении команды в консоль будут выводиться только критические ошибки.
`--tmp-dir <PATH>`	Позволяет указать каталог, куда будет сохранен созданный архив.
`--verbose`	Увеличивает детализацию вывода.
`--compression-type {auto,gzip,xz}`	Позволяет указать технологию сжатия архива.
`--all-logs`	Включает сбор всех журналов независимо от размера.
`--dry-run`	Тестовый запуск, при котором выполняются плагины, но данные в архив не собираются.
`--label <LABEL>` или `--name <LABEL>`	Позволяет добавить указанную метку к имени архива.
`--log-size <LOG_SIZE>`	Позволяет указать ограничение размера собираемых журналов (в MiB).

--batch

Активирует пакетный режим выполнения команды.

--quiet

При выполнении команды в консоль будут выводиться только критические ошибки.

--tmp-dir <PATH>

Позволяет указать каталог, куда будет сохранен созданный архив.

--verbose

Увеличивает детализацию вывода.

--compression-type {auto,gzip,xz}

Позволяет указать технологию сжатия архива.

--all-logs

Включает сбор всех журналов независимо от размера.

--dry-run

Тестовый запуск, при котором выполняются плагины, но данные в архив не собираются.

--label <LABEL>

или

--name <LABEL>

Позволяет добавить указанную метку к имени архива.

--log-size <LOG_SIZE>

Позволяет указать ограничение размера собираемых журналов (в MiB).