ログ監視の利用

ログ監視の利用

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

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

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

ログ監視を使用する理由    

ログ監視を使用すると、次のことができます。

  • 失敗した実行の調査

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

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

  • API活動の追跡

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

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

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

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

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

前提条件 

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

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

  1. Qntrlにログインします。

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

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

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

  5. プロフィールを[保存]します。

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

ログの種類の概要      

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

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

モジュール

アクセス

アプリケーション

実行

スケジュール

カード

サーキット

サーキットの状態

関数

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スクリプト、スクリプト、Bridgeメッセージによって実行中に生成されたメッセージを表示できます。

利用可能なデータ   

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

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

利用例   

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

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

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

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

  • 実行失敗の調査


関数を実行する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サービスによって実行された処理が記録されます。
Notes

実行ログには、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を共有するため、モジュールをまたいだ完全な実行パスを簡単にトレースできます。

親アクセスIDを使用した親実行のトレース     

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

例:

カード

└── ビジネスルール

└── Webhook

└── サーキット

└── Circuit

└── 関数

コンポーネント

親アクセスID

カード

なし

ビジネスルール

カードのアクセスID

Circuit

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

Webhook

CircuitのアクセスID

親アクセスIDは、実行階層の再構築やコンポーネント間の関連の把握に役立ちます。


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

[アプリケーションログ]アイコン を使用すると、アプリケーションログを生成した実行を特定したり、実行中に生成されたすべてのスクリプトログを表示したりできます。この機能は、関数やCodeXなどのスクリプトベースのモジュールで利用できます。

次のログの関連付けに役立ちます。
  • アプリケーションログ

  • アクセスログ

  • 実行ログ

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


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

ロガーメッセージを使用して検索する場合は、次の手順を実行します。

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

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

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

次の情報の確認に役立ちます。

  • 実行の詳細

  • 要求情報

  • 実行ステータス

  • 実行時間

  • 関連メタデータ

 

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

アクセスログまたは実行ログを表示している場合は、次の手順を実行します。

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

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

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


制限事項   

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

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

クエリーで想定されるログが返されない場合は、次の操作を行います。
  • クエリー条件が正しいことを確認します。

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

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