Orchestrator 日志
这些是 UiPath™ Orchestrator 生成的有关其行为的诊断日志。
UiPath.Orchestrator.dll.config
文件中的 <nlog>
标签下找到。
UiPath.Orchestrator.dll.config
文件中的以下行指定:
<target xsi:type="EventLog" name="eventLog" layout="${message}" source="Orchestrator" log="Application" />
<logger name="*" minlevel="Info" writeTo="eventLog" />
作业计划程序生成的日志具有单独的目标和记录器:
<target xsi:type="EventLog" name="eventLogQuartz" layout="[Quartz] ${message} ${onexception: ${exception:format=tostring}}"
source="Orchestrator" log="Application" />
<logger name="Orchestrator.Quartz.*" minlevel="Info" writeTo="eventLogQuartz" />
示例:
无法创建 Quartz 作业
业务规则和其他验证规则生成的日志具有单独的目标和记录器:
<target xsi:type="EventLog" name="businessExceptionEventLog" layout="${message}${onexception:${exception:format=tostring:maxInnerExceptionLevel=5:innerFormat=tostring}}"
source="Orchestrator.BusinessException" log="Application" />
<logger name="BusinessException.*" minlevel="Info" writeTo="businessExceptionEventLog" final="true" />
在以下情况下,这些类型的错误消息会记录在事件查看器中:
-
验证问题,例如:
用户名/电子邮件地址或密码无效。
计算机名称 DOC 已被占用
-
业务冲突,例如:
许可证已过期!
浮动机器人的会话已在计算机 ROQADOCS06 上处于活动状态!
对于此流程,机器人已经有待定作业。
-
未找到异常,例如:
队列名称 1 不存在。
UiPath.Orchestrator.dll.config
文件的 <nlog>
一节中所指定。
默认情况下,所有机器人日志都发送到默认 Orchestrator 数据库的“日志”表,UiPath Orchestrator 还将其他信息存储在该数据库中。
UiPath.Orchestrator.dll.config
文件的 target xsi:type="Database" connectionString="..."
部分中进行配置,选择将机器人日志发送到其他数据库。
“日志”页面显示默认数据库的“日志”表中的信息。因此,如果此部分不存在,或者日志保存到其他数据库中,则页面为空。所有参数都应符合表格架构,如下所示:
<target xsi:type="Database" name="database" connectionString="${ui-connection-strings:item=Default}" keepConnection="true">
<commandText>
insert into dbo.Logs (OrganizationUnitId, TenantId, TimeStamp, Level, WindowsIdentity, ProcessName, JobKey, Message, RawMessage)
values (@organizationUnitId, @tenantId, @timeStamp, @level, @windowsIdentity, @processName, @jobId, @message, @rawMessage)
</commandText>
<parameter name="@organizationUnitId" layout="${event-properties:item=organizationUnitId}" />
<parameter name="@tenantId" layout="${event-properties:item=tenantId}" />
<parameter name="@timeStamp" layout="${date}" />
<parameter name="@level" layout="${event-properties:item=levelOrdinal}" />
<parameter name="@windowsIdentity" layout="${event-properties:item=windowsIdentity}" />
<parameter name="@processName" layout="${event-properties:item=processName}" />
<parameter name="@jobId" layout="${event-properties:item=jobId}" />
<parameter name="@message" layout="${message}" />
<parameter name="@rawMessage" layout="${event-properties:item=rawMessage}" />
</target>
<logger name="Robot.*" writeTo="database" final="true" />
<target xsi:type="Database" name="database" connectionString="${ui-connection-strings:item=Default}" keepConnection="true">
<commandText>
insert into dbo.Logs (OrganizationUnitId, TenantId, TimeStamp, Level, WindowsIdentity, ProcessName, JobKey, Message, RawMessage)
values (@organizationUnitId, @tenantId, @timeStamp, @level, @windowsIdentity, @processName, @jobId, @message, @rawMessage)
</commandText>
<parameter name="@organizationUnitId" layout="${event-properties:item=organizationUnitId}" />
<parameter name="@tenantId" layout="${event-properties:item=tenantId}" />
<parameter name="@timeStamp" layout="${date}" />
<parameter name="@level" layout="${event-properties:item=levelOrdinal}" />
<parameter name="@windowsIdentity" layout="${event-properties:item=windowsIdentity}" />
<parameter name="@processName" layout="${event-properties:item=processName}" />
<parameter name="@jobId" layout="${event-properties:item=jobId}" />
<parameter name="@message" layout="${message}" />
<parameter name="@rawMessage" layout="${event-properties:item=rawMessage}" />
</target>
<logger name="Robot.*" writeTo="database" final="true" />
UiPath.Orchestrator.dll.config
文件添加到日志中。可在此处找到可用目标列表。
升级 Orchestrator 时,系统会删除并重新创建 Nlog 目标,如下所示:
- 升级到 2022.4 后, Nlog 数据库目标将恢复为其默认值。
- 升级到 2022.10 后, Nlog 数据库目标将被删除,并替换为新的和改进的目标。
database
、monitoring
和 insightsRobotLogs
目标。
CREATE NONCLUSTERED INDEX [IX_Search] ON [dbo].[Logs]
(
[TenantId] ASC,
[OrganizationUnitId] ASC,
[Level] ASC,
[TimeStamp] DESC
)WITH (STATISTICS_NORECOMPUTE = OFF, DROP_EXISTING = OFF, ONLINE = OFF, OPTIMIZE_FOR_SEQUENTIAL_KEY = OFF) ON [PRIMARY]
GO
CREATE NONCLUSTERED INDEX [IX_Search] ON [dbo].[Logs]
(
[TenantId] ASC,
[OrganizationUnitId] ASC,
[Level] ASC,
[TimeStamp] DESC
)WITH (STATISTICS_NORECOMPUTE = OFF, DROP_EXISTING = OFF, ONLINE = OFF, OPTIMIZE_FOR_SEQUENTIAL_KEY = OFF) ON [PRIMARY]
GO
<nlog>
节中指定的目标进行配置。
对于低于 Elasticsearch 8.0 的版本:
<target name="robotElasticBuffer" xsi:type="BufferingWrapper" flushTimeout="5000">
<target xsi:type="ElasticSearch" name="robotElastic" uri="uritoelasticsearchnode" index="${event-properties:item=indexName}-${date:format=yyyy.MM}" documentType="logEvent" includeAllProperties="true" layout="${message}" excludedProperties="agentSessionId,tenantId,organizationId,indexName" />
</target>
</target>
<target name="robotElasticBuffer" xsi:type="BufferingWrapper" flushTimeout="5000">
<target xsi:type="ElasticSearch" name="robotElastic" uri="uritoelasticsearchnode" index="${event-properties:item=indexName}-${date:format=yyyy.MM}" documentType="logEvent" includeAllProperties="true" layout="${message}" excludedProperties="agentSessionId,tenantId,organizationId,indexName" />
</target>
</target>
对于 Elasticsearch 8.0 及更高版本:
<target name="robotElasticBuffer" xsi:type="BufferingWrapper" flushTimeout="5000">
<target xsi:type="ElasticSearch" name="robotElastic" uri="uritoelasticsearchnode" index="${event-properties:item=indexName}-${date:format=yyyy.MM}" documentType="" enableApiVersioningHeader="true" includeAllProperties="true" layout="${message}" excludedProperties="agentSessionId,tenantId,organizationId,indexName" />
</target>
</target>
<target name="robotElasticBuffer" xsi:type="BufferingWrapper" flushTimeout="5000">
<target xsi:type="ElasticSearch" name="robotElastic" uri="uritoelasticsearchnode" index="${event-properties:item=indexName}-${date:format=yyyy.MM}" documentType="" enableApiVersioningHeader="true" includeAllProperties="true" layout="${message}" excludedProperties="agentSessionId,tenantId,organizationId,indexName" />
</target>
</target>
为了使 Elasticsearch 8.0 及更高版本正常工作,请按如下方式设置这些参数:
documentType
为空。- 将
enableApiVersioningHeader
设置为true
。
用户名和密码身份验证
要启用通过用户名和密码进行的身份验证,您需要执行以下步骤:
- 选项 1:如果不使用 NLog 目标,则需要配置以下参数:
Logs.Elasticsearch.Username
和Logs.Elasticsearch.Password
。 确保其值与步骤 1 中的 Elasticsearch 设置匹配。 -
选项 2:如果将
Logs.RobotLogs.ReadTarget
设置为 NLog 目标(例如robotElasticBuffer
),并且未指定Logs.Elasticsearch.Nodes
设置,请通过添加以下内容来配置目标:requireAuth="true" username="XPACKuser" password="p@$$w0rd"
。 确保这些参数值与步骤 1 中的 Elasticsearch 设置匹配。有关这些参数的更多信息,请参阅 UiPath.Orchestrator.dll.config 页面。
有关配置示例,请参见以下内容:
<target name="robotElasticBuffer" xsi:type="BufferingWrapper" flushTimeout="5000"> <target xsi:type="ElasticSearch" name="robotElastic" uri="" requireAuth="true" username="XPACKusername" password="p@$$w0rd" index="${event-properties:item=indexName}-${date:format=yyyy.MM}" documentType="logEvent" includeAllProperties="true" layout="${message}" excludedProperties="agentSessionId,tenantId,indexName" /> </target>
<target name="robotElasticBuffer" xsi:type="BufferingWrapper" flushTimeout="5000"> <target xsi:type="ElasticSearch" name="robotElastic" uri="" requireAuth="true" username="XPACKusername" password="p@$$w0rd" index="${event-properties:item=indexName}-${date:format=yyyy.MM}" documentType="logEvent" includeAllProperties="true" layout="${message}" excludedProperties="agentSessionId,tenantId,indexName" /> </target> - 选项 3:如果
Logs.RobotLogs.ReadTarget
设置为 NLog 目标(例如robotElasticBuffer
),并且通过Logs.Elasticsearch.Nodes
设置指定了 Elasticsearch 节点,则需要显式配置它(因为它会覆盖 NLog 目标设置) ,并确保同时添加以下内容:requireAuth="true" username="XPACKuser" password="p@$$w0rd"
。 确保这些参数值与步骤 1 中的 Elasticsearch 设置匹配。
OAuth 2 身份验证
要切换到 OAuth2 作为 Elasticsearch 的身份验证方法,您需要执行以下步骤。 请注意,您需要提供当前凭据才能切换到此基于令牌的身份验证方法。
API 密钥身份验证
API 密钥过期时间
默认情况下,API 密钥不会过期,但您仍然可以选择为其设置过期日期。
如果您的 API 密钥设置为过期,则必须在过期日期之前生成一个新密钥并将其存储在密钥保险库中,以确保 Orchestrator 始终可以检索有效密钥。
Orchestrator 每 15 分钟从密钥保险库读取 API 密钥,因此这是传播新密钥之前可以预期的最大延迟量。