Site cover image

Site icon imageIT Works Lab - blog

IT関連のメモ

[UiPath]ログ出力について② - ログフォーマット・ログレベル

ロボット実行時に出力されるログのフォーマット

ロボットを実行した際に作成される実行ログファイル、その他、Studio実行時に出力されるログファイルについては、以下のパスに格納されます

 C:\Users\ユーザー名\AppData\Local\UiPath\Logs

  またはエクスプローラーで %localappdata%\UiPath\Logs を開きます。

ロボットの実行ログファイルは「yyyy-MM-dd_Execution.log」という名前で表示されます。
  上記以外のログファイルはUiPath Studio実行時に出力されるログとなります。

<実行ログ:yyyy-MM-dd_Execution.log>

Image in a image block

ログの種類

UiPath Platform には、主要なすべてのコンポーネントにログ機能が備わっています。UiPath 固有のログは、Nlog インフラストラクチャに基づいています。これらのログは、いくつかの特性によって分類できます。

  1. デフォルト ログ (Default Logs):
    • プロジェクトの実行が開始および終了した際、システムエラーが発生して実行が停止した際、またはすべてのアクティビティの実行を記録するようにログ設定が構成されている場合に作成されます。
    • 以下のイベントがこのカテゴリで記録されます:
      • Execution Start: プロセスが開始されるたびに生成されます (レベル = Information)。
      • Execution End: プロセスが終了するたびに生成されます (レベル = Information)。
      • Transaction Start: プロセス内のトランザクションが開始されるたびに生成されます (レベル = Information)。
      • Transaction End: プロセス内のトランザクションが終了するたびに生成されます (レベル = Information)。
      • Error Log: 実行がエラーを検出して停止するたびに生成されます (レベル = Error)。
      • Debugging Log: ロボットのログ設定が Verbose に設定され、アクティビティ名や変数値、引数などが含まれている場合に生成されます (レベル = Trace)。
  2. ユーザー定義のログ (User-Defined Logs):
    • [メッセージをログ] アクティビティまたは [1 行を書き込み] アクティビティを使用する場合、Studio でユーザーが設計したプロセスに従って生成されます。

ログフィールド

  • 既定のフィールド:
    • Message - ログ メッセージです。
    • Level - ログの重要度を定義します。
    • Timestamp - アクションが実行された正確な日付と時刻です。
    • FileName - 実行されている .xaml ファイルの名前です。
    • jobId * - プロセスを実行しているジョブのキーです。
    • processName * - ログの記録をトリガーしたプロセスの名前です。
    • processVersion * - プロセスのバージョン番号です。
    • windowsIdentity - ログに記録されたアクションを実行したユーザーの名前です。
    • robotName * - (Orchestrator で定義された) ロボットの名前です。
    • machineName - ロボット端末の名前です。
    • machineId * - ロボット端末の ID です。
    • organizationUnitId * - Orchestrator 組織の ID です。

    ※アスタリスクが付いているログ フィールドは、[ログ フィールドを追加] アクティビティで上書きできません。

  • 種類固有のフィールド:
    • これらのログ フィールドは、ログの種類によって異なります。例: totalExecutionTimeInSeconds, queueName, transactionID など。
    UiPath のログは、プロセスを Orchestrator に接続せず、ローカルで実行している場合は、[プロセス名] および [プロセスバージョン] が表示されない場合があります

例)

出力されたログ(1行)

09:01:32.5346 Info {"message":"変数一覧を取得 の実行が開始されました。","level":"Information","logType":"Default","timeStamp":"2024-04-08T09:01:32.5294661+09:00","fingerprint":"60713029-5e16-41e6-8a79-d870f7797921","windowsIdentity":"TEST\\test","machineName":"TEST","fileName":"Main","initiatedBy":"Studio","processName":"変数一覧を取得","processVersion":"1.0.6","jobId":"3137a885-5a96-47f9-a1d3-a8e8769adeb9","robotName":"s-takahashi@yamamoto-tile.biz-attended","machineId":3337341,"organizationUnitId":4152162}

上記をフォーマットした結果

09:01:32.5346 ←タイムスタンプ
Info       ←ログレベル
{
  "message": "変数一覧を取得 の実行が開始されました。",   ←{ }内:ログの詳細情報
  "level": "Information",
  "logType": "Default",
  "timeStamp": "2024-04-08T09:01:32.5294661+09:00",
  "fingerprint": "60713029-5e16-41e6-8a79-d870f7797921",
  "windowsIdentity": "TEST\\testh",
  "machineName": "TEST",
  "fileName": "Main",
  "initiatedBy": "Studio",
  "processName": "変数一覧を取得",
  "processVersion": "1.0.6",
  "jobId": "3137a885-5a96-47f9-a1d3-a8e8769adeb9",
  "robotName": "s-takahashi@yamamoto-tile.biz-attended",
  "machineId": 3337341,
  "organizationUnitId": 4152162
}

ログレベル

ログ レベル既定のログユーザー定義のログ
OffNoneNone
CriticalCritical レベル以上で記録されたすべてのメッセージ。Critical レベル以上で記録されたすべてのメッセージ。
ErrorError レベル以上で記録されたすべてのメッセージ。Error レベル以上で記録されたすべてのメッセージ。
WarningWarning レベル以上で記録されたすべてのメッセージ。Warning レベル以上で記録されたすべてのメッセージ。
InformationInformation レベル以上で記録されたすべてのメッセージ。Information レベル以上で記録されたすべてのメッセージ。
Trace (トレース)Trace レベル以上で記録されたすべてのメッセージ。Trace レベル以上で記録されたすべてのメッセージ。
VerboseTrace レベルで記録されたすべてのメッセージとワークフロー トラッキング ログ。Trace レベルで記録されたすべてのメッセージ。

参考