Robot

2021.10

偽

Robot ガイド

最終更新日 2023年10月25日

ロボットログ

ログは、アプリケーションに関連する情報イベント、エラー、警告メッセージを含む、タイムスタンプ付きのファイルです。

Orchestrator が利用できない場合は、接続が復元するまで、ローカルデータベース形式 (C:\Windows\SysWOW64\config\systemprofile\AppData\Local\UiPath\Logs\execution_log_data) で、利用可能なディスクスペース内に保存されます。接続が復元すると、ログは生成された順番に分割して送信されます。

注: データベースは、ログが Orchestrator に正常に送信された後も削除されません。

ジョブのステータスは UiPath Robot サービスのメモリ内に保存されます。Orchestrator が利用可能になると、ジョブステータスに関連する情報は両者の間で同期されます。ただし、Orchestrator が利用できない状態で UiPath Robot サービスを再起動しても、これらの情報は失われます。つまり、Orchestrator が利用可能になったときに、ジョブは再実行されます。

ロボット診断ログ

これらのログではロボット自体およびそのコンテキストに関連する情報が提供されます。これらの情報は特定のエラーの原因を識別するのに役立ちます。

ロボット診断ログを有効化する

既定では、ロボット診断ログが有効化されていて、Error または Warning レベルのメッセージのログが記録されます。

他のレベルのログ情報も必要な場合、ローレベルのトレースを有効化すれば、すべてのログ情報を有効化できます。既定ではこの機能は無効化されています。

低レベルのトレースを有効化するには、コマンドプロンプトでコマンド UiRobot.exe --enableLowLevel を実行します。

低レベルのトレースを無効化するには、コマンドプロンプトでコマンド UiRobot.exe --disableLowLevel を実行します。

ローレベルトレースを管理者、ローカルユーザー、またはドメインユーザーとして有効化すると、.etl ファイルのローレベルトレースが開始されます。これによって、Robot Executor およびサービスの詳細トレースがイベントビューアー内で有効化されます。

最初に cd 引数 (cd C:\Program Files\UiPath\Studio など) を使用してインストールディレクトリに移動するのを忘れないでください。

注:

低レベルのトレースは、問題の調査時にのみ有効にして、調査セッションが終了したら無効にすることをお勧めします。

さらに、トレース情報を含む .etl ファイルは、機能を無効化して初めて生成されます。

Robot を再起動しなくても変更が反映されます。

ロボット診断ログのターゲット

ログの記録先は <Installation Folder>\NLog.config ファイルで制御されます。診断ログは内部のロガーで収集され、NLog ターゲットを使用して転送されます。

既定では、内部ログは NLog.config の以下の行に指定されたイベントビューアーに送信されます。

<target xsi:type="EventLog" name="eventLog" layout="${callsite:className=false:includeSourcePath=true:methodName=false} ${message}" source="UiPath" log="Application" />

<logger name="Internal" minLevel="Trace" writeTo="eventLog" />

注: NLog.config ファイルを編集するには管理者権限が必要です。内部ターゲットが NLog.config ファイルで変更されている場合は、変更を反映するために UiRobot.exe サービスを再起動する必要があります。

.etl ログファイルを開く

この種類のファイルは、イベントビューアーから開くことができます。

イベントビューアーの [アクション] パネルで、[保存されたログを開く] をクリックします。[保存されたログを開く] ウィンドウが表示されます。
生成されたトレースログファイルを参照し、[開く] をクリックします。左パネルの [保存されたログ] にファイルが表示されます。
ファイルを選択します。ログの内容が表示されます。

ロボット実行ログ

ロボット実行ログは、プロセスの実行によって生成されるメッセージで、通常はその動作に関連する情報とユーザー定義メッセージを含みます。

実行ログはいくつかの方法で生成できます。

[1 行を書き込み] アクティビティでは、Trace レベルのログが作成されます。
[メッセージをログ] アクティビティでは、[レベル] プロパティフィールドで指定されたレベルでログが作成されます。
オートメーションプロジェクトを実行すると、各アクティビティの動作を含むログが生成されます。[Orchestrator の設定] ウィンドウの [レベル ] が Verbose に設定されていると、Trace レベルのログが記録されます。

実行ログのログレベル

既定のログレベルは、[Orchestrator の設定] ウィンドウの [レベル] 設定で制御します。既定では、Information に設定されています。

[Orchestrator の設定] ウィンドウで既定のログレベルを変更する

UiPath Assistant から [設定] メニューに移動し、[Orchestrator の設定] にアクセスします。
[ログ] セクションの [ログレベル] ドロップダウンメニューから、適切なログレベルを選択します。

注: Robot が Windows サービスとしてインストールされている場合、この設定を編集するには管理者権限が必要です。

実行ログのターゲット

既定では、実行ログは %LocalAppData%\UiPath\Logs フォルダー内のファイルに保存されます。メッセージは WorkflowLogging ロガーで収集され、NLog.config ファイル内の以下のパラメーターの設定に従って、NLog ターゲットを使用して転送できます。

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <variable name="WorkflowLoggingDirectory" value="${specialfolder:folder=LocalApplicationData}/UiPath/Logs" />
  <rules>
    <logger name="WorkflowLogging" writeTo="WorkflowLogFiles" final="true" />
  </rules>
  <targets>
    <target type="File" name="WorkflowLogFiles" fileName="${WorkflowLoggingDirectory}/${shortdate}_Execution.log" layout="${time} ${level} ${message}" keepFileOpen="true" openFileCacheTimeout="5" concurrentWrites="true" encoding="utf-8" writeBom="true" />
  </targets>
</nlog><?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <variable name="WorkflowLoggingDirectory" value="${specialfolder:folder=LocalApplicationData}/UiPath/Logs" />
  <rules>
    <logger name="WorkflowLogging" writeTo="WorkflowLogFiles" final="true" />
  </rules>
  <targets>
    <target type="File" name="WorkflowLogFiles" fileName="${WorkflowLoggingDirectory}/${shortdate}_Execution.log" layout="${time} ${level} ${message}" keepFileOpen="true" openFileCacheTimeout="5" concurrentWrites="true" encoding="utf-8" writeBom="true" />
  </targets>
</nlog>

ロボットが Orchestrator に接続されている場合は、すべての実行ログが Orchestrator に送信されて [ログ] ページで見ることができます。

さらに、ログターゲットとログ内容は <Installation Folder>\NLog.config ファイルを編集することで構成できます。

古いログファイルを削除する

マシン上のディスク領域を消費する大量のログファイルが作成されないように、ログファイルが特定の数に達したらファイルをアーカイブするよう選択できます。

それには、以下のパラメーターを <target> タグに追加します。

archiveNumbering="Date"
archiveEvery="Day"
archiveDateFormat="yyyy-MM-dd"
archiveFileName="${WorkflowLoggingDirectory}/{#}_Execution.log"

maxArchiveFiles="10"

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <variable name="WorkflowLoggingDirectory" value="${specialfolder:folder=LocalApplicationData}/UiPath/Logs" />
  <rules>
    <logger name="WorkflowLogging" writeTo="WorkflowLogFiles" final="true" />
  </rules>
  <targets>
    <target type="File"
      name="WorkflowLogFiles"
      fileName="${WorkflowLoggingDirectory}/${shortdate}_Execution.log"
      layout="${time} ${level} ${message}"
      keepFileOpen="true"
      openFileCacheTimeout="5"
      concurrentWrites="true"
      encoding="utf-8"
      writeBom="true"
      archiveNumbering="Date"
      archiveEvery="Day"
      archiveDateFormat="yyyy-MM-dd"
      archiveFileName="${WorkflowLoggingDirectory}/{#}_Execution.log"
      maxArchiveFiles="10"
    />
  </targets>
</nlog><?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <variable name="WorkflowLoggingDirectory" value="${specialfolder:folder=LocalApplicationData}/UiPath/Logs" />
  <rules>
    <logger name="WorkflowLogging" writeTo="WorkflowLogFiles" final="true" />
  </rules>
  <targets>
    <target type="File"
      name="WorkflowLogFiles"
      fileName="${WorkflowLoggingDirectory}/${shortdate}_Execution.log"
      layout="${time} ${level} ${message}"
      keepFileOpen="true"
      openFileCacheTimeout="5"
      concurrentWrites="true"
      encoding="utf-8"
      writeBom="true"
      archiveNumbering="Date"
      archiveEvery="Day"
      archiveDateFormat="yyyy-MM-dd"
      archiveFileName="${WorkflowLoggingDirectory}/{#}_Execution.log"
      maxArchiveFiles="10"
    />
  </targets>
</nlog>

注: maxArchiveFiles は、アーカイブファイルの数を制御するパラメーターです。

注: NLog.config ファイルを編集するには管理者権限が必要です。変更を反映するために Robot サービスの再起動は必要ありません。

ログの詳細編集

ログレベルが Verbose に設定されている場合は、メッセージには実行時に行われたアクティビティに関するすべての詳細が含まれます。このログ出力は、C:\Program Files\UiPath\Studio フォルダーにある UiPath.Executor.exe.config ファイルを編集することでカスタマイズできます。それには、XML コードを <system.serviceModel> タグの下に追加する必要があります。以下に例を示します。

<tracking>
    <profiles>
        <trackingProfile name="StandardProfile">
         <workflow>
          <activityStateQueries>  
            <activityStateQuery activityName="*">
                <states>  
                    <state name="Faulted"/>  
                </states>
                <arguments>  
                    <argument name="*"/>  
                </arguments> 
                 <variables>  
                    <variable name="*"/>  
                </variables>             
            </activityStateQuery>
          </activityStateQueries>    
         </workflow>
        </trackingProfile>       
    </profiles>
</tracking><tracking>
    <profiles>
        <trackingProfile name="StandardProfile">
         <workflow>
          <activityStateQueries>  
            <activityStateQuery activityName="*">
                <states>  
                    <state name="Faulted"/>  
                </states>
                <arguments>  
                    <argument name="*"/>  
                </arguments> 
                 <variables>  
                    <variable name="*"/>  
                </variables>             
            </activityStateQuery>
          </activityStateQueries>    
         </workflow>
        </trackingProfile>       
    </profiles>
</tracking>

<states> タグに <state name="Faulted"/> のみが含まれているため、上記のコードを挿入すると、エラー ステートのアクティビティのみがログに記録されます。<states> タグに他のパラメーター (<state name="Executing"/> など) を追加すると、他のステートのアクティビティもログに記録されます。

アクティビティのステートだけでなく、変数や引数も変更できます。カスタマイズについての詳細情報はこちらをご覧ください。

注: UiPath.Executor.exe.config ファイルを変更する場合、変更を反映するため Robot サービスの再起動が必要です。