Категория | Описание | Примеры | Ключи категорий и ключи сообщений | ||
---|---|---|---|---|---|
ANALYTICS | Действия, относящиеся к сущностям аналитики. Операции, выполняемые ThingWorx Analytics. | Операции создания, правки и удаления в определениях анализа данных. Другие действия в ThingWorx Analytics. | Ключ категории: audit.AuditCategory.Analytics | ||
AUDIT | Для внутреннего использования подсистемы аудита. | По умолчанию включено. Включает отслеживание выполнения сервиса аудита, поскольку в нем потенциально могут содержаться конфиденциальные данные. Сообщение аудита возвращает USERNAME для выполняющего сервис. По умолчанию аудит выполняется для следующих сервисов: • ArchiveAuditHistory • ArchiveAuditHistoryDirectPersistence • PurgeAuditData • ExportAuditData • ExportOnlineAuditData • CleanUpOfflineAudit По умолчанию аудит не выполняется для следующих сервисов: • QueryAuditHistory • QueryAuditHistoryWithQueryCriteria • QueryAuditHistoryContextConstrained • GetAuditEntryCount | Ключ категории: audit.AuditCategory.Audit Ключи сообщений: • audit.Audit.ExecutedService.ArchiveAuditHistory • audit.Audit.ExecutedService.ArchiveAuditHistoryDirectPersistence • audit.Audit.ExecutedService.PurgeAuditData • audit.Audit.ExecutedService.ExportAuditData • audit.Audit.ExecutedService.ExportOnlineAuditData • audit.Audit.ExecutedService.CleanUpOfflineAudit • audit.Audit.ExecutedService.Query AuditHistory • audit.Audit.ExecutedService.GetAuditEntryCount | ||
AUTHENTICATION | Действия, относящиеся к аутентификации. | • Успешный или неудачный вход пользователя в систему, выход пользователя и ошибки, связанные с использованием ключей приложений. Например: Login successful for user: Administrator • Запись Logout позволяет отслеживать действия выхода пользователя из системы. Эта запись генерируется для инициированного пользователем выхода из ThingWorx Composer. Имя пользователя включается в сообщение аудита. • Запись LoginSucceeded включает отслеживание успешных действий входа пользователя. Имя пользователя включается в сообщение аудита. • Запись LoginFailed включает отслеживание сбоев действий при входе пользователя в систему. Имя пользователя включается в сообщение аудита. • Запись ApplicationKeySucceeded включает отслеживание успешной аутентификации с ключом приложения. Имя пользователя включается в сообщение аудита. • Запись ApplicationKeyFailed включает отслеживание сбоев аутентификации с ключом приложения. Имя пользователя включается в сообщение аудита. | Ключ категории: audit.AuditCategory.Authentication Ключи сообщений • com.thingworx.things.security.SecurityMonitorThing.Logout.Audit • com.thingworx.things.security.SecurityMonitorThing.LoginSucceeded.Audit • com.thingworx.things.security.SecurityMonitorThing.LoginFailed.Audit • com.thingworx.things.security.SecurityMonitorThing.ApplicationKeySucceeded.Audit • com.thingworx.things.security.SecurityMonitorThing.ApplicationKeyFailed.Audit | ||
COLLABORATION | Действия, относящиеся к сущностям совместной работы. | Операции создания, правки и удаления в блогах и вики. | Ключ категории: audit.AuditCategory.Collaboration | ||
DATA_MANAGEMENT | Действия, связанные с управлением или использованием данных. | Операции удаления данных. | Ключ категории: audit.AuditCategory.DataManagement | ||
DATA_STORAGE | Действия, относящиеся к сущностям хранилищ данных и соответствующим подсистемам. | Операции создания, правки и удаления в таблицах данных, потоках и других сущностях хранения данных. | Ключ категории: audit.AuditCategory.DataStorage | ||
DEVICE_COMMUNICATION | Действие, используемое при взаимодействии с устройствами Edge. | Сервис CloseWebSocketSessions в WSCommunicationSubsystem подлежит аудиту. Дополнительные сведения о сервисе см. в подразделе "Сервисы" раздела "Подсистема WebSocketCommunications".
| Ключ категории: audit.AuditCategory.DeviceCommunication | ||
FILE_TRANSFER | Действия и события, относящиеся к выгрузке и загрузке файлов. | Успешное завершение переноса, отмена переноса и генерация ошибок для операции переноса файлов. | Ключ категории: audit.AuditCategory.FileTransfer | ||
IMPORT_EXPORT | Действия, относящиеся к импорту и экспорту данных в ThingWorx. | Модель и операции импорта/экспорта данных. Импорт расширения. | Ключ категории: audit.AuditCategory.ImportExport | ||
LIFECYCLE | Действия, относящиеся к специфичным для вещи событиям, таким как ThingEnable. | События, такие как ThingEnable и ThingDisable, генерируются при вызове соответствующих сервисов для вещи. Аудит событий ThingStart по умолчанию отключен из-за загрузки при запуске и перезапуске ThingWorx Platform. | Ключ категории: audit.AuditCategory.Lifecycle Ключи сообщений: • com.thingworx.things.Thing.ThingStart.Audit • audit.EntityLifecycle.Enable • audit.EntityLifecycle.Disable | ||
Операции создания и удаления, связанные со всеми сущностями, включая группы вещей | Операции с аудитом и сообщения аудита: • Пользователь X создал новую группу вещей Y - сообщение аудита "тип" "наименование" создано. • Пользователь X удалил группу вещей Y - сообщение аудита "Тип "наименование" удален. • Пользователь X удалил все дочерние элементы группы вещей Y - сообщение аудита "Удалены все дочерние элементы тип наименование". | Ключ категории: audit.LifeCycle Ключи сообщений: • audit.LifeCycle.Created • audit.LifeCycle.Deleted • audit.LifeCycle.DeletedAll | |||
THINGGROUPMEMBERSHIPS | Операции добавления, относящиеся к участию в группе вещей | Операции с аудитом и сообщения аудита: • Пользователь X добавил вещь 123 как дочерний элемент группы вещей Y - сообщение аудита: "Вещь наименование вещи добавлена в качестве дочернего элемента ThingGroup имя группы вещей". • Пользователь X добавил группу вещей ABC как дочерний элемент группы вещей Y - сообщение аудита: "Группа ThingGroup наименование группы вещей 1 добавлена в качестве дочернего элемента ThingGroup имя группы вещей 2. | Ключ категории: audit.ThingGroupMemberships Ключи сообщений: • com.thingworx.thinggroups.ThingGroup.AddedThingAsChildMember • com.thingworx.thinggroups.ThingGroup.AddedThingGroupAsChildMember | ||
Операции удаления, относящиеся к участию в группе вещей | Операции с аудитом и сообщения аудита: • Пользователь X удалил вещь 123 как дочерний элемент группы вещей Y - сообщение аудита: "Удалена вещь наименование вещи как дочерний элемент группы вещей имя группы вещей". • Пользователь X удалил группу вещей ABC как дочерний элемент группы вещей Y - сообщение аудита: "Удалена группа вещей наименование группы вещей 1 как дочерний элемент группы вещей имя группы вещей 2". • Пользователь X удалил все дочерние элементы (вещи и/или группы вещей) из группы вещей Y - сообщение аудита "Удалены все дочерние элементы группы вещей имя группы вещей". | Ключ категории: audit.ThingGroupMemberships Ключи сообщений: • com.thingworx.thinggroups.ThingGroup.DeletedThingAsChildMember • com.thingworx.thinggroups.ThingGroup.DeletedThingGroupAsChildMember • com.thingworx.thinggroups.ThingGroup.DeletedAllChildMembers | |||
MODELING | Действия, относящиеся к сущностям моделирования. При создании сущности генерируется сообщение аудита, которое содержит сведения о владельце, назначенном новой сущности. Имейте в виду, что владельцу сущности автоматически присваивается имя пользователя, создавшего сущность. Система генерирует сообщение аудита при использовании любого из способов создания сущности: • посредством вызова PUT в Composer; • посредством вызова API-интерфейса Create, API-интерфейса Clone или API-интерфейса SetOwner. Любой пользователь, авторизованный для просмотра подсистемы аудита, может просматривать отчеты об изменениях владения. | Операции создания, правки и удаления на вещах, шаблонах вещи, профилях вещи, структурах данных, сетях, проектах, моделях и тегах. Сообщение аудита имеет следующий формат: "Created <Source Type> <Source> with owner <username of owner>." Здесь: • Source Type - вид созданной сущности. Например, "Вещь". • Source - наименование новой сущности. • Поле owner содержит username пользователя, выполняющего действие создания. | Ключ категории: audit.AuditCategory.Modeling Ключ сообщения: audit.EntityLifecycle.Create. | ||
REMOTE_ACCESS | Действия, относящиеся к удаленному доступу (туннелирование). | • Запуск сессии пользователя - сообщение аудита содержит идентификатор пользователя и время начала сессии. • Остановка сессии пользователя - сообщение аудита включает идентификатор пользователя, время окончания и общее время сессии. | Ключ категории: audit.AuditCategory.RemoteAccess | ||
SCM (управление содержимым программного обеспечения) | Действия, относящиеся к пакетам, развертыванию и изменениям конфигурации. | Создание, правка, публикация и удаление пакетов. Создание, запуск, перенос и удаление развертывания. Включает тестирование и фактическое развертывание, активы, указанные для тестового развертывания, и успешные или неудачные операции установки пакетов. Изменения конфигурации для автоматической очистки и для параллельного развертывания. Информация о развертывании пакетов включает идентификатор пользователя при инициировании развертывания непосредственно пользователем. Если развертывание инициируется платформой, SYSTEM указывается как сущность, развертывающая пакет. | Ключ категории: audit.AuditCategory.SoftwareManagement | ||
SECURITY_CONFIGURATION | Действия, относящиеся к сущностям безопасности и разрешений, включая пользователей, группы пользователей, группы вещей, организации, ключи приложений, службы каталогов и аутентификаторы. При каждом внесении изменения во владение сущности генерируется сообщение аудита. Владелец может быть изменен в Composer, путем вызова API или путем импорта XML-файла сущностей Сообщение аудита владения не генерируется в следующих случаях: • подсистема аудита выключена; • сущность была обновлена без изменений владения; • вызов API-интерфейса SetOwner осуществляется тем же самым владельцем, который уже является владельцем данной сущности. | Операции создания, правки и удаления для пользователей, групп пользователей, групп вещей, организаций, ключей приложений, служб каталогов и аутентификаторов. Позволяет отслеживать изменения в группе пользователей. Запись audit.Groups.Added создается при каждом добавлении пользователя или группы пользователей в качестве участника другой группы пользователей. Сущность audit.Groups.Removed создается при каждом удалении пользователя или группы пользователей из группы пользователей. Изменения разрешений для сущностей (все типы сущностей). См. выше раздел Аудит переключения контекста безопасности. Общий формат сообщения аудита об изменении владения приведен ниже. "Owner for <Source Type> <Source> changed from <original owner username> to <new owner username>." Здесь: • Source Type - вид сущности, для которой изменился владелец. Например, "Вещь". • Source - имя сущности, для которой изменился владелец. • Поле original owner username содержит username пользователя, выполняющего действие изменения. • Поле new owner username содержит username нового владельца. | Ключ категории: audit.AuditCategory.SecurityConfiguration Ключи сообщений: • audit.Groups.Added • audit.Groups.Removed • audit.entity.ownership.change | ||
Администратор, который разрешает и запрещает делегирование разрешений видимости группы вещей в подсистеме управления пользователями | Операции с аудитом и сообщения аудита: • Администратор включил разрешение на видимость группы вещей в подсистеме управления пользователями - сообщение аудита: "Включено делегирование разрешений на видимость для группы вещей". • Администратор отключил разрешение на видимость группы вещей в подсистеме управления пользователями - сообщение аудита: "Отключено делегирование разрешений на видимость для группы вещей". | Ключ категории: audit.AuditCategory.SecurityConfiguration Ключи сообщений: • com.thingworx.thinggroups.ThingGroup.VisibilityPermissionDelegationEnabled • com.thingworx.thinggroups.ThingGroup.VisibilityPermissionDelegationDisabled | |||
SYSTEM | Действия, относящиеся к системным сущностям. | Операции создания, правки и удаления для таблиц локализации, ресурсов, подсистем и журналов. Изменения конфигурации подсистемы и действия, включая запуск, остановку и перезапуск. Все относящиеся к подсистеме записи находятся в этой категории и не будут отображаться в других категориях.
| Ключ категории: audit.AuditCategory.System | ||
VISUALIZATION | Действия, относящиеся к сущностям визуализации. | Операции создания, правки и удаления для мэшапов, мастеров, гаджетов, инструментальных панелей, меню, медиаобъектов, определений стилей и определений состояний. | Ключ категории: audit.AuditCategory.Visualization |
Категория аудита | Ключ сообщения аудита |
---|---|
AUDIT | • audit.Audit.ExecutedService.QueryAuditHistory • audit.Audit.ExecutedService.QueryAuditHistoryWithQueryCriteria • QueryAuditHistoryContextConstrained • audit.Audit.ExecutedService.GetAuditEntryCount |
THINGGROUPMEMBERSHIPS | • com.thingworx.thinggroups.ThingGroup.AddedThingAsChildMember • com.thingworx.thinggroups.ThingGroup.DeletedThingAsChildMember • com.thingworx.thinggroups.ThingGroup.AddedThingGroupAsChildMember • com.thingworx.thinggroups.ThingGroup.DeletedThingGroupAsChildMember • com.thingworx.thinggroups.ThingGroup.DeletededAllChildMembers |
LIFECYCLE | audit.Lifecycle.ThingStart |
Невозможно включать или отключать отдельные события в категории LIFECYCLE. Необходимо включить или выключить все, используя нотацию "MessageKeys" : ["ALL"]. |
При внесении изменений в файл platform-settings.json для категорий аудита и сообщений о событиях требуется перезапуск экземпляра ThingWorx Platform. Этот тип изменения должен выполняться по возможности редко. |
Раздел Audit должен быть добавлен как соседний узел в запись JSON в PlatformSettingsConfig. Он может располагаться до или после узла PlatformSettingsConfig, но должен находиться на одном уровне с узлом. |