影響を受ける機能
次の条件をすべて満たす場合は、影響を受けます。- 2019年5月21日以前に作成されたテナント
- AU または EU リージョンの Auth0 の Public Cloud でホストされているテナント
include_totals=trueパラメーターまたはqパラメーターを指定して、GET /api/v2/logs または GET/api/v2/users/{user_id}/logsエンドポイントを使用している。- 1000件を超える結果をページネーションしている。
- Delegated Admin Extension を使用している。お使いのテナントが Logs Search Engine v3 に移行された後も、extension の古いバージョンは引き続き動作しますが、ログの表示時にページネーションの合計数が正しく表示されない場合があります。extension を 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エンドポイントをまったく使用していない。 - Auth0 Dashboard の Logs セクションからのみログを取得している。
- by checkpoint メソッド (
fromパラメーターを使用) でGET /api/v2/logsエンドポイントを使用している。 - Auth0 Logs to External Service の Auth0 Dashboard の拡張機能 (by checkpoint メソッドを使用) を使ってログを取得している。
- Management API の
クエリ移行の確認
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 に移行されると、この検証が適用され、この呼び出しはエラーを返すようになります。問題が発生する可能性を避けるため、検索可能なフィールドのみが含まれていることを確認できるよう、クエリを見直してください。
テナントログ検索 v3 を有効にする
クエリを確認したら、Auth0 Dashboard から Tenant Logs Search Engine v3 に切り替えることができます。- Tenant Settings > Advanced に移動します。
- Migrations までスクロールします。
- Legacy Logs Search V2 スイッチをオフにします。このスイッチをオフにすると、非推奨のログ検索エンジン v2 が無効になり、検索エンジン v3 が使用されます。Legacy Logs Search V2 スイッチが表示されない場合は、すでに v3 への移行が完了しています。追加の対応は不要です。