ログ監視の使用

ログ監視の使用

お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

このログ監視モジュールでは、Qntrlポータル全体の活動を一元的に確認できます。管理者、開発者、運用チームは、実行状況の監視、問題のトラブルシューティング、システム動作の分析を行えます。

ビジネスプロセスが、ビジネスルール、関数、CodeX、Circuits、Webhook、Bridgeメッセージ、スケジューラーなどのコンポーネントを通じて実行されると、対応している活動のログデータが生成されます。これらのログはインデックス化され、単一の操作画面から検索、分析、追跡できるようになります。

ログ監視を使用する理由    

ログ監視では、次のことができます。

  • 失敗した実行の調査

  • ワークフローと自動化の活動の監視

  • カスタムスクリプトと関数のデバッグ

  • API活動の追跡

  • 実行パフォーマンスの分析

  • コンポーネント間の関係の追跡

  • 異常な活動パターンの特定

  • 重要なイベントやしきい値超過に対するアラートの作成

対応しているすべてのモジュールのログが1か所に統合されるため、複数のモジュールを移動しなくても問題を調査しやすくなります。

前提条件 

ログと監視にアクセスするには、ユーザーの組織プロファイルでシステムログの表示権限が有効になっている必要があります。

この権限を付与するには、次の手順を実行します。

  1. [設定]→[ユーザー管理]→[組織プロファイル]に移動します。

  2. 左側のペインから、対象の組織プロファイルを選択します。

  3. ユーザーログ権限で、システムログの表示を有効にします。

  4.  [保存]をクリックして、プロファイルを保存します。

Notes

システムログの表示権限が有効なプロファイルが割り当てられているユーザーのみ、ログと監視モジュールでログにアクセスして検索できます。


ログの種類の概要      

ログは、記録される活動の種類に基づいて分類されます。各ログの種類では、特定のQntrlモジュールから情報が取得されます。

ログの種類別の対応モジュール   

モジュール

アクセス

アプリケーション

実行

スケジュール

カード

Circuits

Circuit States

関数

CodeX

CodeX SDK

スクリプト

ブリッジメッセージ

メッセージ

(実行)

ビジネスルール

ウェブフック

遷移

スケジューラー

その他のモジュール

(APIのみ)

 

アクセス 

アクセスログを使用すると、Qntrlに送信されるAPIリクエストと、対応しているWeb経由のアクティビティを監視できます。  

アクセスログには次の内容が記録されます。

  • Postman、アプリケーション、AIエージェントなどの外部クライアントからのリクエストを含む、Qntrlに対するすべてのAPIリクエスト。

  • QntrlのWebアプリケーションで実行された、対応しているユーザー操作。


Notes
Web経由で実行されたすべてのアクティビティがアクセスログに記録されるわけではありません。対応しているユーザー操作は次のもののみです。

 

モジュール

Web

API

カード

作成、更新、削除

はい

サーキット

作成、更新、削除、サーキットの実行

はい

関数

作成、更新、削除、関数の実行

はい

メッセージ

実行のみ

はい

その他のモジュール

いいえ

はい

  

利用可能なデータ    

アクセスログでは、各リクエストについて次の情報を確認できます。

  • ログの詳細:ログの種類、モジュール、タイムスタンプ、リモートIPアドレス

  • リクエストの詳細:HTTPメソッド、リクエストURL、応答ステータスコード、ZUID

  • パラメーターの詳細:パラメーター名と値、機密性の高いパラメーター値はマスクされます

  

活用例    

  • APIアクティビティの監査

  • 失敗した要求のトラブルシューティング

  • 要求と応答の動作の分析

  • カード、Circuit、関数、メッセージの実行アクティビティの調査

  • Qntrl Webアプリケーションで実行されたサポート対象のユーザー操作の追跡

 

アプリケーション  

アプリケーションログを使用すると、関数、CodeXスクリプト、スクリプト、ブリッジメッセージの実行中に生成されたメッセージを表示できます。

利用可能なデータ   

  • ログの詳細:ログの種類、モジュール、タイムスタンプ、ログレベル(INFO、ERROR、WARNING)

  • メッセージの詳細実行中に生成されたメッセージの内容

 

活用例   

  • 実行中に生成された特定のメッセージの検索

  • エラーや例外の迅速な特定

  • 関数、CodeXスクリプト、ブリッジメッセージのデバッグ

  • 実行フローと実行時の動作の追跡

  • 実行失敗の調査

 

関数を実行するCircuitを考えてみます。

関数に次のステートメントが含まれているとします。

console.log('File download started');
console.error('Unable to download file');
console.warn('File size exceeds recommended limit');

生成されたメッセージはアプリケーションログに記録されます。

特定のメッセージを検索するには:

logtype='application' and message contains 'Unable to download file'

すべてのエラーメッセージを検索するには:

logtype='application' and level contains 'error'

 

実行 

実行ログを使用すると、Qntrlのバックエンド自動化コンポーネントの実行ステータスを監視できます。実行ログには、ユーザーが直接操作せずにQntrlサービスによって実行された処理が記録されます。
Info

実行ログには、ZUIDやリモートIPアドレスなどのユーザー固有の情報は含まれません。

 


利用可能なデータ   

  • 実行の詳細ログの種類、モジュール、ステータス(成功または失敗)、タイムスタンプ

  

活用例   

実行ログでは、次のことができます。

  • 自動化が正常に実行されたかどうかの確認

  • ビジネスルール、Circuit、関数、Webhookの失敗の調査

  • 自動化の実行動作の分析

  • バックエンドワークフローアクティビティの追跡

  • 実行履歴の監視

 

  

次の自動化フローをトリガーするカード更新を考えてみます。

カード更新
└─ ビジネスルール
└─ Circuit
└─ 関数
└─ Webhook

各自動化の実行は、実行ログとして記録されます。

実行ログを使用すると、次のことを確認できます。

  • 実行されたコンポーネント

  • 実行が成功したか失敗したか

  • 実行が発生した日時

 

スケジュール  

スケジュールログを使用すると、Qntrlスケジューラーによってトリガーされた実行を監視できます。  

利用可能なデータ   

  • 実行の詳細ログの種類、モジュール、ステータス(成功または失敗)、タイムスタンプ

 

活用例   

スケジュールログでは、次のことができます。

  • スケジュール済みタスクが正常に実行されたかどうかの確認

  • スケジューラーの失敗の調査

  • 繰り返しタスクの実行の監視

  • スケジュール実行履歴の追跡

 

  

毎日午前9時にCircuitを実行するよう設定されたスケジューラーを考えてみます。

スケジュールされた各実行では、次の内容を示すスケジュールログが生成されます。

  • スケジューラーがトリガーされた日時

  • 実行が成功したか失敗したか

  • 実行タイムスタンプ

スケジュールログを使用すると、スケジュール済みの自動化が想定どおりに実行されていることを確認できます。


ログの検索 

ログページのクエリービルダーを使用して、ログの種類、モジュール、ステータス、期間に基づいてログを検索できます。

クエリーの作成 

  1. Qntrlにログインします。
  2. 次の順に[設定][ログ監視][システムログ]に移動します。
  3. 次のいずれかの方法(フィルター/クエリーエディター)でクエリーを作成できます。
    1. フィルター–一般的なログ検索用のクエリーを作成するには、利用可能なフィルターを使用します。フィルターを選択すると、対応するクエリーが自動的に生成されます。
      1. [ログの種類]–検索するログの種類を選択します。詳細については、ログの種類についてを参照してください。
      2. [モジュール]–ログを取得するモジュールを選択します。
      3. [ステータス]–次のいずれかを選択します。
        1. 成功
        2. 失敗
      4. [期間]–事前定義された期間を選択するか、カスタム期間を指定します。
      5. 選択したフィルターをリセットして新しいクエリーを作成するには、[すべてクリア]を使用します。
    2. クエリーエディター–高度な検索を実行し、カスタム検索条件を定義するには、クエリーエディターにクエリーを手動で入力できます。詳細については、クエリーの自動候補高度な検索を参照してください。
      1. 複数の条件を使用して検索できます。
      2. 対応している演算子と関数を使用できます。
      3. フィルターでは利用できない項目をクエリーに使用できます。
      4. 複雑なログ検索を作成できます。
  4. クエリーを実行するには、[Enter]アイコン をクリックします。


Notes
期間は期間フィルターを使用して適用され、クエリーには含まれません。

1:成功した CodeX の実行の検索

今日の成功した CodeX の実行を表示するには、次のフィルターを使用します。

  • [ログの種類]:実行

  • [モジュール]:CodeX

  • [ステータス]:成功

  • [期間]:今日  

対応するクエリーは次のとおりです。

 logtype = 'execute' and module contains 'codex' and status contains 'success'



例2:複数のモジュールにわたる失敗した実行の検索  

過去1週間の CodeX と Functions の失敗した実行を表示するには、次のフィルターを使用します。

  • [ログの種類]:実行

  • [モジュール]:CodeX、Functions

  • [ステータス]:失敗

  • [期間]:カスタム範囲(過去7日間)

logtype = 'execute' and module in ('codex' , 'function') and status contains 'failed'

 

自動候補   

クエリーエディターでは、クエリーの作成中に、対応しているログの種類、項目、演算子、値の候補が自動的に表示されます。

利用可能な候補を表示するには、クエリーエディターにカーソルを置き、スペースバーキーを押します。

自動候補を使用すると、次のことができます。

  • 利用可能な項目の確認

  • 対応している値の特定

  • クエリーの迅速な作成

  • 構文エラーの回避

詳細については、自動候補とクエリー言語を参照してください。




クエリー結果の表示   

クエリーを実行すると、一致するログが表に表示されます。

次の操作が可能です。

  1. 結果の並べ替え:
    1. [新しい順]
    2. [古い順]
  2. ページネーション操作を使用した結果の移動
    1. 初期設定:1ページあたり10件のログ
    2. 上限:1ページあたり60件のログ



クエリーの保存   

保存したクエリーを使用すると、よく使う検索にすばやくアクセスできます。

クエリーを保存するには。

  1. クエリーを作成して実行します。

  2. クエリーを保存]をクリックします。

  3. 生成されたクエリーを確認します。

  4. クエリー名を入力します。

  5. 保存]をクリックします。

保存済みクエリーは、[保存済みクエリー]のドロップダウンからアクセスできます。



Info
  • 保存されるのはクエリー定義のみです。時間ベースのフィルターは保存されないため、クエリーを実行するたびに選択する必要があります。

  • 変更した保存済みクエリーは、新しいクエリーとしてのみ保存できます。

  • クエリー名のみ、[保存済みクエリー]のドロップダウン内のクエリー名の横にある編集アイコンで編集できます。

  • 保存済みクエリーは組織全体で共有されます。

  • ログへのアクセス権を持つユーザーは、組織内で作成された保存済みクエリーを表示できます。

  

その他の操作    

アラートの作成   

アラートを使用すると、特定のログ条件を監視し、一致するイベントが発生したときに通知を受け取れます。

アラートを作成するには、次の手順を実行します。

  1. クエリーを作成します。

  2. アラートを作成]をクリックします。

  3. [アラート]ページでアラートを設定します。

詳しい手順については、アラートを参照してください。


結果の更新   

更新]をクリックすると、現在のクエリーを再実行し、一致する最新のログを取得できます。


ポータル時刻の表示   

ページ上部に表示される時刻は、ポータルに設定されているタイムゾーンに基づいています。




ログの表示とデバッグ

各ログエントリーには、実行の調査、コンポーネント間の関係の追跡、問題のデバッグに役立つ操作が含まれています。

各ログエントリーの横で、次の操作を使用できます。

  • ログ詳細 :選択したログエントリーの詳細情報を表示します。詳細については、ログ詳細の表示を参照してください。

  • トレースツリー 実行フローをトレースし、コンポーネント間の関係を把握できます。詳細については、トレースツリーの表示を参照してください。

  • 関連ログ :アプリケーションログ、アクセスログ、実行ログ間を移動します。この操作は、FunctionsやCodeXなどのスクリプトベースのモジュールでのみ使用できます。詳細については、関連ログの表示を参照してください。



ログ詳細の表示  

ログ詳細アイコンを使用すると、ログエントリーを確認し、要求または実行が成功した、失敗した、または想定外の動作をした理由を把握できます。

確認できる情報  

ログ詳細ウィンドウでは、選択したログエントリーに関する詳細情報(以下を含む)を確認できます。

  • ログの種類

  • モジュール

  • タイムスタンプ

  • メッセージ

  • パラメーター

  • 相関ID

  • 要求パラメーター

  • リモートIP

  • 実行に関する追加の詳細

この情報は、問題の原因の特定や実行時の動作の分析に役立ちます。  

ツリーの表示

トレースツリーは、ログ詳細ウィンドウで[ツリーを表示]をクリックすると直接開けます。これにより、実行フローやコンポーネント間の関係を視覚的に確認できます。  

アラートの作成   

  • [アラートを作成]ログ詳細ウィンドウの下部でクリックして、選択したログアクティビティのアラートを作成します。

  • アラート設定ページが開き、関連するクエリーの詳細があらかじめ入力されているため、通知と監視をすばやく設定できます。 

  • 詳しい設定手順については、アラートを参照してください。

 

トレースツリーの表示  

実行時のコンポーネント間の連携や、プロセスのトリガーとなったものを把握するには、トレースツリーアイコンを使用します。

複雑なビジネスプロセスでは、多くの場合、複数のコンポーネントが相互にトリガーされます。

例:

カード

└── ビジネスルール

└── Webhook

└── サーキット

└── サーキット

└── 関数

トレースツリーでは、これらの関係が階層的に表示され、実行パス全体を把握できます。

トレースツリーには、実行フローの分析に役立つ以下の操作が用意されています。

[親を開く][子を開く]     

  • [親を開く]:現在の実行を開始したコンポーネントが表示されます。  

  • [子を開く]:選択したコンポーネントによって実行されたコンポーネントが表示されます。

ログ詳細の表示 

トレースツリー内の任意のコンポーネントをクリックすると、そのログ詳細が開き、トラブルシューティングのために実行情報を確認できます。


アラートの作成   

選択したログのアラートは、ログ詳細ウィンドウから直接作成できます。

[アラートを作成]をクリックして、アラート設定ページを開きます。このページには、関連するクエリーの詳細があらかじめ入力されています。成功または失敗した実行について通知を受け取るようにアラートを設定します。

アラートの設定についての詳細は、アラートを参照してください。

QThread IDを使用したログのトレース     

QThread ID(qthread_id)を使用すると、同じ実行フローに属するすべてのログを特定してトレースできます。

ビジネスプロセスには、ビジネスルール、サーキット、Webhook、関数など複数のコンポーネントが含まれる場合があります。関連するすべての活動は同じQThread IDを共有するため、モジュール間で実行パス全体を簡単にトレースできます。

Parent Access IDを使用した親実行のトレース     

現在の実行を直接トリガーしたコンポーネントを特定するには、親アクセスID(parent_access_id)を使用します。

例。

カード

└── ビジネスルール

└── Webhook

└── Circuit

└── Circuit

└── 関数

コンポーネント

親アクセスID

カード

なし

ビジネスルール

カードのアクセスID

Circuit

ビジネスルールのアクセスID

Webhook

CircuitのアクセスID

親アクセスIDは、実行階層を再構築し、コンポーネント同士の接続関係を把握するのに役立ちます。


アプリケーションログの表示 

アプリケーションログ]アイコン を使用して、アプリケーションログを生成した実行を特定したり、実行中に生成されたすべてのスクリプトログを表示したりします。

この機能は、関数やCodeXなどのスクリプトベースのモジュールで利用できます。

以下の関連付けに役立ちます。

  • アプリケーションログ

  • アクセスログ

  • 実行ログ

また、スクリプトの実行と関連ログの関係を把握するのにも役立ちます。


アプリケーションログから実行ログへ   

ロガーメッセージを使用して検索する場合。

  1. 一致するログを見つけます。

  2. アプリケーションログ]アイコン  をクリックします。

  3. そのメッセージを生成したアクセスログまたは実行ログを開きます。

以下の特定に役立ちます。

  • 実行の詳細

  • リクエスト情報

  • 実行ステータス

  • 実行時間

  • 関連メタデータ

 

実行ログからアプリケーションログへ   

アクセスログまたは実行ログを表示する場合。

  1. 関連ログ]アイコン をクリックします。

  2. その実行中に生成されたすべてのアプリケーションログを表示します。

これにより、イベントの順序を把握し、問題が発生したステップをすばやく特定できます。    


制限事項   

ログのインデックス作成の遅延   

ログデータは、検索できるようになる前にインデックス化されます。そのため、新しく生成されたログが検索結果に表示されるまで数秒かかる場合があります。

クエリーで想定したログが返されない場合。

  • クエリー条件が正しいことを確認します。

  • 数秒待ってから、クエリーを再実行します。

それでもログが利用できない場合は、Qntrlサポートにお問い合わせください。