UiPath Orchestrator

UiPath Orchestrator ガイド

Orchestrator のログ

Orchestrator 診断ログ

これらは、UiPath Orchestrator で生成された、その動作に関する診断ログです。

UiPath Orchestrator 診断ログの有効化

UiPath Orchestrator 診断ログは、UiPath Orchestrator が正常にインストールされると有効になります。この診断ログは NLog インフラストラクチャーに依存し、その構成は web.config ファイルの <nlog> タグ下で確認することができます。

📘

ユーザーがどの言語を選択したかに関わらず、Orchestrator とスタックトレースからのサーバー例外は両方とも [ジョブの詳細 (Job Details)] ウィンドウに英語で表示されます。

UiPath Orchestrator 診断ログのターゲット

すべてのアプリケーション ログは、[情報 (Information)] という最小のログレベルで[イベントビューアー (Event Viewer)] に記録されます。これは、web.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" />
例:

  • Could not create Quartz Job

ビジネスおよびその他の検証ルールにより生成されたログには、別のターゲットとロガーが含まれています。
<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" />
この種のエラー メッセージのログは、以下の場合にイベント ビューアーに記録されます。

  • 検証に関する問題:
    • Invalid username/email address or password.
    • The machine name DOC is already taken
  • ビジネスコンフリクト:
    • License expired!
    • The floating robot's session is already active on machine ROQADOCS06!
    • The robots already have pending jobs for this Process.
  • NotFound 例外:
    • QueueName1 does not exist.

Orchestrator 実行ログ


Orchestrator 実行ログが、接続されているロボットから送信されて、[ジョブ] または [ロボット] ページの [ログ] セクションに表示されます。アプリケーションはロボットからデータを受け取り、独自のパラメーター (テナント IDフォルダー ID) を追加してから、web.config ファイルの <nlog> セクションに指定されているさまざまなターゲットにメッセージを転送します。

Orchestrator 実行ログの対象

既定では、ロボットのすべてのログは既定の Orchestrator データベースの [ログ (Logs)] テーブルに送信されます。ここには UiPath Orchestrator の他の情報も保存されます。ただし、別のデータベースに送信するように web.config ファイルを構成することもできます。

[ログ (Logs)] ページには、既定データベース[ログ (Logs)] テーブルからの情報が表示されます。したがって、このセクションが存在しない場合、またはログが別のデータベースに保存されている場合は、ページは空となります。すべてのパラメーターは、次のようにテーブルスキーマに準拠している必要があります。

<target xsi:type="Database" name="database" connectionStringName="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" />

web.config ファイルを設定することで、他のターゲットをログに追加できます。利用可能なターゲットの一覧はこちらを参照してください。

Elasticsearch サーバー

既定では、インストール スクリプトから構成された Elasticsearch ターゲットが存在します。インデックスはテナントごとに異なりますが、<nlog> セクションで指定されたターゲットから構成できます。

<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>

X-PACK 認証

Orchestrator は Elasticsearch 用に X-PACK 認証をサポートします。これを有効にするには、web.config ファイルの次のセクションに requireAuth="true" username="XPACKuser" password="p@$$w0rd" 行を追加する必要があります:

<target name="robotElasticBuffer" xsi:type="BufferingWrapper" flushTimeout="5000">
        <target xsi:type="ElasticSearch" name="robotElastic" uri="http://elk-test.com" 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="http://elk-test.com" requireAuth="true" username="userName" password="****" index="${event-properties:item=indexName}-${date:format=yyyy.MM}" documentType="logEvent" includeAllProperties="true" layout="${message}" excludedProperties="agentSessionId,tenantId,indexName" />
      </target>

2 か月前に更新



Orchestrator のログ


改善の提案は、API 参照ページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。