メトリクスストリーム

Auth0 のメトリクスを Datadog、New Relic、Splunk などの監視プラットフォームに送信し、リアルタイムの可観測性を実現します。

​

メトリクスストリーム (ベータ版)

メトリクスストリーム は現在ベータ版として提供されています。この機能を使用するには、Enterprise プランが必要です。この機能を使用することで、お客様は Okta の Master Subscription Agreement に定める該当する Free Trial 条項に同意したものとみなされます。Auth0 の製品リリース サイクルの詳細については、Product Release Stages を参照してください。

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

​

監視できる項目

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

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

​

ユースケース

​

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

どの API やエンドポイントがレート制限に達しているかを監視し、必要に応じて統合を調整するか、レート制限ティアを引き上げます。

​

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

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

​

キャパシティを計画する

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

​

前提条件

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

• Auth0 Management API へのアクセス: 次の権限を持つ Machine-to-Machine (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	はい	タグとタイムスタンプが同一のメトリクスに対するシーケンス番号 (一時的なもので、ベータ終了後に削除されます)

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

メトリクスストリームには、システムの過負荷を防ぐため、エッジで 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 エラー

​

対応している送信先

メトリクスストリーム では、次の監視プラットフォームがサポートされています。

Datadog

Datadog の Metrics API とのネイティブ統合

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 などのリージョン識別子)

​

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

Dashboard

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

1. Auth0 Dashboard > Monitoring > メトリクスストリーム に移動します。
2. + Create Metric Stream を選択します。
3. Datadog を選択します。

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

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

これにより、Metric Stream が作成され、自動的に有効化されます。

CLI

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

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 で確認する

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

​

ストリームを管理する

Dashboard

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

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

ストリームを編集する:

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

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

1. ストリームを有効または無効にするには、Status 列の Toggle switch を切り替えます。
2. 無効化したストリームはメトリクスの送信を停止しますが、設定は保持されます。

ストリームを削除する:

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

CLI

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

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 の認証情報を取得する

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

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

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

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

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

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

​

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

Dashboard

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

1. Auth0 Dashboard で Monitoring > メトリクスストリーム に移動します。
2. + Create Metric Stream を選択します。
3. OpenTelemetry を選択します。

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

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

これにより、Metric Stream が作成され、自動的に有効化されます。

CLI

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 の認証情報を取得する

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

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

   エンドポイントの形式は次のとおりです。

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

   <REALM> を Splunk の realm (例: us1、eu0、jp0) に置き換えます。

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

   1. Settings > Access Tokens > New Token に移動します。
   2. わかりやすい名前を入力します。
   3. Authorization Scope を INGEST に設定します (必須) 。
   4. トークンの有効期限を設定します。
   5. Create を選択します。
   6. トークンの値をコピーして安全に保管します。この値は後続の手順で必要です。

​

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

Dashboard

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

1. Auth0 Dashboard の Monitoring > メトリクスストリーム に移動します。
2. + Create Metric Stream を選択します。
3. OpenTelemetry を選択します。

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

1. 名前: わかりやすい名前を入力します (例: splunk-production) 。
2. プロトコル: ドロップダウンから HTTP を選択します。
3. OTLP エンドポイント: Splunk の OTLP エンドポイントを貼り付けます (例: https://ingest.us1.signalfx.com/v2/datapoint/otlp) 。
4. 認証方法: ドロップダウンから API Key を選択します。
5. ヘッダー名: X-SF-TOKEN を入力します。
6. API Key: Splunk のアクセストークンを貼り付けます (前述のステップ 2 で取得) 。
7. Save を選択します。

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

CLI

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	低	一時的なタグ (ベータ版終了後に削除)

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

​

トラブルシューティング

​

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

ストリームのステータスを確認します。

Dashboard

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

CLI

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

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

送信先の認証情報を確認します。

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

エッジキャッシュを確認します。

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

​

監視コストが高い

想定以上のコストが発生している場合:

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