Утилита сбора логов LogCatcher¶

Назначение¶

Утилита LogCatcher (исполняемый файл logcatcher.cmd) собирает логи УС. Устанавливается автоматически в процессе установки ПроАТМ/XFS в папку %SystemDrive%\FS365\XFS\ 1. Поддерживает работу на устройствах производства Diebold Nixdorf, DORS, Nautilus Hyosung, NCR, SCS, SFOUR и др.

Порядок работы утилиты LogCatcher:

Создает и очищает рабочую папку сборщика (по умолчанию %SystemDrive%\temp).
Проверяет наличие привилегий доступа к рабочей папке.
Проверяет наличие в системе утилиты xcopy.
Определяет режим запуска и позволяет выбрать используемые настройки.
Определяет используемые компоненты УС.
Выбирает тип архиватора (7z-архиватор или cab-архиватор).
Приостанавливает сбор логов службой логирования RedLabel.
Имя ранее собранного архива логов Log.z изменяется на Log(res_copy_at_дд.мм.гггг).bak, где дд.мм.гггг – текущая дата.
Собирает необходимую информацию.
Возобновляет сбор логов службой логирования RedLabel.
Архивирует собранные данные в файл с именем Log.z.
Удаляет временные файлы.

В случае неуспешных проверок сбор данных прерывается.

1: %SystemDrive% – системная переменная среды ОС Windows, буква диска, на котором находится корневой каталог ОС (в большинстве случаев – «C:»).

Что собирает LogCatcher¶

Системные логи и настройки:
- файловая структура системного диска (в файл dir.txt);
- даты версий драйверов устройств (в файл drivers.txt);
- сведения о системе и подробная информация об установленных компонентах и драйверах DirectX (в файл dxdiaginfo.txt);
- список локальных групп (в файл users.txt);
- конфигурации разрешенных программ для пользователей, конфигурации для различных профилей, другие конфигурации и информации о брандмауэре (в файл firewall.txt);
- планы электропитания, используемый план отмечен символом «*» (звездочка) (в файл powercfg.txt);
- состояние системных служб (в файл services.txt);
- задания планировщика (в файл schtasks.txt);
- шаблон используемых локальных политик безопасности (в файл secedit.inf);
- имена и значения переменных среды (в файл set.txt);
- сведения о конфигурации ОС (в файл systeminfo.txt);
- данные BIOS и материнской платы (в файл motherboard.txt);
- список установленных программ (в файл version.txt);
- сведения об учетных записей системы (в файл useraccount.txt);
- дополнительная системная информация (в файл compinfo.csv);
- параметры ветки реестра [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet] (в файл CurrentControlSet.TXT);
- настройки Internet Explorer в ветке реестра [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Internet Explorer] (в файл IExplore.TXT);
- настроки умолчаний для учетных записей в ветке реестра [HKEY_USERS\.DEFAULT] (в файл HKU.Default.TXT);
- системные журналы (в папку EventLogs);
- дампы отказа системы (в папку файл Minidump).
Логи и настройки ГК DORS:
- настройки ПроАТМ/XFS (HKEY_LOCAL_MACHINE\SOFTWARE\XFS);
- настройки ПроАТМ (HKEY_LOCAL_MACHINE\SOFTWARE\FS365);
- логи ПроСЭТ (%SystemDrive%\PServer);
- логи установки ПроАТМ/XFS и ПроАТМ (%temp%\@@@_ProATM*_Temp_@@@);
- логи работы ПроАТМ/XFS и ПроАТМ (%SystemDrive%\FS365).
Логи и настройки Diebold Nixdorf:
- настройки XFS (HKEY_CLASSES_ROOT\WOSA/XFS_ROOT);
- настройки Diebold Nixdorf (HKEY_LOCAL_MACHINE\SOFTWARE\Wincor Nixdorf);
- логи работы PROBASE (%SystemDrive%\PROBASE);
- логи работы ProAgent (%SystemDrive%\Install);
- логи работы Diebold (%SystemDrive%\Dieboldedc).
Логи и настройки FinStream:
- настройки FinStream (HKEY_CURRENT_USER\SOFTWARE\FinStream\FSDev);
- логи работы FinStream (%SystemDrive%\FinStream);
- пакет логов FinStream (%SystemDrive%\FinStream\Utils\zreport.bat).
Логи и настройки GCS:
- настройки GCS (HKEY_CURRENT_USER\SOFTWARE\SERENARE);
- логи работы GCS (%SystemDrive%\GcsTerminal);
Настройки Nautilus Hyosung:
- настройки Nautilus Hyosung (HKEY_LOCAL_MACHINE\SOFTWARE\Nextware).
Логи и настройки NCR:
- настройки NCR Aptra XFS (HKEY_CLASSES_ROOT\WOSA/XFS_ROOT);
- настройки NCR (HKEY_LOCAL_MACHINE\SOFTWARE\NCR);
- логи работы NCR (%SystemDrive%\Program Files\Common Files\NCR\Logs);
- логи работы NCR APTRA (%SystemDrive%\Program Files\NCR APTRA\Exception Handling\logs);
- прочие логи NCR APTRA (%SystemDrive%\NCRLOGS).
Логи и настройки PowerCom:
- логи работы UPSMonPro (%SystemDrive%\Users\Public\UPSMON-Pro);
Логи и настройки SCS:
- настройки XFS (HKEY_CLASSES_ROOT\WOSA/XFS_ROOT);
- настройки Tellme (HKEY_LOCAL_MACHINE\SOFTWARE\SCS);
- логи работы Tellme (%SystemDrive%\SCS\ATM_H);
- прочие логи Tellme (%SystemDrive%\SCS\LOGS).

Примечание

При получении и сохранение данных из раздела системного реестра HKEY_LOCAL_MACHINE\SOFTWARE предполагается работа в 32-бином режиме (в 64-битных системах это раздел HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node).

Запуск и настройка сборки логов¶

Внимание

Период сборки – это интервал, за который будут собраны архивные базы RedLabel, файлы журналов терминального ПО (электронный, чековый и протокольный журналы) и записи системного журнала. Другие логи собираются всегда в полном объеме.

Командная строка¶

Формат запуска:

logcatcher.cmd [help] [период_сборки] [состав_сборки]

Параметры:

help – справка и запуск текстового интерфейса утилиты.
период_сборки – начало и окончание периода, за который будут собраны архивные базы RedLabel, в формате «ГГГГ.ММ.ДД ЧЧ:ММ:СС - ГГГГ.ММ.ДД ЧЧ:ММ:СС». По умолчанию архивные базы RedLabel собираются за последние две недели без учета времени. Другие логи собираются всегда в полном объеме.
состав_сборки – последовательнось единиц и нулей (4 цифры), определяющая собираемые логи:
- 1-я цифра – сборка системных логов и настроек (0 – не собирать, 1 – собирать);
- 2-я цифра – сборка логов и настроек ГК DORS без архивированных баз RedLabel (0 – не собирать, 1 – собирать);
- 3-я цифра – сборка архивированных баз RedLabel (0 – не собирать, 1 – собирать);
- 4-я цифра – сборка логов и настроек стороннего ПО (0 – не собирать, 1 – собирать).
По умолчанию, если состав сборки не указан, собираются системные логи и настройки, логи и настройки ГК DORS, архивированные базы RedLabel, логи и настройки системного ПО (1111).

Запуск утилиты без параметров запустит сборку всех логов за последние две недели.

Примеры:

Сборка всех логов, включая архивы RedLabel за указанный период:
```
logcatcher.cmd "2022.01.22 20:22:02 - 2022.02.22 10:22:02"
```
Сборка логов и настроек ГК DORS, включая архивы RedLabel, за указанный период:
```
logcatcher.cmd "2022.01.22 20:22:02 - 2022.02.22 10:22:02" "0110"
```

Графический интерфейс (LogCatcherUI)¶

Графический интерфейс LogCatcher – это исполняемый файл LogCatcherUI.exe. Он устанавливается автоматически в процессе установки ПроАТМ в ту же папку, что и утилита LogCatcher (%SystemDrive%\FS365\XFS\). В графическом интерфейсе можно изменить период и состав сборки логов, запустить LogCatcher с выбранными параметрами сборки.

Рисунок 10. Окно LogCatcherUI¶

Дата начала выборки (Start) и Дата завершения (End) – начало и окончание периода, за который будут собраны архивные базы RedLabel, в формате «ГГГГ.ММ.ДД ЧЧ:ММ:СС - ГГГГ.ММ.ДД ЧЧ:ММ:СС». По умолчанию архивные базы RedLabel собираются за последние две недели без учета времени. Другие логи собираются всегда в полном объеме.
Поместить в архив – состав сборки:
- Журналы ОС, настройки ОС, и т.д. (System) – собирать системные логи и настройки;
- Файлы DORS без архивов RedLabel (Main) – собирать логи и настройки ГК DORS без архивированных баз RedLabel;
- База данных RedLabel (Detailed Logs) – собирать архивированные базы RedLabel;
- Данные других вендоров (Other vendors) – собирать логи и настройки стороннего ПО.
Команда запуска LogCatcher (уже скопирована в Clipboard) – команда запуска LogCatcher из командной строки, копируется в буфер обмена при запуске LogCatcherUI и при изменении параметров сборки.
Запустить LogCatcher – запустить LogCatcher с указанным периодом и составом сборки.
Выйти – закрыть LogCatcherUI без запуска LogCatcher.

По умолчанию собираются системные логи и настройки, логи и настройки ГК DORS без архивированных баз RedLabel.

Порядок работы:

Запустите файл LogCatcherUI.exe.
При необходимости в окне LogCatcherUI измените период и состав сборки.
Нажмите кнопку Запустить LogCatcher. Утилита LogCatcher запустится в командной строке.
Дождитесь окончания работы утилиты. Если сбор логов завершился успешно, то в той же папке, в которой находится файл logcatcher.cmd появится архив archive.cab или Log.z. В случае ошибок, собранные материалы (промежуточные результаты) сохраняются в папке %SystemDrive%\temp. Журнал работы LogCatcher ведется в файле LogZ.log.

Текстовый интерфейс¶

Текстовый интерфейс LogCatcher отображается в командной строке и использует при вводе-выводе и представлении информации исключительно набор буквенно-цифровых символов и символов псевдографики. Он запускается следующей командой:

logcatcher.cmd help

После запуска в командной строке отображается меню действий. Как и в графическом интерфейсе, в текстовом можно изменить период и состав сборки логов, запустить LogCatcher с выбранными параметрами сборки.

Листинг 1. Меню текстового интерфейса LogCatcher¶

                   ИНСТРУМЕНТ СБОРКИ ЛОГОВ

   -------------------------------------------------------  |
    Период: 2022.03.07 08:49:40 - 2022.03.21 08:49:40       |<--- период и состав сборки логов
    Состав: ВСЕ доступные логи и настройки                  |
   -------------------------------------------------------  |

    1. Изменить временной период                            |
    2. Изменить состав                                      |
    3. Собрать пакет логов (*)                              |<--- меню текстового интерфейса
                                                            |
    h. Описание инструмента                                 |
    q. Выход                                                |

   (*) Собрать пакет логов (любая клавиша)

   Пожалуйста, выберите действие:                           |<--- поле для ввода команды: номер действия или "h", "q", "*"

Пример изменения периода и состава сбоки логов¶

Необходимо собрать системные логи и настройки, логи и настройки ГК DORS, архивированные базы RedLabel за период с 17.03.2022 по 18.03.2022.

Выполните команду:
```
logcatcher.cmd help
```

В меню введите «1» («Изменить временной период») и нажмите клавишу Enter:

                ИНСТРУМЕНТ СБОРКИ ЛОГОВ

-------------------------------------------------------
 Период: 2022.03.07 09:43:49 - 2022.03.21 09:43:49
 Состав: ВСЕ доступные логи и настройки
-------------------------------------------------------

 1. Изменить временной период
 2. Изменить состав
 3. Собрать пакет логов (*)

 h. Описание инструмента
 q. Выход

(*) Собрать пакет логов (любая клавиша)

Пожалуйста, выберите действие: 1

На следующем экране введите «1», чтобы изменить начало периода сборки, и нажмите клавишу Enter:

                ИНСТРУМЕНТ СБОРКИ ЛОГОВ
                    (период сборки)

-------------------------------------------------------
1. Изменить начало периода (дата)            2022.03.07
2. Изменить начало периода (время)             09:43:49
3. Изменить окончание периода (дата)         2022.03.21
4. Изменить окончание периода (время)          09:43:49
0. Задать период целиком
q. Вернуться в меню (*)

(*) Вернуться в меню (любая клавиша)
-------------------------------------------------------
Формат ввода                          ГГГГММДД ГГГГММДД
Выберите действие или введите период: 1                  |<--- выбрано действие "Изменить начало периода (дата)"

Введите дату начала периода в формате «ГГГГММДД» и нажмите клавишу Enter:

                ИНСТРУМЕНТ СБОРКИ ЛОГОВ
                    (период сборки)

-------------------------------------------------------
1. Изменить начало периода (дата)            2022.03.07
2. Изменить начало периода (время)             09:43:49
3. Изменить окончание периода (дата)         2022.03.21
4. Изменить окончание периода (время)          09:43:49
0. Задать период целиком
q. Вернуться в меню (*)

(*) Вернуться в меню (любая клавиша)
-------------------------------------------------------
Формат ввода                          ГГГГММДД ГГГГММДД
Выберите действие или введите период: 1

----------------
Введите дату начала периода           ГГГГММДД
, '-' для 2000.01.01, 'q' для отмены: 20220317            |<--- новая дата

Дата начала периода изменилась на введенную:

                ИНСТРУМЕНТ СБОРКИ ЛОГОВ
                    (период сборки)

-------------------------------------------------------
1. Изменить начало периода (дата)            2022.03.17   |<--- введенная дата
2. Изменить начало периода (время)             09:43:49

Введите «3», чтобы изменить окончание периода сборки, и нажмите клавишу Enter:

                ИНСТРУМЕНТ СБОРКИ ЛОГОВ
                    (период сборки)

-------------------------------------------------------
1. Изменить начало периода (дата)            2022.03.17
2. Изменить начало периода (время)             09:43:49
3. Изменить окончание периода (дата)         2022.03.21
4. Изменить окончание периода (время)          09:43:49
0. Задать период целиком
q. Вернуться в меню (*)

(*) Вернуться в меню (любая клавиша)
-------------------------------------------------------
Формат ввода                          ГГГГММДД ГГГГММДД
Выберите действие или введите период: 3                    |<--- выбрано действие "Изменить окончание периода (дата)"

Введите дату окончания периода в формате «ГГГГММДД» и нажмите клавишу Enter:

                ИНСТРУМЕНТ СБОРКИ ЛОГОВ
                    (период сборки)

-------------------------------------------------------
1. Изменить начало периода (дата)            2022.03.17
2. Изменить начало периода (время)             09:43:49
3. Изменить окончание периода (дата)         2022.03.21
4. Изменить окончание периода (время)          09:43:49
0. Задать период целиком
q. Вернуться в меню (*)

(*) Вернуться в меню (любая клавиша)
-------------------------------------------------------
Формат ввода                          ГГГГММДД ГГГГММДД
Выберите действие или введите период: 3

----------------
Введите дату окончания периода        ГГГГММДД
, '-' для 2099.12.31, 'q' для отмены: 20220318             |<--- новая дата

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

                ИНСТРУМЕНТ СБОРКИ ЛОГОВ
                    (период сборки)

-------------------------------------------------------
1. Изменить начало периода (дата)            2022.03.17
2. Изменить начало периода (время)             09:43:49
3. Изменить окончание периода (дата)         2022.03.18    |<--- введенная дата

Вернитесь в меню – введите «*» и нажмите клавишу Enter:

                ИНСТРУМЕНТ СБОРКИ ЛОГОВ
                    (период сборки)

-------------------------------------------------------
1. Изменить начало периода (дата)            2022.03.17
2. Изменить начало периода (время)             09:43:49
3. Изменить окончание периода (дата)         2022.03.18
4. Изменить окончание периода (время)          09:43:49
0. Задать период целиком
q. Вернуться в меню (*)

(*) Вернуться в меню (любая клавиша)
-------------------------------------------------------
Формат ввода                          ГГГГММДД ГГГГММДД
Выберите действие или введите период: *

Период сборки в меню изменился:

                ИНСТРУМЕНТ СБОРКИ ЛОГОВ

-------------------------------------------------------
 Период: 2022.03.17 09:43:49 - 2022.03.18 09:43:49          |<--- период сборки изменен
 Состав: ВСЕ доступные логи и настройки
-------------------------------------------------------

Примечание

Альтернативный способ изменить период сборки: на шаге 3 вместо выбора действия введите даты начала и окончания периода сборки «20220317 20220318» и нажмите клавишу Enter.

                ИНСТРУМЕНТ СБОРКИ ЛОГОВ
                    (период сборки)

-------------------------------------------------------
1. Изменить начало периода (дата)            2022.03.07
2. Изменить начало периода (время)             11:07:50
3. Изменить окончание периода (дата)         2022.03.21
4. Изменить окончание периода (время)          11:07:50
0. Задать период целиком
q. Вернуться в меню (*)

(*) Вернуться в меню (любая клавиша)
-------------------------------------------------------
Формат ввода                          ГГГГММДД ГГГГММДД
Выберите действие или введите период: 20220317 20220318   |<---новый период сборки

Период сборки изменится на введенный:

                ИНСТРУМЕНТ СБОРКИ ЛОГОВ
                    (период сборки)

-------------------------------------------------------
1. Изменить начало периода (дата)            2022.03.17
2. Изменить начало периода (время)             00:00:00
3. Изменить окончание периода (дата)         2022.03.18
4. Изменить окончание периода (время)          23:59:59

В меню введите «2» («Изменить состав») и нажмите клавишу Enter:

                ИНСТРУМЕНТ СБОРКИ ЛОГОВ

-------------------------------------------------------
 Период: 2022.03.17 09:43:49 - 2022.03.18 09:43:49
 Состав: ВСЕ доступные логи и настройки
-------------------------------------------------------

 1. Изменить временной период
 2. Изменить состав
 3. Собрать пакет логов (*)

 h. Описание инструмента
 q. Выход

(*) Собрать пакет логов (любая клавиша)

Пожалуйста, выберите действие: 2

На следующем экране отображается список логов, которые будут собраны. По умолчанию собираются все. Необходимо отлючить сборку пунктов с 4 по 9. Для этого последовательно водите номера логов, которые собирать не нужно, и нажимайте клавишу Enter:

                ИНСТРУМЕНТ СБОРКИ ЛОГОВ
                  (текущие настройки)

-------------------------------------------------------
1. Системные логи и настройки               Собирать     |
2. Логи и настройки DORS (без RedLabel)     Собирать     |
3. Архивные логи DORS (RedLabel)            Собирать     |
4. Логи и настройки Diebold Nixdorf         Собирать     |
5. Логи и настройки FinStream               Собирать     |<--- эти логи будут собраны
6. Логи и настройки GCS                     Собирать     |
7. Логи и настройки Nautilus Hyosung        Собирать     |
8. Логи и настройки NCR                     Собирать     |
9. Логи и настройки PowerCom                Собирать     |
10. Логи и настройки SCS                    Собирать     |
q. Вернуться в меню (*)

(*) Вернуться в меню (любая клавиша)
-------------------------------------------------------

Что требуется изменить: 4                                |<--- позиция в списке, сборку которой нужно отключить

Логи будут помечены строкой «Не собирать»:

                ИНСТРУМЕНТ СБОРКИ ЛОГОВ
                  (текущие настройки)

-------------------------------------------------------
1. Системные логи и настройки               Собирать        |
2. Логи и настройки DORS (без RedLabel)     Собирать        |<--- эти логи будут собраны
3. Архивные логи DORS (RedLabel)            Собирать        |
4. Логи и настройки Diebold Nixdorf         Не собирать  |
5. Логи и настройки FinStream               Не собирать  |
6. Логи и настройки GCS                     Не собирать  |
7. Логи и настройки Nautilus Hyosung        Не собирать  |<--- логи, сборка которых отключена
8. Логи и настройки NCR                     Не собирать  |
9. Логи и настройки PowerCom                Не собирать  |
10. Логи и настройки SCS                    Не собирать  |
q. Вернуться в меню (*)

(*) Вернуться в меню (любая клавиша)
-------------------------------------------------------

Что требуется изменить:

Вернитесь в меню – введите «*» и нажмите клавишу Enter. Состав сборки в меню изменился:

                ИНСТРУМЕНТ СБОРКИ ЛОГОВ

-------------------------------------------------------
 Период: 2022.03.17 09:43:49 - 2022.03.18 09:43:49
 Состав:                                                  |
  - системные логи и настройки                            |
  - логи и настройки DORS (без RedLabel)                  |<---состав сборки изменился
  - архивные логи DORS (RedLabel)                         |
-------------------------------------------------------

Введите «*» или любой другой символ, кроме «1», «2», «3», «h» и «q», и нажмите клавишу Enter. Запустится сборка логов с выбранными параметрами:

                ИНСТРУМЕНТ СБОРКИ ЛОГОВ

-------------------------------------------------------
 Период: 2022.03.17 09:43:49 - 2022.03.18 09:43:49
 Состав:
  - системные логи и настройки
  - логи и настройки DORS (без RedLabel)
  - архивные логи DORS (RedLabel)
-------------------------------------------------------

 1. Изменить временной период
 2. Изменить состав
 3. Собрать пакет логов (*)

 h. Описание инструмента
 q. Выход

(*) Собрать пакет логов (любая клавиша)

Пожалуйста, выберите действие: *
┌─────────────────────────────────────────────────┐
│ Поиск установленных компонент УС                │
├─────────────────────────────────────────────────┤
│ Определение настроек запуска системы            │
└─────────────────────────────────────────────────┘
Проверка периода сборки (д.б. 23): 23
Все хорошо.

Период: 2022.03.17 09:43:49 - 2022.03.18 09:43:49
Состав: 111000000
┌─────────────────────────────────────────────────┐
│ Дата: 21.03.2022                                │
├─────────────┬───────────────────────────────────┤
│ 10:36:28,90 │ Копирование LogCatcher            │
├─────────────┼───────────────────────────────────┤
│ 10:36:28,92 │ Сбор информации о системе         │

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

Files read from disk: 1236
Archive size: 43742707 bytes (42 MiB)
Everything is Ok
├─────────────┼───────────────────────────────────┤
│ 10:51:57,65 │ Очистка артефактов сборки         │
├─────────────┼───────────────────────────────────┤
│ 10:51:57,90 │ Сбор логов завершен               │
└─────────────┴───────────────────────────────────┘

c:\FS365\Applications>

Если сбор логов завершился успешно, то в той же папке, в которой находится файл logcatcher.cmd появится архив archive.cab или Log.z. В случае ошибок, собранные материалы (промежуточные результаты) сохраняются в папке %SystemDrive%\temp. Журнал работы LogCatcher ведется в файле LogZ.log.

Результат работы¶

Результат работы LogCatcher – архив логов в файле Log.z или archive.cab. Архив создается в той же папке, в которой была запущена утилита. Выбор типа архива зависит от наличия в системе соответствующего архиватора (cab-архиватор или 7z-архиватор). Если установлены оба, то используется 7z-архиватор.

Параметры cab-архивации:

в качестве шаблона используется подготавливаемый archive.ddf;
все файлы сжимаются в cabinet-файл;
имя создаваемого архива – archive.cab.

Параметры 7z-архивации:

используется режим «Ultra compressing»;
метод сжатия: LZMA;
размер словаря: 64 MB;
размер слова: 64;
Match Finder: BT4;
фильтр: BCJ2;
имя создаваемого архива – Log.z.

Рекомендуется предварительно установить в архиватор 7-Zip, загрузив с официального сайта http://www.7-zip.org/.

В случае ошибок, собранные материалы (промежуточные результаты) сохраняются в папке %SystemDrive%\temp. Журнал работы LogCatcher ведется в файле LogZ.log.