- チェックポイントの場合 ：ログイベントを外部データ分析サービスにエクスポートする場合に推奨されます。
- 検索条件の場合 ：Dashboardにより使用されます。
/api/v2/logs/{id}：指定されたログIDに関連付けられた単一のログエントリを取得します。/api/v2/users/{user_id}/logs：特定のユーザーIDのログイベントを取得します。
チェックポイントでログを取得する
このメソッドを使用すると、指定されたlog_idよりも新しいログイベントを取得
できます。これは通常、Splunk、Datadog、Application Insights、Mixpanelなどの外部
システムにログを送信するために使用されます。
チェックポイントで検索するには、次のパラメーターを使用します。
| パラメーター | 説明 |
|---|---|
from | ログの取得を開始するログイベントのID。takeパラメーターを使用して、ログの量を制限できます。 |
take | fromパラメーターを使用する際に取得するエントリの総数。 |
fromとtake以外のパラメータは無視されます。ログはlog_id順に並べられます。
セマンティクス
チェックポイントによるログの取得には次のセマンティクスがあります。- ロールの役割の権限で利用可能なすべてのログが返されます
- ログは、Auth0システムの遅延による過去のレコードのスキップを防ぐために、イベント生成時間ではなく
log_idで順序付けられます。 - 検索条件でログを取得する場合の
1,000件のレコード制限とは対照的に、ページネーションは無制限であり、制限はありません。
ページネーション
チェックポイントでログを取得する場合は、最初の要求のみを手動で行って ください。後続の各要求は、Linkヘッダー内のnext関係URLを使用して
行う必要があります。これにより、APIとの統合作業が簡素化され、Auth0は
顧客エクスペリエンスに影響を与えることなく最適化を行うことができます。
例
usのテナント名がacmeであると仮定します。チェックポイントでレコードを取得し始めるには：
-
システム内の任意のログから
log_idを取得します。 例：90020211201185132572079310688835925971249535794074878050 -
指定された
LOG_IDよりも新しい次の100個のログを要求するには、https://TENANT_NAME.LOCALITY.auth0.com/api/v2/logs?from=LOG_ID&take=100に要求を送信します。 -
HTTP応答には次が含まれます。
- 指定された
LOG_IDより新しい0〜100個のログのJSON配列 next関係を持つHTTPLinkヘッダー
- 指定された
-
結果セットが空の場合は空の配列が返され、
next関係は最新の要求で使用したのと同じURLと一致します。
検索条件でログを取得する
このメソッドを使用すると、指定された検索条件に一致するログイベントを取得できます。条件が使用されない場合は、すべてのイベントが一覧表示されます。条件で検索するには、次のパラメーターを使用します。| パラメーター | 説明 |
|---|---|
q | クエリ文字列構文を使用した検索条件です。 |
page | 0から始まるページ番号です。 |
per_page | 1ページあたりのエントリ数です。 |
sort | 並べ替えに使用するフィールドです。field:orderを使用して、orderに昇順の場合は1、降順の場合は-1を指定します。例：date:-1 |
fields | 結果に含めるまたは除外する（include_fieldsで指定）フィールドのカンマ区切りのリストです。すべてのフィールドを取得するには、空のままにします。 |
include_fields | 指定したフィールドを含めるにはtrue、除外するにはfalseを指定します。デフォルトはtrueです。 |
制限事項
ログを取得する要求ごとに100件のログイベントという制限に加え、最大1,000件の検索結果までしかページ分割できません。414 Request-URI Too Largeエラーが発生した場合、クエリ文字列がサポートされている長さよりも大きいことを意味します。その場合には、検索を絞り込みます。
プライベートクラウドの検索フィールドの制限
次のフィールドはプライベートクラウドでのみ検索できます。
userconnectionapplicationtypeip
application:"test"」では「 test」という名前のアプリケーションに特定してログイベントがすべて検索されますが、「application:test 」では名前の一部が「test」のアプリケーションに関するログイベントが検索されます）。