Общие сведения

Через интерфейс приложения со страницы приложения /setting/logs (раздел "Логи" в системе) также можно скачать архив с диагностической информацией о текущем состоянии системы:

версии и лицензии системы;
системном окружении;
конфигурации системы;
действиях с базами данных системы;
действиях пользователей и событиях сервисов за последние сутки;
основных сущностях, хранящихся в системе.

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

Получение файлов диагностики через интерфейс приложения

Чтобы скачать файлы диагностики, кликните на странице кнопку «Выгрузить» и выберите в меню «Диагностику». По клику формируется и автоматически скачивается архив с файлами, о чем сообщает нотификация "Запущена выгрузка диагностической информации. Идет подготовка файла выгрузки". Формирование архива для скачивания может занять некоторое время.

Scroll Title

title-alignment	center
title	Раздел "Логи". Кнопка выгрузки диагностики

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

Структура архива диагностики

Архив с файлами диагностики имеет название типа bi_pd_diag_manager_<дата_выгрузки>_<время_выгрузки>.zip. Архив имеет следующую структуру:

Scroll Title

title-alignment	center
title	Раздел "Логи". Кнопка выгрузки логов

где:

папка configs содержит в себе все конфигурационные файлы сервисов системы с текущими настроенными параметрами;
файл CHROMEDRIVER.log содержит в себе сообщения от сервера автотестирования системы в браузере-клиенте ChromeDriver;
файл columns.csv содержит в себе информацию о всех имеющихся в системе расчетных колонках;
файл components.csv содержит в себе информацию о всех имеющихся в системе компонентах виджетов, системных и загруженных пользователями;
файл connectors.csv содержит в себе информацию о всех имеющихся в системе коннекторах к базам данных и файловым источникам;
файл datasets.csv содержит в себе информацию о всех имеющихся в системе датасетах;
файл environment.json содержит в себе информацию о системном окружении;
файл filters.csv содержит в себе информацию о всех имеющихся в системе шаблонах глобальных фильтров;
файл license_info.json содержит в себе информацию о лицензии на систему;
файл migrations.csv содержит в себе информацию о всех производившихся с момента установки системы миграциях баз данных;
файл modules.csv содержит в себе информацию о всех подключенных сервисах системы;
файл project_themes.csv содержит в себе информацию о всех имеющихся в системе темах проектов, системных и созданных пользователями;
файл projects.csv содержит в себе информацию о всех имеющихся в системе проектах;
файл release_version.json содержит в себе информацию о установленной версии системы;
файл system_themes.csv содержит в себе информацию о всех имеющихся в системе темах оформления системы.

Подсказка

title	Логи

Архив диагностики содержит в себе в том числе и логи:

файл filtered_user.log с логами действий пользователей за последние сутки;
архив logs.zip с логами сервисов и коннекторов системы. Для каждого сервиса или коннектора локально выгружаются последние 100 Мбайт логов за последние сутки. В архиве находится файл-подсказка log_structure.txt, содержащий в себе полную структуру директории логов на сервере, в т.ч. архивы логов за последние сутки, не вошедшие в последние 100 Мбайт.

Scroll Title

title-alignment	center
title	Файл log_structure.txt

Детализация файлов диагностики

Каждый файл архива диагностики содержит структурированную информацию в форматах CSV, JSON или .log. Структура каждого из файлов приведена ниже.

/configs/

Файлы в директории /configs/ имеют названия типа <SERVICE_NAME>_conf.json, где <SERVICE_NAME> - имя сервиса, к которому относится файл конфигурации.

Каждый файл конфигурации содержит параметры, соответствующие сервису, как описано в разделе Параметры конфигурации.

Записи о параметрах имеют следующий формат:

Блок кода

language	java
title	Пример. Конфигурация сервиса Logstash
collapse	true

{
    "Id": 23,
    "PipelineConfigPath": "/etc/polymatica/platform/service/logstash/pipeline-config.json",
    "Log": {
        "Lvl": 4,
        "Path": "/tmp/POLYMATICA_LOGSTASH.log",
        "WithResponse": false
    },
    "Http": {
        "Host": "0.0.0.0",
        "Port": 9607,
        "MaxHeaderSize": 0,
        "ReadTimeout": 0,
        "WriteTimeout": 0
    },
    "Database": {
        "MaxOpenedConnections": 100,
        "MaxIdleConnections": 100
    },
    "Module": {
        "BackUrl": "http://logstash:9607"
    },
    "RabbitMQ": {
        "User": "polymatica",
        "Host": "rabbitmq",
        "Port": "5672",
        "VHost": "polymatica"
    },
    "Repository": {
        "Path": "/usr/share/polymatica/platform/logstash"
    },
    "Discovery": {
        "Url": "http://discovery:9610"
    }
}

columns.csv

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

dataset_id - идентификатор датасета, в котором создана расчетная колонка;
column_id - идентификатор расчетной колонки;
name - имя расчетной колонки;
source_name - название источника данных;
type - тип данных расчетной колонки;
base_type - тип данных расчетной колонки в БД;
has_index - имеет ли расчетная колонка индекс в БД;
order - порядок сортировки данных в расчетной колонке;
format - массив настроек форматирования расчетной колонки;
create_date - дата и время создания колонки;
update_date - дата и время последнего обновления колонки;
calc_id - идентификатор расчета;
calc_create_date - дата и время создания расчета;
calc_update_date - дата и время последнего произведения расчета;
calc_formula - формула расчета;
calc_save_result - записан или не записан расчет в датасет;
calc_error - ошибка расчета;
variable_details - переменные, используемые в расчете.

Подробнее о расчетных колонках см. PDTNUG → Датасеты → Настройка датасета → Добавление расчетной колонки.

Подробнее о массиве настроек форматирования колонки см. PDTNUG → Датасеты → Настройка датасета → Настройки колонки.

components.csv

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

id - идентификатор компонента;
name - название компонента;
create_date - дата и время создания компонента;
update_date - дата и время последнего обновления компонента;
version - версия компонента;
dependencies - количество виджетов, построенных на компоненте;
default_component - является ли компонент системным;
default_component_ref - ссылка на место хранения системного компонента на сервере;
file_name - имя файла архива с компонентом.

Подробнее о компонентах см. PDTNUG → Компоненты.

Подробнее о загрузке компонентов см. PDTNUG → Добавление пользовательского компонента.

connectors.csv

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

name - наименование коннектора;
system_name - служебное наименование коннектора;
version - версия коннектора;
status - подключен или не подключен.

Подробнее о коннекторах см. PDTNUG → Коннекторы.

datasets.csv

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

id - идентификатор датасета;
name - название датасета;
state - done/error (успешно загружен/ошибка загрузки);
error_message - сообщение об ошибке загрузки (только если state = error);
dataset_type - local/joined (локальный/объединенный);
source_name - имя источника, на котором построен датасет;
connector_name - служебное имя коннектора, используемого для подключения к источнику;
rows_count - количество строк;
cols_count - количество столбцов;
create_date - дата и время создания датасета;
update_date - дата и время последнего обновления датасета;
last_update_data - дата и время последнего изменения структуры данных датасета;
start_update_date - дата и время начала последнего автообновления датасета, если включено в настройках;
common_params - массив общих настроек датасета;
join_params - массив параметров объединения (только для объединенных датасетов);
scheduler_params - массив параметров регулярного автообновления датасета, если включено в настройках.

Подробнее о датасетах см. PDTNUG → Датасеты.

Подробнее о локальных и объединенных датасетах см. PDTNUG → Датасеты → Создание датасета.

Подробнее о настройках датасета см. PDTNUG → Датасеты → Настройки датасета.

environment.json

Файл с описанием системного окружения имеет следующий формат:

Блок кода

language	java
title	Пример файла с описанием системного окружения
collapse	true

{
    "Browser": {
        "Name": "Chrome",
        "Version": "140.0.0.0"
    },
    "OS": {
        "FullName": "Debian GNU/Linux 12 (bookworm)"
    },
    "CPU": {
        "Name": "Intel(R) Xeon(R) CPU E5-2697 v4 @ 2.30GHz",
        "Arch": "amd64",
        "Cores": 8
    },
    "MemoryGB": {
        "RAMTotal": 16.77,
        "RAMFree": 0.16,
        "SwapTotal": 0,
        "SwapFree": 0
    },
    "DiskGB": {
        "Total": 315.93,
        "Free": 148.57
    }
}

Подробнее о требованиях к системному окружению см. Требования.

filters.csv

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

filter_id - идентификатор фильтра;
attributes_info - название ключа/ключей фильтра;
filter_name - имя фильтра;
has_default_value - установлено ли в фильтре значение по умолчанию;
filter_default_value - установленное значение по умолчанию;
create_date - дата и время создания фильтра;
update_date - дата и время последнего обновления фильтра;
dataset_id - идентификатор датасета, на котором построен фильтр;
dataset_name - имя датасета, на котором построен фильтр;
suggest_local_filter - условие расширенной фильтрации предлагаемых значений в фильтре;
columns_info - информация о колонках датасета, на которых построен фильтр;
custom_filter_select - массив кастомных предлагаемых значений в фильтре.

Подробнее о фильтрах см. PDTNUG → Фильтры.

Подробнее о настройках фильтра см. PDTNUG → Фильтры → Настройка фильтра.

Подробнее о расширенной фильтрации см. PDTNUG → Виджеты → Работа с расширенным фильтром.

license_info.json

Файл с информацией о лицензии имеет следующий формат:

Блок кода

language	java
title	Пример файла с информацией о лицензии
collapse	true

{
    "unlimited_users": false, // количество пользователей ограничено
    "users_count": 150, // разрешенное количество пользователей 
    "unlimited_expire_date": false, // срок действия лицензии ограничен 
    "current_user_count": 80, //текущее количество пользователей 
    "activation_code": "/PviKxUe...ncnyw==\n" //код активации лицензии
  }
}

Подробнее о лицензии см. Лицензирование.

migrations.csv

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

database - имя базы данных;
rank - порядок применения миграционного скрипта;
type - тип базы данных (baseline/versioned);
version - версия базы данных;
description - описание произведенного действия в порядке миграции;
registered_on - дата и время начала миграции;
executed_on - дата и время окончания миграции;
state - статус выполнения миграции (success/registered/error).

Подробнее о базах данных см. Список баз данных.

modules.csv

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

name - наименование сервиса;
version - версия сервиса;
status - подключен/не подключен (true/false);
connect_date - дата и время подключения.

Подробнее о сервисах см. PDTNUG → Модули.

project_themes.csv

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

id - идентификатор темы;
create_date - дата и время создания темы;
update_date - дата и время последнего обновления темы;
name_desc - наименование темы;
description - описание темы;
css - код CSS, применяемый в теме;
js - код JavaScrp, применяемый в теме.

Подробнее о темах оформления см. PDTNUG → Темы.

projects.csv

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

project_id - идентификатор проекта;
project_name - название проекта;
project_desc - описание проекта;
project_create_date - дата и время создания проекта;
project_update_date - дата и время последнего обновления проекта;
layer_id - идентификатор слоя проекта;
layer_name - имя слоя проекта;
layer_create_date - дата и время создания слоя проекта;
layer_update_date - дата и время последнего обновления слоя проекта;
element_id - идентификатор элемента проекта;
element_type - тип элемента:
- widget - виджет;
- svg - SVG-объект;
- text - текст или HTML-объект;
- image - изображение;
- video - видео;
- link - ссылка;
- grouping - группа элементов;
- filter - фильтр;
- group - группа элементов, созданная в версии ниже 1.31.0;
- table - таблица, созданная в версии ниже 1.22.0;
element_name - название элемента;
element_desc - описание элемента;
element_content - содержимое текстового или HTML-элемента;
element_payload - массив настроек элемента;
element_create_date - дата создания элемента;
element_update_date - дата последнего обновления элемента;
widget_data_options - массив настроек данных виджета;
widget_view_options - массив настроек визуализации виджета;
component_id - идентификатор компонента виджета;
component_name - название компонента виджета;
is_default_component - является ли компонент виджета системным;
custom_theme_id - идентификатор пользовательской темы проекта;
custom_theme_name - название пользовательской темы проекта.

Подробнее о проектах, их слоях и элементах см. PDTNUG → Проекты.

release_version.json

Файл с информацией о версии системы имеет следующий формат:

Блок кода

language	java
title	Информация о версии системы
collapse	true

{
    "release_version": "1.35.0"
}

system_themes.csv

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

id - идентификатор темы;
create_date - дата и время создания темы;
update_date - дата и время последнего обновления темы;
name_desc - название темы;
css - использующийся в теме код CSS;
js - использующийся в теме код JavaScript;
icon - путь к файлу иконки окна браузера;
logo - путь к файлу логотипа.

Подробнее о темах оформления системы см. PDTNUG → Оформление.

filtered_user.log и logs.zip

Детализация файла filtered_user.log и содержимое директории хранения логов подробно описано в разделе Логирование.

Easy Heading Macro

hiddenEditedFlag	true
headingIndent	0
expandOption	disable-expand-collapse
navigationTitle	На этой странице
wrapNavigationText	true
navigationExpandOption	expand-all-by-default

Быстрые ссылки

Дерево страниц

Сравнение версий

Старая версия 1

Новая версия Текущий

Ключ

Общие сведения

Получение файлов диагностики через интерфейс приложения

Структура архива диагностики

Детализация файлов диагностики

/configs/

columns.csv

components.csv

connectors.csv

datasets.csv

environment.json

filters.csv

license_info.json

migrations.csv

modules.csv

project_themes.csv

projects.csv

release_version.json

system_themes.csv

filtered_user.log и logs.zip

Быстрые ссылки

Дерево страниц

История страницы

Сравнение версий

Старая версия 1

Новая версия Текущий

Ключ

Общие сведения

Получение файлов диагностики через интерфейс приложения

Структура архива диагностики

Детализация файлов диагностики

/configs/

columns.csv

components.csv

connectors.csv

datasets.csv

environment.json

filters.csv

license_info.json

migrations.csv

modules.csv

project_themes.csv

projects.csv

release_version.json

system_themes.csv

filtered_user.log и logs.zip