エージェントログ
はじめに
プロセスの実行中、途中の各ステップのメッセージ (ログ) が生成されます。これらは収集され、ログ ファイル に保存されます。 ログを収集して保存する全体的な操作は、ロギングと呼ばれます。
このドキュメントでは、ログ レベルの概念とログを最大限に活用する方法について説明します。
ログ
akaBot のログは 2 つのグループに分類できます。
- **デフォルトのログ:**これらのログは、実行の開始/終了時、または実行でエラー/例外が発生して停止した時など、特定のイベントに対して自動生成されます。
- ユーザー定義ログ: これらのログは、アクティビティLog MessageまたはWriteLineを使用するときに RPA 開発者によって生成されます。
akaBot Studio では、[出力] パネルでログを表示できます。
ロギングレベル
ログ レベルは、ログ メッセージがプロセスの実行に関連する重要性を示します。ユーザーがアクティビティLog Messageを使用して定義できるログ レベルは次のとおりです。
| ロギングレベル | 意味 |
| 致命的 | ロボットはこのエラーから回復できないか、回復すべきではありません。何か重大な問題が発生したため、プロセスを停止する必要があります。 |
| エラー | エラーが発生しました。ロボットは回復して次の項目に進もうとします。詳細については、エラーコード表を参照してください。 |
| 警告する | 残りのログ情報から目立たせる必要がある重要なデータ。 |
| 情報 | ロボットの進歩に関する情報。通常、ワークフローに出入りするとき、外部ソースからデータを読み取るときなどが含まれます。 |
| トレース | 開発/デバッグ中には役立つ情報ですが、運用環境では役に立たず、必要とされません。 |
デフォルトでは、ログを情報レベルまで表示できます。つまり、情報レベル以上（警告、エラーなど）のログのみが出力パネルに表示されます。ログに表示される詳細を変更するには:
- akaBot Agentを開き、「設定」ボタンを選択します
- 設定画面で、「センター」タブを選択し、ログレベルを変更します。
ログの詳細がどのように表示されるか:
| ロギングレベル | デフォルトのログ | ユーザー定義のログ (ログ メッセージ アクティビティを使用) |
|---|---|---|
| オフ | なし | なし |
| 致命的 | すべてのメッセージは致命的レベル以上で記録されます。 | すべてのメッセージは致命的レベル以上で記録されます。 |
| エラー | エラー レベル以上のすべてのメッセージが記録されます。 | エラー レベル以上のすべてのメッセージが記録されます。 |
| 警告 | すべてのメッセージは Warn 以上で記録されます。 | すべてのメッセージは Warn 以上で記録されます。 |
| 情報 | すべてのメッセージは Info 以上で記録されます。 | すべてのメッセージは Info 以上で記録されます。 |
| デバッグ | すべてのメッセージはデバッグ レベル以上で記録されます。 | 手動では設定できません。 |
| 詳細 | すべてのメッセージは Verbose レベル以上で記録されます。 | すべてのメッセージはトレース レベル以上で記録されます。 |
ログの場所
ユーザーログ
これまでに学習したすべてのログは akaBot Studio に関連しており、プロセスの実行後に生成されます。これらは、ユーザーがたとえば akaBot Studio で [スタート] ボタンを押すなどして「作成」するため、ユーザー ログ として定義されます。これらのログは [出力] パネルに表示されますが、後で .txt ファイルとしてアクセスできます。フォルダーの場所を見つける方法はいくつかあります。
- ファイル エクスプローラーを開き、**%localappdata%\akaBot\Logs** に移動します。
- akaBot Agent で、[設定] ボタンを選択します。設定画面で、[その他] タブを選択し、現在のユーザー ログ の [フォルダーを開く] ボタンを選択します。
- akaBot Studio では、Ctrl+L の組み合わせを送信します。または、メニュー パネルの [ログを開く] ボタンをクリックします。
このフォルダー内のファイルの説明は次のとおりです。
| ファイル名/形式 | 意味 |
| log4net.db log4net.db-shm log4net.db-wal | これらのファイルは、アプリケーション ログを保存し、akaBot センターにプッシュするために必要です。ファイルは sqlite3 形式で保存されます。 |
| yyyy-mm-dd_BotService.log | このファイルには、akaBot Agent サービスのアプリケーション ログが含まれています。構成された各ユーザー ボットにはサービスのインスタンスがあります。 |
| yyyy-mm-dd_BotAgent.log | このファイルには、akaBot Agent UI のアプリケーション ログが含まれています |
| yyyy-mm-dd_BotExecutor.log | このファイルには、akaBot Agent エグゼキュータのアプリケーション ログが含まれています |
| yyyy-mm-dd_Studio.log | このファイルには akaBot Studio のアプリケーション ログが含まれています |
| yyyy-mm-dd_hhmmss_Agent_<projectName>.log | このファイルには、akaBot Agent によって実行されたワークフロー ログが含まれています |
| yyyy-mm-dd_hhmmss_Studio_<projectName>.log | このファイルには、akaBot Studio によって実行されたワークフロー ログが含まれています |
マシンログ
定義: 更新
これらのログは次の方法で見つけることができます。
- ファイル エクスプローラーを開き、**%programdata%\akaBot\Logs** に移動します。
- akaBot Agent で、[設定] ボタンを選択します。設定画面で、[その他] タブを選択し、マシン ログ の [フォルダーを開く] ボタンを選択します。
このフォルダー内のファイルの説明は次のとおりです。
| ファイル名/形式 | 意味 |
| log4net.db log4net.db-shm log4net.db-wal | これらのファイルは、アプリケーション ログを保存し、akaBot センターにプッシュするために必要です。ファイルは sqlite3 形式で保存されます。 |
| yyyy-mm-dd_BotService.log | このファイルには、akaBot Agent サービスのアプリケーション ログが含まれています。 |
| yyyy-mm-dd_msiexec.log | このファイルには、akaBot のインストール ログが含まれています。 |
| yyyy-mm-dd_AutoLogonChecker.log | このファイルには、自動ログオン チェッカー モジュールのアプリケーション ログが含まれています。 |
エラーコード
次のリストでは、システム エラー コードについて説明します。これらは、多くの関数が失敗した場合に GetLastError 関数によって返されます。アプリケーションのエラーの説明テキストを取得するには、FORMAT_MESSAGE_FROM_SYSTEM フラグを指定して FormatMessage 関数を使用します。
| エラー名 | コード |
|---|---|
| エラー | -1 |
| 成功 | 0 |
| エラー_APPDATA_PATH_NOT_EXIST | 100 |
| エラー_違法_ファイル | 101 |
| エラー_無効_ARGS | 102 |
| エラー_無効_ENV | 103 |
| エラー_ロード_プラグイン | 104 |
| エラー_READ_XAML_FAILED | 105 |
| エラー_ワークフロー_中止されました | 106 |
| エラー_ワークフロー_キャンセル | 107 |
| エラー_ワークフロー_例外 | 108 |
| エラー_ワークフロー_FAULTED | 109 |
| エラー_設定_NOT_FOUND | 110 |
| エラー_ライセンス_エラー | 111 |
| エラー_INSTANCE_NOT_INITIALIZED | 200 |
| エラー_PROXY_SETTING_NOT_VALID | 201 |
| エラー_CONNECT_TO_SERVER_TIMEOUT | 202 |
| エラー_リクエスト_TO_SERVER_FAILED | 204 |
| エラー_認証_失敗 | 205 |
| エラー_HTTP_中止されました | 206 |
| エラー_HTTP_エラー | 207 |
| エラー_HTTP_タイムアウト | 208 |
| エラー_サーバー_リターン_無効_トークン | 209 |
| エラー_不明_例外 | 211 |
| エラー_未処理_例外 | 212 |
| エラー_WCF_REQUEST_FAILED | 213 |
| エラー_SERVER_CANNOT_BE_REACHED | 214 |
| エラー_NOT_AUTHENTICATED_TO_SERVER | 215 |
| エラー_USERNAME_CANNOT_NULL_EMPTY | 216 |
| エラー_PASSWORD_CANNOT_NULL_EMPTY | 217 |
| エラー_USERNAME_PASSWORD_CANNOT_NULL_EMPTY | 218 |
| エラー_SESSION_FOR_USERNAME_ALREADY_EXIST | 219 |
| エラー_SESSION_OF_USERNAME_NOT_EXIST | 220 |
| エラー_設定_対象_USER_NOT_FOUND | 221 |
| エラー_タイムアウト_必須_大きい_THAN_ZERO | 222 |
| エラー_LOAD_SETTING_FILE_FAILED | 223 |
| エラー_HTTP_FORBIDDEN | 224 |
| エラー_HTTP_UNAUTHORIZED | 225 |
| エラー_SET_LOG_LEVEL_FAILED | 226 |
| エラー_SET_BOT_CONFIG_FAILED | 227 |
| エラー_ALREADY_CONNECT_TO_SERVER | 228 |
| エラー_ARGUMENT_CANNOT_BE_NULL | 229 |
| エラー_AGENT_IS_BUSY | 230 |
| エラー_タスク_ALREADY_EXECUTED | 231 |
| エラー_タスク_コマンド_無効 | 232 |
| エラー_タスク_状態_無効 | 233 |
| エラー_サービス_未_インストール済み | 234 |
| エラー_サービス_非_実行中 | 235 |
| エラー_INVALID_LOG_OBJECT_FORMAT | 236 |
| エラー_無効_APPDATA_PATH | 237 |
| エラー_無効_プログラムデータ_パス | 238 |
| エラー_プログラムデータ_パス_NOT_EXIST | 239 |
| エラー_センター_設定_できません_BE_NULL | 240 |
| エラー_PROXY_SETTING_CANNOT_BE_NULL | 241 |
| エラー_MACHINE_NAME_IS_EMPTY | 242 |
| エラー_INVALID_AGENT_KEY | 243 |
| エラー_無効_センター_URL | 244 |
| エラー_INVALID_PROXY_PORT | 245 |
| エラー_無効_USERNAME | 246 |
| エラー_無効_パスワード | 247 |
| エラー_INVALID_PROXY_URL | 248 |
| エラー_GET_SERVICE_PORT_FAILED | 249 |
| エラー_START_USER_SERVICE_FAILED | 250 |
| エラー_SYSTEM_SERVICE_ON_START_EXCEPTION | 251 |
| エラー_SHUTDOWN_USER_SERVICE_FAILED | 252 |
| エラー_SYSTEM_SERVICE_ON_STOP_EXCEPTION | 253 |
| エラー_SYSTEM_SERVICE_ON_CHANGE_EXCEPTION | 254 |
| エラー_登録_ユーザー_サービス_失敗 | 255 |
| エラー_UNREGISTER_USER_SERVICE_FAILED | 256 |
| エラー_リクエスト_UNLOCK_FAILED | 257 |
| エラー_通知_ユーザー_サービス_変更_失敗 | 258 |
| エラー_ENABLE_AUTOLOGON_MODULE_FAILED | 259 |
| エラー_ディレクトリ_NOT_EXIST | 260 |
| エラー_ファイル_NOT_FOUND | 261 |