Metric Streams (ベータ)

Metric Streamsは現在ベータ版として提供されています。この機能を利用するには、Enterprise planへの加入が必要です。この機能を使用すると、OktaのMaster Subscription Agreementに記載されている該当のFree Trial条件に同意したものとみなされます。Auth0の製品リリースサイクルの詳細については、Product Release Stagesを参照してください。

Auth0のリアルタイムメトリクスを監視プラットフォームにストリーミングして、APIのパフォーマンスを追跡し、レート制限の問題を特定し、エラーのトラブルシューティングを迅速化できます。Metric Streamsは、DatadogとのNativeな連携と、New RelicやSplunkなどのプラットフォーム向けのOpenTelemetry Protocol (OTLP) の両方をサポートしています。

監視できる内容

Auth0 API の利用状況に関する主要なメトリクスを追跡できます。

API リクエスト量: Authentication API と Management API への総リクエスト数を監視します。
エラー率: 連携に影響するクライアントエラーとサーバーエラーを特定します。
レート制限の発生: アプリケーションがレート制限にかかったタイミングを検出します。
地理的分布: 国別のトラフィック傾向を分析します。
認証フロー: グラントタイプや接続の利用状況を追跡します。

活用例

レート制限の問題を特定する

レート制限に達しているAPIやエンドポイントを監視することで、連携を調整したり、レート制限ティアにアップグレードしたりできます。

API 障害のトラブルシューティング

メトリクスを API、オペレーション、失敗の種類 (レート制限、異常検知、または一般的なエラー) で絞り込むことで、エラーの根本原因をすばやく特定できます。

プランのキャパシティ

ピーク時の利用量、平均RPS、パーセンタイル指標を分析して、ワークロードに適したレート制限ティアを見極めます。

前提条件

メトリックストリームを設定する前に、以下が必要です。

Auth0 Management API へのアクセス: 次の権限を持つマシンツーマシン (M2M) アプリケーションを作成します。
- read:event_streams
- create:event_streams
- update:event_streams
- delete:event_streams
- read:event_deliveries
- update:event_deliveries
詳細な手順については、Management API アクセストークンを取得するを参照してください。
Auth0 CLI: API コマンドを使用してメトリックストリームを設定するには、Auth0 CLIをインストールします。
監視プラットフォームのアカウント: サポート対象の送信先のいずれかで有効なアカウント。

メトリクスリファレンス

auth0.api_request.count

詳細なフィルタリングと集計タグを使用して、Auth0 テナントへの API リクエスト数をカウントします。新しいメトリクスは 10 秒ごとに生成され、1 秒単位の粒度で提供されます。

利用可能なタグ

タグ名	必須	説明
`api`	はい	API の種類: `AUTHENTICATION` または `MANAGEMENT`
`operation_name`	はい	HTTP メソッドとパス (例: `POST /oauth/token`)
`operation_result`	はい	結果: `SUCCESS` または `FAILURE`
`tenant`	はい	Auth0 テナント名
`failure_code`	いいえ	失敗理由: `RATE_LIMIT`、`ANOMALY_DETECTION`、または `CLIENT_SERVER_ERROR`
`country_code`	いいえ	リクエスト元 IP アドレスに基づく ISO 国コード
`client_id`	いいえ	アプリケーションのクライアント ID (Authentication API のみ)
`connection_id`	いいえ	接続 ID (Authentication API のみ)
`grant_type`	いいえ	OAuth 2.0 グラントタイプ (Authentication API のみ)
`batch_seq`	はい	同一のタグとタイムスタンプを持つメトリクスのシーケンス番号 (一時的なもので、Beta 終了後に削除されます)

client_id タグと connection_id タグは、多数の一意なクライアントや接続がある環境ではカーディナリティが高くなり、モニタリングコストが増加する可能性があります。これらのタグは必要な場合にのみ使用してください。

Metric Streams には、システムの過負荷を防ぐために、エッジで Auth0 の Web Application Firewall (WAF) によってキャッシュまたはブロックされた API 呼び出しは含まれません。

列挙値

api

AUTHENTICATION - Authentication API へのリクエスト
MANAGEMENT - Management API へのリクエスト

operation_result

SUCCESS - リクエストは正常に完了しました
FAILURE - リクエストはクライアントエラーまたはサーバーエラーにより失敗しました

failure_code (operation_result が FAILURE の場合のみ存在)

RATE_LIMIT - リクエストがレート制限を超過しました
ANOMALY_DETECTION - Auth0 の攻撃対策によってブロックされました
CLIENT_SERVER_ERROR - HTTP 4xx または 5xx エラー

サポート対象の送信先

Metric Streams は、以下の監視プラットフォームに対応しています。

Datadog

Datadog のメトリクス API との Native 連携

New Relic

OpenTelemetry Protocol (OTLP) 経由でストリーミング

Splunk

OpenTelemetry Protocol (OTLP) 経由でストリーミング

Datadog を設定する

Datadog 独自のメトリクス API を使用して、Auth0 のメトリクスを Datadog に直接送信します。

前提条件

有効なDatadogアカウント
Datadog の API キー (Datadog の Organization Settings > API Keys で生成)
ご利用の Datadog サイト (app.datadoghq.com の場合は US1、app.datadoghq.eu の場合は EU、us3.datadoghq.com の場合は US3 などのリージョン識別子)

メトリックストリームを作成

Auth0 Dashboard
CLI

メトリックストリームに移動します。

Auth0 Dashboard で、Monitoring > メトリックストリーム に移動します。
+ Create Metric Stream を選択します。
Datadog を選択します。

ストリームを設定します。

Name: わかりやすい名前を入力します (例: datadog-production) 。
Datadog Site: ドロップダウンから Datadog のリージョンを選択します。
- US1: app.datadoghq.com
- US3: us3.datadoghq.com
- US5: us5.datadoghq.com
- EU: app.datadoghq.eu
- AP1: ap1.datadoghq.com
Datadog API Key: Datadog の API キーを貼り付けます。
Save を選択します。

これでメトリックストリームが作成され、自動的に有効になります。

Auth0 CLI を使用して Datadog のメトリックストリームを作成します。

Auth0 CLI を使用していますか？まだセットアップしていない場合は、このコマンドを実行する前に CLI セッションをセットアップして認証してください。

auth0 api post metric-streams \
  --data '{
    "name": "datadog-production",
    "subscriptions": [{ "metric_type": "auth0.api_request.count" }],
    "destination": {
      "type": "datadog",
      "configuration": {
        "api_key": "YOUR_DATADOG_API_KEY",
        "site": "app.datadoghq.com"
      }
    }
  }'

レスポンス:

{
  "id": "mst_abc123xyz",
  "status": "enabled",
  "name": "datadog-production",
  "created_at": "2024-02-12T10:30:00Z",
  "updated_at": "2024-02-12T10:30:00Z",
  "destination": {
    "type": "datadog",
    "configuration": {
      "api_key": "***",
      "site": "app.datadoghq.com"
    }
  }
}

このストリームを後で管理できるよう、id の値を保存しておきます。

DatadogでVerify

数分で、Auth0のメトリクスがDatadogに表示されます。Metrics > Explorer に移動し、auth0.api_request.count を検索すると、データを確認できます。

ストリームの管理

Auth0 Dashboard
CLI

すべてのストリームを表示する:

Auth0 Dashboard の Monitoring > Metric Streams に移動します。
設定済みのすべてのストリームが、Destination、Status、Name、Subscriptions とともに一覧表示されます。

ストリームを編集する:

一覧からストリーム名を選択します。
設定を更新します。
Save を選択します。

ストリームを有効化/無効化する:

Status 列の Toggle switch を使用して、ストリームを有効または無効にします。
ストリームを無効にすると、メトリクスの送信は停止しますが、設定は保持されます。

ストリームを削除する:

一覧からストリーム名を選択します。
設定ページの下部にある Delete を選択します。
削除を確認します。

すべてのストリームを一覧表示する:

auth0 api get /api/v2/metric-streams

ストリームを無効化する:

auth0 api patch /api/v2/metric-streams/YOUR_STREAM_ID \
  --data '{"status":"disabled"}'

ストリームを再度有効化する:

auth0 api patch /api/v2/metric-streams/YOUR_STREAM_ID \
  --data '{"status":"enabled"}'

New Relicを設定する

OpenTelemetry Protocol (OTLP) を使用して、Auth0のメトリクスをNew Relicに送信します。

New Relicの資格情報を取得する

OTLP エンドポイントを確認する

リージョンごとのエンドポイントを確認するには、New RelicのOTLPドキュメントを参照してください。

US: https://otlp.nr-data.net
EU: https://otlp.eu01.nr-data.net

このエンドポイントURLを保存しておきます。

Ingestライセンスキーを作成する

[ユーザーメニュー] > API Keys に移動します。
Create a key を選択します。
Key Type = Ingest - License を選択します。
わかりやすい名前と必要に応じてメモを入力します。
Create a key を選択します。
APIキーをすぐにコピーします。後の手順で必要になり、あとで再表示することはできません。

メトリックストリームを作成

Auth0 Dashboard
CLI

Metric Streams に移動します。

Auth0 Dashboard > Monitoring > Metric Streams に移動します。
+ Create Metric Stream を選択します。
OpenTelemetry を選択します。

ストリームを設定します。

Name: わかりやすい名前を入力します (例: newrelic-production) 。
Protocol: ドロップダウンから HTTP を選択します。
OTLP Endpoint: New Relic の OTLP エンドポイントを貼り付けます (例: https://otlp.nr-data.net) 。
Authentication Method: ドロップダウンから API Key を選択します。
Header Name: api-key を入力します。
API Key: 前の手順でコピーした New Relic の Ingest License Key を貼り付けます。
Save を選択します。

これでメトリックストリームが作成され、自動的に有効になります。

auth0 api post metric-streams \
  --data '{
    "name": "newrelic-production",
    "subscriptions": [{ "metric_type": "metrics_bridge.api_request" }],
    "destination": {
      "type": "otlp",
      "configuration": {
        "endpoint": "YOUR_NEW_RELIC_ENDPOINT",
        "protocol": "http",
        "auth_type": "api_key",
        "api_key": "YOUR_INGEST_LICENSE_KEY",
        "auth_header_name": "api-key"
      }
    }
  }'

Splunk を設定する

OpenTelemetry Protocol (OTLP) を使用して、Auth0 のメトリクスを Splunk Observability Cloud にストリーミングします。

Splunkの資格情報を取得する

OTLPエンドポイントを確認する

エンドポイントを確認するには、SplunkのOTLP HTTP Exporterドキュメントを参照してください。エンドポイントの形式は次のとおりです。

https://ingest.<REALM>.signalfx.com/v2/datapoint/otlp

<REALM> はSplunkのレルム (例: us1、eu0、jp0) に置き換えてください。

アクセストークンを作成する

設定 > アクセストークン > New Token に移動します。
わかりやすい名前を入力します。
Authorization Scope を INGEST に設定します (必須) 。
トークンの有効期限を設定します。
Create を選択します。
トークンの値をコピーし、安全な場所に保管します。この値は後の手順で必要になります。

メトリックストリームを作成

Auth0 Dashboard
CLI

Metric Streams に移動します。

Auth0 Dashboard > Monitoring > Metric Streams に移動します。
+ Create Metric Stream を選択します。
OpenTelemetry を選択します。

ストリームを設定します。

Name: わかりやすい名前を入力します (例: splunk-production) 。
Protocol: ドロップダウンから HTTP を選択します。
OTLP Endpoint: Splunk の OTLP エンドポイントを貼り付けます (例: https://ingest.us1.signalfx.com/v2/datapoint/otlp) 。
Authentication Method: ドロップダウンから API Key を選択します。
Header Name: X-SF-TOKEN を入力します。
API Key: Splunk のアクセストークンを貼り付けます (上記のステップ 2) 。
Save を選択します。

メトリックストリームが作成され、自動的に有効になります。

auth0 api post metric-streams \
  --data '{
    "name": "splunk-production",
    "subscriptions": [{ "metric_type": "metrics_bridge.api_request" }],
    "destination": {
      "type": "otlp",
      "configuration": {
        "endpoint": "YOUR_SPLUNK_ENDPOINT",
        "protocol": "http",
        "auth_type": "api_key",
        "api_key": "YOUR_SPLUNK_ACCESS_TOKEN",
        "auth_header_name": "X-SF-TOKEN"
      }
    }
  }'

メトリクスのカーディナリティを理解する

カーディナリティとは、メトリクスによって生成される一意の時系列の数を指します。カーディナリティが高いほど、監視コストも増加します。

タグ	カーディナリティ	影響
`api`	低	一意の値は 2 つ (Authentication、Management)
`operation_name`	中	使用する API 操作によって異なります
`operation_result`	低	一意の値は 2 つ (成功、失敗)
`tenant`	中	Auth0 テナントごとに 1 つ
`failure_code`	低	一意の値は 3 つ (失敗時のみ)
`country_code`	中〜高	地理的な分布によって異なります
`client_id`	高	アプリケーションのクライアントごとに 1 つ
`connection_id`	高	IDプロバイダーの接続ごとに 1 つ
`grant_type`	低	OAuth 2.0 のグラントタイプは限定的
`batch_seq`	低	一時的なタグ (Beta 後に削除)

client_id と connection_id タグは慎重に使用してください。アプリケーションや接続が多い環境では、これらのタグによってコストが大幅に増加する可能性があります。詳細な粒度が不要な場合は、特定のクライアントだけに絞ってフィルタリングするか、これらのタグを集約することを検討してください。

トラブルシューティング

メトリクスが表示されない

ストリームのステータスを確認する:

Auth0 Dashboard
CLI

Auth0 Dashboard > Monitoring > Metric Streams に移動します。
一覧から対象のメトリックストリームを探します。
Status 列が Enabled になっていることを確認します。
ストリーム名を選択して詳細設定を表示し、設定内容を確認します。

auth0 api get /api/v2/metric-streams/YOUR_STREAM_ID

status フィールドが enabled であることを確認します。

送信先の資格情報を確認する:

Datadog: API キーが有効であり、site URL が Datadog のリージョンと一致していることを確認します
OTLP destinations: エンドポイント URL、認証トークン、ヘッダー名が正しいことを確認します

エッジキャッシュを確認する: キャッシュされたリクエストや WAF によってブロックされたリクエストは、メトリックストリームに含まれないことに注意してください。

監視コストが高い場合

想定以上にコストがかかっている場合は、次の点を確認してください。

クエリやダッシュボードで使用しているタグを見直します。
集計から client_id と connection_id を除外することを検討します。
監視プラットフォームでサンプリングやフィルタリングを利用し、取り込まれるメトリクスを減らします。
粒度の細かいタグではなく、api や operation_result のような上位レベルのタグで集計します。

​Metric Streams (ベータ)

​監視できる内容

​活用例

​レート制限の問題を特定する

​API 障害のトラブルシューティング

​プランのキャパシティ

​前提条件

​メトリクス リファレンス

​auth0.api_request.count

​利用可能なタグ

​列挙値

​サポート対象の送信先

Datadog

New Relic

Splunk

​Datadog を設定する

​前提条件

​メトリックストリームを作成

​DatadogでVerify

​ストリームの管理

​New Relicを設定する

​New Relicの資格情報を取得する

​メトリックストリーム を作成

​Splunk を設定する

​Splunkの資格情報を取得する

​メトリックストリームを作成

​メトリクスのカーディナリティを理解する

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

​メトリクスが表示されない

​監視コストが高い場合

Metric Streams (ベータ)

監視できる内容

活用例

レート制限の問題を特定する

API 障害のトラブルシューティング

プランのキャパシティ

前提条件

メトリクスリファレンス

auth0.api_request.count

利用可能なタグ

列挙値

サポート対象の送信先

Datadog を設定する

前提条件

メトリックストリームを作成

DatadogでVerify

ストリームの管理

New Relicを設定する

New Relicの資格情報を取得する

メトリックストリームを作成

Splunk を設定する

Splunkの資格情報を取得する

メトリックストリームを作成

メトリクスのカーディナリティを理解する

トラブルシューティング

メトリクスが表示されない

監視コストが高い場合