メインコンテンツへスキップ
お客様により信頼性が高くスケーラブルなソリューションを提供するため、Auth0 では Tenant Logs Search Engine v2 を非推奨とし、v3 への移行を進めています。 Auth0 はこの変更の影響を受けないお客様を事前に移行し、影響を受ける可能性があるお客様には、案内された猶予期間内に v3 へオプトインするよう通知しています。

​
影響を受ける対象

以下の条件をすべて満たす場合、影響を受けます。
  • 2019 年 5 月 21 日以前に作成されたテナント
  • AU または EU リージョンの Auth0 のパブリッククラウドでホストされているテナント
  • include_totals=true パラメーターまたは q パラメーターを指定して、GET /api/v2/logs または GET /api/v2/users/{user_id}/logs エンドポイントを使用している。
  • 1000 件を超える結果に対してページネーションを行っている。
  • Delegated Admin Extension を使用している。古いバージョンの拡張機能は、テナントが Logs Search Engine v3 に移行された後も引き続き動作しますが、ログの表示時にページネーションの合計数が正しく表示されない場合があります。拡張機能を v3.7 に更新することで、この問題に対処できます。
以下のテナントは影響を受けません。
  • US リージョンのクラウドテナント。US リージョンはすでに完全に移行されており、Search Engine v3 を使用しています。
  • Private Cloud テナント (Private Cloud のお客様の移行は後日開始されます。)
  • 以下に該当する EU および AU リージョンのクラウドテナント:
    • Management API の GET /api/v2/logs または GET /api/v2/users/{user_id}/logs エンドポイントをまったく使用していない。
    • Dashboard の Logs セクションからのみログを取得している。
    • by checkpoint メソッド (from パラメーターを使用) で GET /api/v2/logs endpoint を使用している。
    • Auth0 Logs to External Service Dashboard 拡張機能のいずれかを使用してログを取得している (これらは by checkpoint メソッドを使用します) 。

​
クエリの移行を確認する

Auth0 は、同じ種類および説明のログを 60 分ごとに 1 件しか生成しません。影響を受けるエンドポイントに対して非推奨機能を使った呼び出しを何回行っても、各非推奨機能について 1 時間ごとに表示されるログは 1 件のみです。 クエリに変更を加えた場合、新しい depnote ログが出力されていないことをもって、コードから非推奨の動作が削除されたと確実に判断するには、60 分経過するのを待つ必要があります。 v3 への移行後にエラーになるクエリを探すには、次のようにテナントログを検索できます。 type:depnote AND description:*logs* これらのログエントリには、使用している非推奨の動作を示す description フィールドが含まれます。 また、details.request.path フィールドと client_name フィールドを確認すると、どのアプリケーションが GET /api/v2/logs または GET /api/v2/users/{user_id}/logs を呼び出しているかを確認できます。

​
変更点

破壊的変更は軽微ですが、期待どおりの結果が得られていることを確認するため、クエリを見直してください。 破壊的変更は次に関連しています。
  • テナントが logs v3 に移行されると、GET /api/v2/logs または GET /api/v2/users/{user_id}/logs の呼び出し時にサマリー結果として返される total フィールドの値が変わります。search engine v2 を使用してログを検索する場合、結果の totals フィールドは、指定したクエリに一致するログの総数を示します。一方、v3 では、totals フィールドはそのページで返されるログの件数を示します (length フィールドが返す値と同様です) 。影響を避けるため、アプリケーションがページネーションのために total フィールドに依存している場合は、この変更に適切に対応できるようロジックを更新してください。
  • 1 リクエストあたり 100 件のログという既存の制限があります。テナントが logs v3 に移行されると、ページネーションで取得できる検索結果は最大 1,000 件までとなり、1,000 件を超える結果に対する呼び出しはエラーを返すようになります。影響を避けるため、この制限に達しないようクエリを見直すか、エラーを適切に処理してください。

​
q パラメーターの検証

  • GET /api/v2/logs で q パラメーターを使用する際のクエリ構文には、考慮すべき軽微な変更があります。テナントが logs v3 に移行されると、この検証が適用され、このクエリはエラーを返すようになります。問題を未然に防ぐため、サポートされているクエリ構文に準拠していることを確認できるよう、クエリを見直してください。
  • q パラメーターに無効なフィールドが含まれています。テナントが logs v3 に移行されると、この検証が適用され、この呼び出しはエラーを返すようになります。問題を未然に防ぐため、検索可能なフィールドのみが含まれていることを確認できるよう、クエリを見直してください。

​
Tenant Log Search v3 を有効にする

クエリを確認したら、Dashboard から Tenant Logs Search Engine v3 を有効化できます。
  1. Tenant Settings > Advanced に移動します。
  2. Migrations までスクロールします。
  3. Legacy Logs Search V2 スイッチをオフにします。このスイッチをオフにすると、非推奨のログ検索エンジン v2 が無効になり、Search Engine v3 が使用されます。Legacy Logs Search V2 トグルが表示されない場合は、すでに v3 へ移行されています。追加の対応は不要です。
移行についてサポートが必要な場合は、Support Center からお問い合わせください。

​
詳細