ThingWorx 审计消息
本主题在以下部分中提供了有关 ThingWorx 审计消息的详细信息：
审计消息类型
审计子系统将在 ThingWorx Platform 中为不同的活动生成消息。这些消息分为以下常规类型：
• 对对象进行的更改 - 审计更改，例如创建、删除或修改实体。实体可能是事物或非事物，例如子系统或组织。
• 对用户进行的更改 - 审计更改，例如创建或修改用户或应用程序密钥。
• 对对象执行的操作 - 对实体执行的审计操作。例如，对“事物”执行的远程会话活动 (隧道)。
• 对系统执行的操作 - 在审计中，消息不存在任何目标对象，例如用户登录和导入/导出操作。
审计消息包含审计条目，其中提供有关活动的信息。
 |
有关在安全上下文中审计切换的信息，请参阅
审计安全上下文的切换 。
|
审计条目
每个审计条目包含两个部分 (审计类别密钥和审计消息密钥)：
• 审计消息密钥是指向审计消息文本的本地化标记。此密钥为 STRING。
每个部分的值从相应的内置事件定义或实例中提取。请注意，不支持用户定义事件的审计。
审计消息自变量
审计消息可提供用于生成本地化文本消息和执行操作的实体名称的参数。替换名称/值对的 ValueCollection 用于生成本地化文本消息。此信息从事件实例的 eventData 字段检索。ThingWorx 实体 (例如，事物或用户) 与审计消息相关联，其中包括执行作为审计消息主题的操作的人员或事物。
审计类别
所有审计条目都与审计类别相关联。审计类别使筛选审计数据变得十分容易，并可查看特定操作类别的活动趋势。此外，审计类别可帮助您检测对未授权访问的尝试操作或 Edge 设备无法连接到 ThingWorx Platform 的问题。
每个审计条目都具有单一类别，类别将存储为具有审计条目的字符串。显示的审计类别字符串已本地化。根据用户的首选区域设置，以适合的语言显示审计类别。
下表列出并简要介绍了审计子系统中的可用类别。
|
类别
|
说明
|
示例
|
本地化标记
|
||
|---|---|---|---|---|---|
|
ANALYTICS
|
与分析实体相关的操作。ThingWorx Analytics 执行的操作。
|
“数据分析定义”的创建、编辑、删除操作。
ThingWorx Analytics 中的其他操作。
|
audit.AuditCategory.Analytics
|
||
|
AUTHENTICATION
|
与身份验证相关的操作。
|
成功和失败的用户登录、用户锁定以及与使用应用程序密钥相关的错误。例如：Login successful for user: Administrator。
|
audit.AuditCategory.Authentication
|
||
|
COLLABORATION
|
与“协作”实体相关的操作。
|
博客和 Wiki 的创建、编辑和删除操作。
|
audit.AuditCategory.Collaboration
|
||
|
DATA_MANAGEMENT
|
与管理或使用数据相关的操作。
|
数据的删除操作。
|
audit.AuditCategory.DataManagement
|
||
|
DATA_STORAGE
|
“数据存储”实体及相关子系统的相关操作。
|
数据表、流和其他数据存储实体的创建、编辑和删除操作。
|
audit.AuditCategory.DataStorage
|
||
|
DEVICE_COMMUNICATION
|
与 Edge 设备通信的相关操作和事件。
|
针对“远程事物”(RestartThing、EnableThing、DisableThing) 调用的重要服务。
|
audit.AuditCategory.DeviceCommunication
|
||
|
FILE_TRANSFER
|
与文件上载和下载相关的操作和事件。
|
针对文件传输：成功完成传输、取消传输以及在传输过程中生成错误。
|
audit.AuditCategory.FileTransfer
|
||
|
IMPORT_EXPORT
|
与在 ThingWorx 中执行的数据导入和导出相关的操作。
|
模型和数据导入/导出操作。
扩展的导入。
|
audit.AuditCategory.ImportExport
|
||
|
LIFECYCLE
|
与事物特定事件相关的操作，例如 ThingStart
|
ThingStart 事件
|
audit.AuditCategory.Lifecycle
|
||
|
MODELING
|
与“建模”实体相关的操作。创建实体时，系统会生成一条审计消息，其中包含分配给新实体的所有者。请注意，实体的所有者会被自动设置为创建该实体的用户名。
无论使用何种方法创建实体，系统都会生成审计消息：
• 在 Composer 中通过调用 PUT
• 通过调用 Create API、Clone API 或 SetOwner API
任何有权查看审计子系统的用户都可以查看有关所有权更改的报告。
|
有关事物、事物模板、事物形态、数据形状、网络、项目、模型和标记的创建、编辑、删除操作。
审计消息的格式为：
"Created <Source Type> <Source> with owner <username of owner>."
其中：
• Source Type 为所创建实体的类型。例如，事物。
• Source 为新实体的名称。
• owner 显示了执行创建操作的用户的 username。
|
类别键：audit.AuditCategory.Modeling
消息键为：audit.EntityLifecycle.Create。
|
||
|
REMOTE_ACCESS
|
与远程访问 (隧道) 相关的操作。
|
会话开始/结束 (TunnelSession 事件)、取消会话。
|
audit.AuditCategory.RemoteAccess
|
||
|
SCM (软件内容管理)
|
与包、部署和配置更改相关的操作。
|
创建、编辑、发布和删除包。创建、开始、转变和删除部署。包括测试和实际部署、为测试部署指定的资产以及包安装的成功或失败。用于自动清除和并发部署的配置更改。
|
audit.AuditCategory.SoftwareManagement
|
||
|
SECURITY_CONFIGURATION
|
与安全实体和权限相关的操作，包括用户、用户组、事物组、组织、应用程序密钥、目录服务和身份验证器。
每当实体的所有权发生更改时，都会生成审计消息。可通过 Composer、API 调用或导入实体 XML 文件来更改所有者
以下情况不会生成所有权审计消息：
• 审计子系统已禁用。
• 实体已在未更改所有权的情况下更新。
• SetOwner API 调用设置的所有者与实体的所有者相同。
|
有关用户、用户组、事物组、组织、应用程序密钥、目录服务、身份验证器的创建、编辑和删除操作。
启用对用户组更改的跟踪。只要将用户或用户组添加为另一个用户组的成员，就会生成 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
|