Системные таблицы
В этой статье
- Системные таблицы
- Связи системных таблиц
- Таблица «access_role»
- Таблица «access_role_privilege»
- Таблица «ad_attribute»
- Таблица «automation_block_execution_history»
- Таблица «dashboard»
- Таблица «dashboard_access»
- Таблица «department»
- Таблица «employee»
- Таблица «employee_account»
- Таблица «employee_ad_group»
- Таблица «employee_favourite_workspace»
- Таблица «employee_workspace_access»
- Таблица «employee_workspace_main_page_group»
- Таблица «employee_license_role_log»
- Таблица «link_workspace_employee»
- Таблица «monitoring_screenshot»
- Таблица «monitoring_employee_log_type»
- Таблица «resource_monitor»
- Таблица «script_event_history»
- Таблица «script_execution»
- Таблица «system_event»
- Таблица «tag»
- Таблица «workspace»
- Таблица «workspace_database»
- Таблица «workspace_folder»
- Таблица «workspace_tag»
Система предоставляет возможность получать актуальную информацию о пользователях, правах доступа, дашбордах, скриптах и других элементах. Необходимые данные можно извлечь и передать в ClickHouse с помощью блока автоматизации Получить системную таблицу.
Ниже представлено описание системных таблиц, а также их полей, которые могут быть получены с использованием этого блока.
Важно
- При создании новой таблицы из выходных данных блока Получить системную таблицу рекомендуется указывать в колонке Тип данных соответствующий тип ClickHouse.
- Выбор подходящего типа данных для числовых значений поля
idзависит от размера добавляемой таблицы. В большинстве случаев предпочтительными являются типы Int64/UInt64, но вы можете выбрать нужный тип из следующих вариантов: UInt32, UInt64, UInt128, UInt256, Int64, Int128 или Int256. Рекомендуется указать тот тип данных, который соответствует вашим требованиям. Ознакомиться с описанием этих типов вы можете на официальном сайте ClickHouse. - Тип данных ClickHouse Array(Тип) не может быть Nullable. При вводе типа колонки Array(Тип), снимите галочку у опции Null в соответствующих полях.
Связи системных таблиц
Представленная ниже схема поможет понять, каким образом системные таблицы Proceset связаны между собой.
На схеме отображены:
- Все основные системные таблицы Proceset
- Первичные и внешние ключи системных таблиц
- Связи между таблицами
Таблица «access_role»
В таблицу собирается информация о ролях доступа.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор роли доступа |
is_admin | Bool | Роль «Прикладной администратор» |
name | String | Имя роли доступа |
Таблица «access_role_privilege»
В таблицу собирается информация о привилегиях ролей доступа.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор привилегии |
access_role_id | Integer | Идентификатор роли доступа |
is_create | Bool | Операция Create |
is_delete | Bool | Операция Delete |
is_execute | Bool | Операция Execute |
is_read | Bool | Операция Read |
is_write | Bool | Операция Write |
name_ru | String | Имя привилегии |
name | String | Код привилегии с указанием модуля |
Таблица «ad_attribute»
В таблицу собираются сведения о синхронизируемых атрибутах.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор значения атрибута |
additional_field_name | String | Название дополнительного поля |
attribute_name | String | Название атрибута |
data_type | String | Тип данных |
employee_id | Integer | Идентификатор пользователя, к которому относится значение атрибута |
index | Integer | Индекс, если атрибут хранит массив значений |
is_long_value_null | Bool | Пустое или числовое значение |
is_string_value_null | Bool | Пустое или строковое значение |
long_value | Integer | Числовое значение |
string_value | String | Строковое значение |
Таблица «automation_block_execution_history»
В таблицу собирается информация об использовании блоков автоматизации.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор записи |
activator_name | String | ФИО пользователя / Имя ключа API |
api_key_id | Integer | Идентификатор ключа API, который запускает скрипт |
block_error | String | Сообщение об ошибке, возникшей при выполнении блока |
block_id | Integer | Идентификатор блока |
block_name | String | Название блока |
block_type | String | Тип блока |
count_output_data | Integer | Количество выходных данных |
duration_execution | Integer | Длительность выполнения скрипта |
employee_id | Integer | Идентификатор пользователя |
execution_type | String | Тип выполнения: - Тестирование - Активация |
input_data | String | Входные параметры блока в формате JSON |
script_general_id | Integer | Идентификатор скрипта, в котором расположен блок |
start_execution | DateTime | Начало запуска блока |
Таблица «dashboard»
В таблицу собирается информация о дашбордах.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор записи |
dashboard_author_id | Integer | Идентификатор автора дашборда |
dashboard_creation_time | DateTime DateTime64 | Время создания дашборда |
dashboard_name | String | Наименование дашборда |
guid | String | guid дашборда |
workspace_id | Integer | Идентификатор пространства |
Таблица «dashboard_access»
В таблицу собирается информация о доступах к отчетам.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор записи |
dashboard_id | Integer | Идентификатор дашборда |
employee_id | Integer | Идентификатор пользователя |
operation | String | Операции доступа (Read/Write) |
Таблица «department»
В таблицу собирается информация об отделах.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор отдела |
name | String | Название отдела |
parent_department_id | Integer | Идентификатор родительского отдела |
parent_department_ids | Array(Int64) | Массив идентификаторов родительских отделов |
Таблица «employee»
В таблицу собирается информация о пользователях.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор пользователя (также ключ сортировки) |
access_role_ids | Array(Int64) | Массив идентификаторов ролей доступа пользователя |
access_to_department_ids | Array(Int64) | Идентификаторы отделов, к которым у данного пользователя есть доступ |
access_to_employee_ids | Array(Int64) | Массив идентификаторов сотрудников, к которым у данного пользователя есть доступ |
additional_fields_names | Array(String) | Массив имен дополнительных полей пользователя |
additional_fields_values | Array(String) | Массив значений дополнительных полей пользователя |
all_employee_access | Bool | Наличие доступа ко всем пользователям |
authentication_assigned | Bool | Проверка возможности аутентификации у пользователя |
authentication_types_assigned | Array(String) | Массив аутентификаций пользователя |
department_ids | Array(Int64) | Массив идентификаторов отделов (корневой, промежуточный, конкретный отдел) |
departments | Array(String) | Массив наименований отделов (корневой, промежуточный, конкретный отдел) |
email | String | Электронная почта |
employee_account_domains | Array(String) | Список доменов всех аккаунтов пользователя (пустая строка, если нет) |
employee_account_ids | Array(Int64) | Массив идентификаторов источников активности |
employee_account_logins | Array(String) | Список логинов всех аккаунтов пользователя (пустая строка, если нет) |
first_name | String | Имя |
license_roles | Array(String) | Лицензии, назначенные пользователю |
login | String | Логин |
monitoring_type | String | Сбор активности для конкретного пользователя (DISABLED/SIMPLE/EXTENDED) |
name | String | Полное отображаемое имя |
patronymic | String | Отчество |
personnel_number | String | Табельный номер |
phones | Array(String) | Телефон пользователя |
second_name | String | Фамилия |
Таблица «employee_account»
В таблицу собирается информация об аккаунтах пользователей.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор аккаунта |
employee_id | Integer | Идентификатор пользователя |
Таблица «employee_ad_group»
В таблицу собирается информация о группах пользователей в Active Directory.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор записи |
ad_account_distinguished_name | String | Путь до аккаунта AD |
ad_account_guid | String | guid аккаунта AD |
ad_account_id | Integer | Идентификатор аккаунта AD |
ad_group_canonical_name | String | Название группы AD в каноническом формате |
ad_group_distinguished_name | String | Путь до группы AD |
ad_group_guid | String | guid группы AD |
ad_group_id | Integer | Идентификатор группы AD |
ad_group_name | String | Название группы AD |
display_name | String | Отображаемое имя пользователя в системе |
employee_id | Integer | Идентификатор пользователя |
Таблица «employee_favourite_workspace»
В таблицу собирается информация о пространствах, добавленных в раздел Избранное.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор записи |
employee_id | Integer | Идентификатор сотрудника |
workspace_id | Integer | Идентификатор пространства |
Таблица «employee_workspace_access»
В таблицу собирается информация о доступах пользователя к дашбордам в пространстве.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор записи |
employee_id | Integer | Идентификатор пользователя |
operation | String | Операция доступа |
workspace_id | Integer | Идентификатор пространства |
Таблица «employee_workspace_main_page_group»
В таблицу собирается информация о пространствах, добавленных в закладки.
Важно
Запись в эту таблицу создается только, если в закладке есть хотя бы одно пространство. Пустые закладки не отображаются в системной таблице.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор записи |
employee_id | Integer | Идентификатор сотрудника |
main_page_group_id | Integer | Идентификатор закладки |
main_page_group_name | String | Имя закладки |
workspace_id | Integer | Идентификатор пространства |
Таблица «employee_license_role_log»
В таблицу собирается информация об изменении лицензионных ролей пользователей.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор записи |
api_key_description | String | Описание источника изменения (формат ID~message, где ID — идентификатор API-ключа, message — часть API-ключа) |
employee_description | String | Описание источника изменения (формат ID~message, где ID — идентификатор пользователя, message — display_name) |
employee_id | Integer | Идентификатор пользователя |
event_date | DateTime DateTime64 | Дата события изменения роли |
license_role | String | Лицензионная роль |
operation | String | Операция добавления или удаления лицензионной роли |
source_type | String | Тип инициатора изменения (сотрудник или ключ API) |
Таблица «link_workspace_employee»
В таблицу собирается информация о доступах пользователя в пространстве.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор объекта доступа |
employee_id | Integer | Идентификатор пользователя |
operation | String | Тип операции (Read/Write) |
workspace_id | Integer | Идентификатор рабочего пространства |
Таблица «monitoring_screenshot»
В таблицу собирается информация об исследованиях.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор исследования |
name | String | Название исследования |
start | DateTime | Дата начала исследования |
end | DateTime | Дата завершения исследования |
employees | Array(Int64) | Сотрудники, которые добавлены в исследование |
blur | Bool | Размытие |
status | String | Статус исследования |
Таблица «monitoring_employee_log_type»
В таблицу собирается информация о типе мониторинга пользователя, а также время и источник его изменения.
События, при которых происходит запись переключения значения мониторинга:
- При автоматическом создании нового пользователя в системе (интеграция из AD, поступление данных от агента) источником изменений будет SYSTEM. Значения будут установлены в DISABLED
- В случаях изменения типа мониторинга пользователем, администратором или через API будет указан источник изменения EMPLOYEE или API_KEY, прежнее значение до изменения и новое установленное значение
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор доменного объекта |
api_description | String | Описание источника изменения (формат ID~message, где ID — идентификатор api_key, message — api*****key) |
employee_description | String | Описание источника изменения (формат ID~message, где ID — идентификатор пользователя, message — display_name) |
employee_id | Integer | Идентификатор пользователя, которому изменили тип мониторинга |
event_date | DateTime DateTime64 | Дата переключения типов мониторинга |
event_source | String | Источник изменения типа мониторинга (SYSTEM, EMPLOYEE, API_KEY) |
new_value | String | Новое значение типа мониторинга |
old_value | String | Прежнее значение типа мониторинга |
Таблица «resource_monitor»
В таблицу собирается информация о нагрузке системы.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор монитора ресурсов (timestamp) |
node_id | String | Идентификатор ноды в кластере |
node_name | String | Имя ноды в кластере |
cpu | Float32 | Нагрузка на ЦПУ в момент запроса в процентах |
disk | Float32 | Используемое пространство на диске в момент запроса (в Мб) |
ram | Float32 | Используемая оперативная память в момент запроса (в Мб) |
Таблица «script_event_history»
В таблицу собирается информация о действиях пользователей со скриптами.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор записи |
api_key_id | Integer | Идентификатор ключа API, который запускает скрипт |
author_event_name | String | ФИО сотрудника или имя ключа API, который запускает скрипт |
employee_id | Integer | Идентификатор пользователя |
event_time | DateTime DateTime64 | Дата события |
event_type | String | Тип события: - Создание - Удаление - Публикация - Восстановление старой версии |
script_general_id | Integer | Идентификатор скрипта |
script_version | Integer | Версия скрипта |
Таблица «script_execution»
В таблицу собираются данные о выполнении скриптов за последние 24 часа.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор выполнения скрипта |
start_time | DateTime | Время начала выполнения скрипта |
duration | Integer | Длительность выполнения скрипта в миллисекундах |
workspace_id | Integer | Идентификатор пространства |
workspace_name | String | Имя пространства |
script_id | Integer | Идентификатор скрипта |
script_name | String | Имя скрипта |
script_version | Integer | Версия скрипта |
execution_status | String | Статус выполнения скрипта |
error | String | Ошибка |
node_name | String | Имя агента автоматизации, на котором был выполнен скрипт |
Таблица «system_event»
В таблицу собирается информация о системных событиях.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор записи |
event_type | String | Тип события, определяется соответствующим монитором |
level | Integer | Уровень оповещения. Соответствие значений в таблице: - 1 — CRITICAL - 2 — ERROR - 3 — WARNING - 4 — INFO |
message | String | Сообщение, генерируемое монитором, как реакция на наступление события |
subsystem_uuid | String | Уникальный идентификатор модуля |
time | DateTime DateTime64 | Время, когда произошло событие |
ttl | Integer | Период отображения события в миллисекундах |
Таблица «tag»
В таблицу собирается информация о тегах.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор записи |
read_only | Bool | Параметр, отвечающий за возможность редактирования тега |
colour | String | Цвет тега |
name | String | Название тега |
Таблица «workspace»
В таблицу собирается информация о пространствах.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор пространства |
name | String | Имя пространства |
description | String | Описание |
folder_id | Integer | Идентификатор папки, в которой находится пространство |
is_in_waste_bin | Bool | Индикатор наличия пространства в корзине |
Таблица «workspace_database»
В таблицу собирается информация о базах данных пространств.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор записи |
database_name | String | Имя базы данных |
storage_guid | String | Идентификатор хранилища данных |
workspace_id | Integer | Идентификатор пространства |
Таблица «workspace_folder»
В таблицу собирается информация о папках WorkspaceFolder.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор папки |
name | String | Имя папки |
parent_id | Integer | Идентификатор родительской папки |
Таблица «workspace_tag»
В таблицу собирается информация о тегах и пространствах, которым они назначены.
| Поле в поставщике данных | Рекомендуемый тип ClickHouse | Описание |
|---|---|---|
id | Integer | Идентификатор записи |
tag_id | Integer | Идентификатор тега |
workspace_id | Integer | Идентификатор пространства |
Была ли статья полезна?
Да
Нет