トラブルシューティングツール

# ジョブのデバッグトレース

ネットワークトレースを利用して3分でエラーを解決

統合プロジェクトは、その性質上、複数のビジネスシステムを含む中程度から非常に高い複雑性を持つプロジェクトになります。Workato のような統合プラットフォームを使用することで、Salesforce、Workday、NetSuite、Marketo などのクラウドアプリケーション内のレコードに簡単に接続し、更新できるようになります。従業員のオンボーディング (人事) や見積りから入金までのプロセス (販売活動) などのさまざまなユースケースにおいて、Workday、Salesforce などの多くの業務システムとクラウドアプリケーションが一般に自動化の対象となります。このことは、レシピの作成中に HTTP 404 Not Found のようなエラーに遭遇した開発者やアナリストにとって課題となります。追加の情報がなければ、デバッグとトラブルシューティングは困難です。

# 概要

ジョブのデバッグトレースによって、アクション行ごとに詳細な HTTP リクエストとレスポンスを簡単に確認できるようになります。HTTP URL、リクエストとレスポンスのヘッダー、リクエストのペイロード、レスポンスなどの詳細を含め、開発者とアナリストが問題の根本原因を突き止めるための多数の詳細情報を利用できます。

レシピ内のアクション行ごとに、ジョブのデバッグトレースによって以下の情報が提供されます。

リクエスト先の HTTP URL
HTTP リクエストヘッダー
HTTP レスポンスヘッダー
HTTP リクエストペイロード
HTTP レスポンス

ジョブのデバッグトレースは、特定のユーザーが利用できます。詳細については、カスタマーサクセスマネージャーまでお問い合わせください。

# ジョブのデバッグトレースの有効化と無効化

ジョブのデバッグトレースを有効にするには、[Account Settings] > [Recipe Preferences] に移動します。[Enable network trace] を選択し、[Save] をクリックします。 ジョブのデバッグトレースの有効化

ジョブのデバッグトレースを無効にするには、[Account Settings] > [Recipe Preferences] に移動します。[Enable network trace] を選択解除し、[Save] をクリックします。 ジョブのデバッグトレースの無効化

# デバッグトレース権限

デフォルトでは、デバッグトレース権限は Admin ロールのユーザーまたは Workato アカウントの所有者であるユーザーに付与されます。

カスタムロールを作成して Debug Trace 権限を割り当てることもできます。カスタムロールを作成したら、チーム内のいずれかの開発者またはアナリストにそのカスタムロールを割り当てることができます。[Save] を選択して、カスタムロールに対する権限の割り当てを必ず保存してください。

デバッグトレース権限の割り当て ネットワークトレース権限の割り当て

ユーザーに対するカスタムロールの割り当て

# 機密データ

当社は、顧客にとってデータセキュリティが非常に重要であることを認識しています。また、権限のあるユーザーのみに機密データを表示するための制御が必要であることも理解しています。このため、最大限の柔軟性を提供するよう、2つのレベルの制御を用意しました。

第1に、いかなるユーザーもデバッグトレースを表示できないように、アカウントレベルでデバッグトレースを完全にオフにすることができます。詳細については、「ジョブのデバッグトレースの有効化と無効化」のセクションを参照してください。
第2に、デバッグトレースデータの表示権限を持つユーザーを制御できます。詳細については、「デバッグトレース権限」のセクションを参照してください。

# ジョブのデバッグトレースの表示

デバッグトレースまたはネットワークトレースは、以下の場合に利用できます。

レシピ編集モードでテストジョブを実行している場合。[TEST JOBS] タブでレシピをテストしているときは、開発中にネットワークトレースを表示できます。
ジョブを再実行する場合。成功したか失敗したかにかかわらず、完了したジョブは、ネットワークトレースを表示するために再実行することができます。

# テストレシピ

ネットワークトレースは、早期にエラーを検出し、回避することによって、レシピの堅牢性を高めるためのツールとなります。開発中に、[TEST JOBS] タブに移動し、[Test] ボタンをクリックして、レシピをテストすることができます。レシピのテストでは、レシピの機能と導入が検証されます。テストジョブを実行すると、[Debug] タブにネットワークトレースが表示されます。

開発者は、入力と出力だけでなく、アクションに対して実行された HTTP 呼び出しのネットワークトレースも確認できます。レシピアクションとエンドアプリケーション間を移動する HTTP ヘッダー、リクエスト、レスポンス内の情報をレビューし、検証することができます。

# アクションの HTTP リクエストの例

1 回の API 呼び出しを含むアクション テストジョブ - 新しい JIRA の課題を作成するアクションのネットワークトレース

2 回の API 呼び出しを含むアクション テストジョブ - Greenhouse で候補者を更新するアクションのネットワークトレース

アクションの実行時にアプリケーションに対して行われた API 呼び出しのヘッダー、リクエスト、レスポンスを含む HTTP ネットワークトレースを確認できます。これらのスクリーンショットは、HTTP リクエストで送受信されたヘッダー、リクエスト、レスポンスを示しています。

# 成功したアクションと HTTP リクエストの詳細

テストジョブ - アプリケーション API に送信された HTTP ヘッダー

テストジョブ - アプリケーション API に送信された HTTP リクエストペイロード

テストジョブ - アプリケーション API から受信した HTTP レスポンス

# 失敗したアクションと HTTP エラー

HTTP エラー テストジョブ - 失敗した HTTP リクエストと HTTP 400エラーコード

テストジョブ - アプリケーション API に送信された HTTP ヘッダー

テストジョブ - アプリケーション API に送信された HTTP リクエストペイロード

テストジョブ - アプリケーション API から受信した HTTP エラーレスポンス

# エラーがあるジョブ

以下の手順に従って、ジョブにエラーがあるレシピのデバッグトレースを生成し、表示します。

この例では、Update incident in ServiceNow にエラーのあるジョブが含まれています。

エラーがあるジョブ

デバッグトレースを表示するには、ジョブを再実行する必要があります。

# ジョブの再実行

デバッグトレースを生成するには、ジョブを再実行する必要があります。

ジョブの詳細ページで、[Repeat job] をクリックしてください。

ジョブの再実行

# ジョブのデバッグトレースの例

HTTP 404 Not Found、400 Bad Request、403 Forbidden のいずれかが表示されており、エラーに関する詳細情報が必要な場合は、ジョブのデバッグトレースを実行できます。以下に、ServiceNow 内のインシデントテーブルに対する更新が 404 Not Found エラーで失敗したシナリオの例を示します。この例を通して、ジョブのデバッグトレースで詳細情報を入手できることで、どのようにエラーの根本原因を迅速かつ効率的に理解できるようになるかがわかります。