Перейти к содержанию

Настройка логирования

Для корректной работы аудита и логирования событий в системе TeamStorm необходимо настроить параметры логирования. Это можно сделать через файл .env (для Docker-установки) или через значения Helm-чарта (для Kubernetes).

Доступные способы логирования

В TeamStorm доступны следующие способы логирования:

  1. Логирование в стандартный вывод
    Логи аудита выводятся непосредственно в стандартный вывод контейнера сервиса cwm_public_gateway_api.

  2. Логирование в файл
    Логи аудита сохраняются в файл внутри контейнера сервиса cwm_public_gateway_api по пути /app/Logs/<имя сервиса>.log

  3. Логирование на внешний syslog-сервер
    Логи отправляются на внешний сервер по протоколу Syslog (UDP/TCP) для централизованного хранения и анализа событий (например, с помощью rsyslog, Graylog, ELK и др.).

Примечание

Перечень логируемых сервисами событий описан в разделе ниже

Настройка логирования через .env

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

Настройка способов логирования

В файле .env доступны следующие параметры для управления логированием:

  • LOGGING_CONSOLE_ENABLE — включает/отключает логирование в стандартный вывод (true/false)
  • LOGGING_FILE_ENABLE — включает/отключает логирование в файл (true/false)
  • LOGGING_SYSLOG_ENABLE — включает/отключает отправку логов на syslog-сервер (true/false)

Включение логирования в стандартный вывод

Для включения логирования в стандартный вывод установите значение true в LOGGING_CONSOLE_ENABLE 

    LOGGING_CONSOLE_ENABLE="true"

Включение логирования в файл

Для включения логирования в файл установите значение true в LOGGING_FILE_ENABLE 

    LOGGING_FILE_ENABLE="true"

Файлы логов хранятся в контейнерах соответствующих сервисов, как показано в таблице ниже.

Сервис / контейнер Лог-файл в контейнере
agent_service_api /app/Logs/ts_audit_agent_service_.log
attachment_service_api /app/Logs/ts_audit_tracker_gateway_.log
automation_service_api /app/Logs/ts_audit_tracker_gateway_.log
comment_service_api /app/Logs/ts_audit_tracker_gateway_.log
cwm_public_gateway_api /app/Logs/ts_audit_public_gateway_.log
git_integration_service_api /app/Logs/ts_audit_tracker_gateway_.log
history_service_api /app/Logs/ts_audit_tracker_gateway_.log
notificication_service_api /app/Logs/ts_audit_tracker_gateway_.log
notificication_service_hub /app/Logs/ts_audit_tracker_gateway_.log
template_service_api /app/Logs/ts_audit_template_service_.log
webhook_service_api /app/Logs/ts_audit_tracker_gateway_.log
wiki_service_api /app/Logs/ts_audit_wiki_service_.log
workitem_service_api /app/Logs/ts_audit_workitem_service_.log
workspace_service_api /app/Logs/ts_audit_workspace_service_.log

Включение логирования на внешний syslog-сервер

По умолчанию параметры для отправки логов в syslog-сервер закомментированы. Для активации логирования на внешний syslog-сервер выполните следующие шаги:

  1. Установите значение true в LOGGING_SYSLOG_ENABLE

  2. Найдите секцию [ Audit Logging ]:

    ## [ Section ] ="[ Audit Logging ]"
# LOGGING_SYSLOG_CONNECTION_TYPE="UdpSyslog"
# LOGGING_SYSLOG_HOST="my-rsyslog-server.company.ru"
# LOGGING_SYSLOG_PORT="514"
# LOGGING_SYSLOG_FORMAT="RFC5424"
# LOGGING_SYSLOG_FACILITY="LogAudit"
LOGGING_SYSLOG_ENABLE="true"

  3. Раскомментируйте строки, связанные с syslog, и укажите параметры вашего syslog-сервера:

    ## [ Section ] ="[ Audit Logging ]"
LOGGING_SYSLOG_CONNECTION_TYPE="UdpSyslog"
LOGGING_SYSLOG_HOST="syslog.example.com"         # Укажите адрес вашего syslog-сервера
LOGGING_SYSLOG_PORT="514"                        # Укажите порт (обычно 514)
LOGGING_SYSLOG_FORMAT="RFC5424"                  # Формат сообщений (обычно RFC5424)
LOGGING_SYSLOG_FACILITY="LogAudit"               # Facility для логов аудита
LOGGING_SYSLOG_ENABLE="true"                     # Включить отправку логов в syslog

Настройка логирования в Helm-чарте (Kubernetes)

Если вы используете TeamStorm в Kubernetes через Helm, параметры логирования настраиваются в файле values.yaml при установке/обновлении.

Пример блока настроек:

global:
  logging:
    syslogConnectionType: "UdpSyslog"
    syslogHost: "my-rsyslog-server.company.ru"
    syslogPort: "514"
    syslogFormat: "RFC5424"
    syslogFacility: "LogAudit"
    syslogEnable: "false"
    fileEnable: "false"
    consoleEnable: "true"

Логирумые события сервисов

agent_service_api

  • ИИ-агенты: AgentRegistrationCodeCreated, AgentRegistrationCodeSpent, AgentRegistrationCodeExpired, AgentRegistrationRequested, AgentRegistrationAccepted, AgentRegistrationRejected, AgentRegistrationAutoRejected, AgentParametersChangedByAdmin, AgentParametersChangedViaTelemetry, AgentDeletedByAdmin

attachment_service_api

  • Вложения: AttachmentCreated, AttachmentDeleted, AttachmentsDeleted, AttachmentFileSizeExceedMaximum, UserAttemptToUploadFileWithNotAllowedExtension, UserAttemptToUploadFileWithInvalidSignature.

  • Настройки вложений: MaxAttachmentFileSizeUpdated, FileExtensionsSettingsCreated, FileExtensionsSettingsUpdated, FileExtensionsSettingsDeleted, CheckSignaturesSettingsEnabled, CheckSignaturesSettingsDisabled, AllowUploadWithoutExtensionEnabled, AllowUploadWithoutExtensionDisabled.

  • Антивирус: AntivirusSettingsAdded, AntivirusSettingsUpdated, FileDownloadBlockedByAntivirus

automation_service_api

  • Правила автоматизации: AutomationRuleCreated, AutomationRuleUpdated, AutomationRuleDeleted.

  • Скрипты: AutomationScriptChecked, AutomationScriptCreated, AutomationScriptUpdated, AutomationScriptPatched, AutomationScriptDeleted, AutomationScriptTokenChanged, AutomationScriptTokenRetrieved

comment_service_api

  • Комментарии к задачам и страницам: WorkitemCommentAdded, WorkitemCommentUpdated, WorkitemCommentDeleted, DocumentCommentAdded, DocumentCommentUpdated, DocumentCommentDeleted, CommentVisibilitySettingsUpdated.

cwm_public_gateway_api

Обрабатываются события, произошедшие в результате обращения к публичному REST API.

git_integration_service_api

Интеграция с Git: GitIntegrationDetailsRequested, GitIntegrationTokenCreated, GitIntegrationTokenUpdated, GitIntegrationTokenRevoked.

history_service_api

Своих событий у сервиса нет. В логи могут быть записаны только кросс-сервисные события.

notificication_service_api

Своих событий у сервиса нет. В логи могут быть записаны только кросс-сервисные события.

notificication_service_hub

Своих событий у сервиса нет. В логи могут быть записаны только кросс-сервисные события.

template_service_api

Своих событий у сервиса нет. В логи могут быть записаны только кросс-сервисные события.

webhook_service_api

  • Вебхуки: WebhookCreated, WebhookUpdated, WebhookDeleted.

wiki_service_api

  • Документы / версии: DocumentAccessed, DocumentCreated, DocumentUpdated, DocumentDeleted, DocumentVersionDeleted, DocumentVersionRestored, DocumentExported, WorkspaceDocumentsExported, DocumentStatusUpdated, DocumentBlocked, DocumentUnblocked, DocumentSegmentAccessed.

  • Черновики: DocumentDraftAccessed, DocumentDraftCreated, DocumentDraftUpdated, DocumentDraftPublished, DocumentDraftDeleted.

  • Инлайн-комментарии: DocumentInlineCommentAdded, DocumentInlineCommentUpdated, DocumentInlineCommentDeleted, DocumentInlineCommentStatusChanged.

  • Списки страниц: DocumentListsAccessedByParent, DocumentListAccessed, DocumentListCreated, DocumentListUpdated, DocumentListDeleted.

  • Избранное: DocumentFavoriteCreated, DocumentFavoriteDeleted.

  • Общий доступ: DocumentSharedPermissionAdded, DocumentSharedPermissionUpdated, DocumentSharedPermissionDeleted.

  • Связи с задачами: DocumentLinkedToWorkitem, DocumentUnlinkedFromWorkitem.

workitem_service_api

  • Задачи: WorkitemAccessed, WorkitemCreated, WorkitemUpdated, WorkitemDeleted, WorkitemsExportExecuted, WorkitemsGlobalExportExecuted, WorkitemRankUpdatedInQueue, WorkitemRankUpdatedOnBoard, WorkitemRankUpdatedInPortfolioElement, WorkitemRankUpdatedOnCustomView, WorkitemLinkedToDocument, WorkitemUnlinkedFromDocument, WorkitemLinkedToWorkitem.

  • Типы / атрибуты / статусы: WorkitemTypeCreated, WorkitemTypeUpdated, WorkitemTypeDeleted, WorkitemStatusCreated, AttributeCreated, AttributeUpdated, AttributeDeleted, WorkitemAttributeOptionAdded.

  • Правила связей: WorkitemLinkRuleCreated, WorkitemLinkRuleUpdated, WorkitemLinkRuleDeleted.

  • Заявки: TicketTypeCreated, TicketTypeUpdated, TicketTypeDeleted, TicketCreated.

  • Общие права / роли пространства: WorkspaceRoleCreated, WorkspaceRoleUpdated, WorkspaceRoleDeleted, WorkspaceAccessGranted, WorkspaceAccessRevoked, WorkspaceUserRoleChanged, WorkspaceGroupAccessGranted, WorkspaceGroupAccessRevoked, WorkspaceGroupUserRoleChanged.

  • Папки / Agile / спринты: FolderCreated, FolderUpdated, FolderDeleted, AgileExtensionCreated, AgileExtensionDeleted, SprintCreated, SprintUpdated, SprintDeleted, SprintStarted, SprintCompleted.

  • Портфолио: PortfolioCreated, PortfolioUpdated, PortfolioDeleted, PortfolioElementCreated, PortfolioElementUpdated, PortfolioElementDeleted.

  • Рабочие процессы: WorkflowCreated, WorkflowUpdated, WorkflowDeleted.

  • Запросы и представления: WorkitemsQueryCreated, WorkitemsQueryUpdated, WorkitemsQueryDeleted, WorkitemsQueryAccessed, CustomViewCreated, CustomViewUpdated, CustomViewDeleted.

  • Дашборды: DashboardAccessed, DashboardCreated, DashboardUpdated, DashboardDeleted, DashboardWidgetCreated, DashboardWidgetUpdated, DashboardWidgetDeleted, DashboardSharedPermissionAdded, DashboardSharedPermissionUpdated, DashboardSharedPermissionDeleted.

  • Массовые операции: BulkOperationStarted, BulkOperationCompleted, BulkOperationFailed.

  • Общий доступ к задачам: WorkitemSharedPermissionAdded, WorkitemSharedPermissionUpdated, WorkitemSharedPermissionDeleted.

  • Время / календари: TimeTrackingExportExecuted, TimeTrackingEntryTypeCreated, TimeTrackingEntryTypeUpdated, WorkCalendarCreated, WorkCalendarUpdated, WorkCalendarDeleted, WorkitemTimeMetricTemplateCreated, WorkitemTimeMetricTemplateUpdated, WorkitemTimeMetricTemplateDeleted.

workspace_service_api

  • Пользователи и аутентификация: UserCreated, UserUpdated, UserDeleted, UserBlocked, UserUnblocked, UserRolesUpdated, UserGroupsUpdated, UserLoggedIn, UserLoggedOut, UserFailedToLogIn, UserFailedToLogInWrongPassword, UserFailedToLogInExpiredPassword, BlockedUserFailedToLogIn, UserPasswordChanged, UserPasswordUpdateFailed.

  • Группы: GroupCreated, GroupDeleted, GroupRolesUpdated, GroupUsersUpdated.

  • Провайдеры аутентификации: AuthProviderCreated, AuthProviderUpdated, AuthProviderDeleted.

  • 2FA: TwoFactorAuthenticationEnabled, TwoFactorAuthenticationDisabled, TwoFactorCodeVerified, TwoFactorCodeNotVerified, TwoFactorReset.

  • Прочее: LicenseUploaded, PrivateTokenGenerated, ApplicationLinkCreated, ApplicationLinkUpdated, ApplicationLinkDeleted, WorkspaceCreated, WorkspaceUpdated, WorkspaceDeleted.