Robot ガイド

最終更新日時 2024年11月11日

ログとログレベル

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

各ログには、生成されたメッセージの詳細度を示すログレベルがあります。

ログレベルは、ログファイルに書き込まれる重要度の種類を示します。

UiPath のログレベル

ログレベル	ログ出力される対象	例/コメント	ログファイル	出力パネル	Orchestrator ログページ
Verbose	アクティビティ	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"}	はい	いいえ	はい
Verbose	変数	"Variables":{"NewTransaction":"False"}}	はい	いいえ	はい
Verbose	引数 (プロパティ)	"Arguments":{"Caption":"","Text":"String in message BOX","ChosenButton":"Ok"}	はい	いいえ	はい
Trace (トレース)	アクティビティ	Trace {"message":{"DisplayName":"Main","State":"Executing","Activity":"System.Activities.DynamicActivity"} Trace {"message":{"DisplayName":"Main","State":"Executing","Activity":"System.Activities.Statements.Flowchart"}	はい	いいえ	はい
Trace (トレース)	1 行を書き込み	Trace {"message":"write","level":"Trace","logType":"User","timeStamp":"","fingerprint":"","windowsIdentity":"","machineName":"","processName":"New Process","processVersion":"","jobId":"","robotName":"","machineId":,"organizationUnitId":}	はい	はい	はい
Information	メッセージをログ	Info {"message":"message from activity" 注: アクティビティに設定された Trace レベルで記録されたメッセージは除きます。
Warning	Warning	Warn {"message":"Warning from log message activity"	はい	はい	はい
Warning	Error	Error {"message":"Error from log message activity"	はい	はい	はい
Warning	Critical	重大なエラー	はい	はい	はい
Error	Error	Error {"message":"Error from log message activity"	はい	はい	はい
Error	CriticalFatal	重大なエラー	はい	はい	はい
Critical	CriticalFatal	重大なエラー	はい	はい	はい
OFF	なし	なし	いいえ	いいえ	いいえ

UiPath のログレベル

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

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

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

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

注: ログの種類の優先度順は、Verbose < Trace < Information < Warning < Error < Critical < Off です。

ログの PII 情報について

`Information`、`Warning`、`Error`、`Critical`

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

`Verbose` および `Trace`

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

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

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

また、アクティビティの [プライベート] チェックボックスをオンにしても同じ結果が得られます。機密情報の保護の詳細については、こちらをご覧ください。

"excludedLoggedData": [
      "Private:*",
      "<em>password</em>"
    ],"excludedLoggedData": [
      "Private:*",
      "<em>password</em>"
    ],

ログの種類

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

既定 (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)
アクティビティ
引数

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

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

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

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