通知を受け取る

UiPath Robot

UiPath Robot ガイド

ログとログ レベル

説明

プロセスの実行中、ロボットは途中でステップごとにメッセージ (ログ) を生成します。これらは収集され、ログ ファイルに保存されます。このログを収集し保存する操作全体は、ログ記録と呼ばれています。

ログには、生成されたメッセージの詳細度を示すログ レベルがあります。
ログ レベルは、ログ ファイルに書き込まれる重要度の種類を示します。

UiPath のログ レベル

Log Level

Logged

Example / Comment

Log File

Output Panel

Orchestrator Log page

Verbose

Activities

Trace {"message":{"DisplayName":"Message box","State":"Executing","Activity":"UiPath.Dialog.Activities.MessageBox","Arguments":{"Caption":"","Text":"String in message BOX"}...
Trace {"message":{"DisplayName":"Message box","State":"Closed","Activity":"UiPath.Dialog.Activities.MessageBox","Arguments":{"Caption":"","Text":"String in message BOX","ChosenButton":"Ok"}

Yes

No

Yes

Verbose

Variables

"Variables":{"NewTransaction":"False"}}

Yes

No

Yes

Verbose

Arguments (properties)

"Arguments":{"Caption":"","Text":"String in message BOX","ChosenButton":"Ok"}

Yes

No

Yes

Trace

Activities

Trace {"message":{"DisplayName":"Main","State":"Executing","Activity":"System.Activities.DynamicActivity"}
Trace {"message":{"DisplayName":"Main","State":"Executing","Activity":"System.Activities.Statements.Flowchart"}

Yes

No

Yes

Trace

WriteLine

Trace {"message":"write","level":"Trace","logType":"User","timeStamp":"","fingerprint":"","windowsIdentity":"","machineName":"","processName":"New Process","processVersion":"","jobId":"","robotName":"","machineId":,"organizationUnitId":}

Yes

Yes

Yes

Information

Log Message

Info {"message":"message from activity"
Note: Except messages logged with Trace level set in activity.

Warning

Warnings

Warn {"message":"Warning from log message activity"

Yes

Yes

Yes

Warning

Errors

Error {"message":"Error from log message activity"

Yes

Yes

Yes

Warning

Critical

Critical Errors

Yes

Yes

Yes

Error

Errors

Error {"message":"Error from log message activity"

Yes

Yes

Yes

Error

Critical
Fatal

Critical Errors

Yes

Yes

Yes

Critical

Critical
Fatal

Critical Errors

Yes

Yes

Yes

OFF

n/a

n/a

No

No

No

UiPath のログ レベル

Logging Level

Default Logs

User-Defined Logs

Off

None

None

Critical

All messages logged with Critical level or higher.

All messages logged with Critical level or higher.

Error

All messages logged with Error level or higher.

All messages logged with Error level or higher.

Warning

All messages logged with Warning or higher.

All messages logged with Warning or higher.

Information

All messages logged with Information or higher.

All messages logged with Information or higher.

Trace

All messages logged with Trace level or higher.

All messages logged with Trace level or higher.

Verbose

All messages logged with Trace level and Workflow Tracking logs.

All messages logged with Trace level.

Verbose レベルでは、アクティビティの開始終了の両方のメッセージ、および使用される変数および引数の値が記録されます。

既定では、Verbose レベルには以下が含まれます。

  • Execution Starated ログ エントリ - プロセスが開始されるたびに生成されます。
  • Execution Ended ログ エントリ - プロセスが終了するたびに生成されます。
  • Transaction Started ログ エントリ - ロボットが Orchestrator からトランザクション アイテムを取得するたびに生成されます。
  • Transaction Ended ログ エントリ - ロボットがトランザクション ステータスを Success または Failed のいずれかに設定するたびに生成されます。
  • Activity Information ログ エントリ - プロセス内で、アクティビティが開始失敗または完了されるたびに生成されます。

📘

注:

ログの種類の優先順位は次のとおりです。Verbose < Trace < Information < Warning < Error < Critical < Off

ログの PII 情報について

InformationWarningErrorCritical

InformationWarningErrorCritical ログ レベルの使用時には、入力/出力引数の値は追跡されません。つまり、Studio から明示的に追加しない限り、PII 情報は Orchestrator のログに送信されません。

Trace ] と [ Verbose

Trace および Verbose ログ レベルの使用時には、入力/出力引数の値が追跡され Orchestrator のログに書き込まれます。これらの値に PII 情報が含まれていた場合、それらの情報は Orchestrator のログに追加されます。

excludeLoggedData を使用して機密情報を非表示にする

excludedLoggedData 変数を使用すると、Verbose レベルで変数や引数の値がログ出力されないようにするためのキーワードを追加できます。

That can also be achieved by selecting the Private checkbox of any activity. Read more about the protection of sensitive information here.

"excludedLoggedData": [
      "Private:*",
      "*password*"
    ],

ログの種類

次に示すように、記録されるイベントに応じて、いくつかのログ メッセージが出現する可能性があります。

既定 (Default)

既定では、プロセスの実行が開始されたとき、および終了したとき、システム エラーが発生して実行が停止したとき、またはログ設定がすべてのアクティビティの実行を記録するように構成されているときに生成されます。

📘

注:

これらのログは、[logType] フィールドに Default 値を持ちます。

このカテゴリで記録されるイベントは、次のとおりです。

  • Execution Start はプロセスが開始されるたびに生成されます。これは、Information のログ レベルから記録されます。
  • Execution End はプロセスが終了するたびに生成されます。これは、Information ログ レベルから記録されます。
  • Transaction Started はプロセス内のトランザクションが開始されるたびに生成されます。これは、Information のログ レベルから記録されます。
  • Transaction Ended はプロセス内のトランザクションが終了するたびに生成されます。これは、Information のログ レベルから記録されます。
  • Error Log は、実行がエラーを検出して停止するたびに生成されます。これは、Error のログ レベルから記録されます。
  • Debugging Log は、ロボットのログ設定が Verbose に設定され、アクティビティ名や型、変数値、引数などが含まれている場合に生成されます。これは Trace のログ レベルからログに記録されます。

ユーザー定義

[メッセージをログ] アクティビティまたは [1 行を書き込み] アクティビティを使用する場合、Studio でユーザーが設計したプロセスに従って生成されます。

📘

注:

これらのログは、[logType] フィールドに User 値を持ちます。

ログ フィールド

上記のログ メッセージの種類には、複数の種類のログ フィールドがあります。これらは次のように分類できます。

既定のフィールド

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

📘

注:

プロセスが Orchestrator に接続されずにローカルで実行されている場合、processName フィールドと processVersion フィールドはログに表示されません。

種類固有のフィールド

これらのログは、ログの種類に応じて表示されます。

Execution End

  • totalExecutionTimeInSeconds
  • totalExecutionTime

Transaction Start

  • queueName
  • transactionID
  • transactionState

Transaction End

  • queueName
  • transactionID
  • transactionState
  • transactionStatus
  • トランザクション実行時間
  • ProcessingExceptionType
  • processingExceptionReason
  • queueItemReviewStatus
  • queueItemPriority

Debugging Log

activityInfo は次のフィールドを持つ JSON メッセージです。

  • 表示名
  • ステート (Faulted、Closed、Executing)
  • アクティビティ
  • 引数

📘

注:

ログ メッセージに常に表示されるのは、totalExecutionTimeInSecondstotalExecutionTimequeueName のみです。通常、Variables および Arguments にはサブフィールドがあります。

ユーザー定義のフィールド

これらのフィールドは、Studio 上で [ログ フィールドを追加] アクティビティを使用して定義されます。[ログ フィールドを削除] アクティビティによって削除されない限り、その後すべてのログに表示されます。

📘

重要

カスタム ログ フィールドを定義する際は、既定のログ フィールドの名前も確認するようにしてください。これは、ログ ファイル内の同一のログ フィールドで情報が競合したり、ログ ファイルが破損したりしないようにするためです。カスタム既定のログ フィールドの両方に同じ命名規則を使用すると、実行するプロセスにも影響が出る可能性があります。

3 か月前に更新



ログとログ レベル


改善の提案は、API リファレンスのページでは制限されています

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