Metric Streamsの作成方法

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

Datadog

DatadogのメトリクスAPIとネイティブに統合

New Relic

OpenTelemetry プロトコル (OTLP) 経由でストリーミング

Splunk

OpenTelemetry プロトコル (OTLP) 経由でストリーミング

前提条件

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

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をインストールしてください。
監視プラットフォームのアカウント：サポートされているプラットフォームのいずれかの有効なアカウント。

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)

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

ダッシュボード
CLI

Metric Streamsに移動する：

Auth0 Dashboard > [Monitoring (監視) ] > [Metric Streams] に移動します。
[+ Create Metric Stream] を選択します。
[Datadog] を選択します。

ストリームを設定する：

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

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

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

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

ストリームの管理

ダッシュボード
CLI

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

Auth0 Dashboard > [Monitoring (監視) ] > [Metric Streams] に移動します。
設定済みのストリームが一覧表示され、それぞれの送信先、ステータス、名前、サブスクリプションを確認できます。

ストリームを編集する：

一覧からストリーム名を選択します。
設定を更新します。
[Save (保存) ] を選択します。

ストリームを有効化／無効化する：

Status列のトグルスイッチを切り替えて、ストリームを有効または無効にします。
無効化したストリームはメトリクスの送信を停止しますが、設定はそのまま保持されます。

ストリームを削除する：

一覧からストリーム名を選択します。
設定ページの下部にある [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 プロトコル (OTLP) を使用して、Auth0のメトリクスをNew Relicにストリーミングします。

New Relic の認証情報を取得する

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

New Relic の OTLP ドキュメントを参照し、ご利用のリージョンに対応するエンドポイントを確認します。

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

このエンドポイント URL を控えておきます。

取り込み用ライセンスキーを作成する

[ユーザーメニュー] > API キー に移動します。
Create a key を選択します。
Key Type で Ingest - License を選択します。
わかりやすい名前を入力し、必要に応じてメモを追加します。
Create a key を選択します。
API キーはすぐにコピーしてください。このキーは後の手順で使用しますが、再表示されません。

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

ダッシュボード
CLI

Metric Streamsに移動する：

Auth0 Dashboard > [Monitoring (監視) ] > [Metric Streams] に移動します。
[+ Create Metric Stream (+ Metric Streamを作成) ] を選択します。
[OpenTelemetry] を選択します。

ストリームを設定する：

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

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

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 プロトコル (OTLP) を使用して、Auth0 のメトリクスを Splunk Observability Cloud にストリーミングします。

Splunk の認証情報を取得する

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

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

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

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

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

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

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

ダッシュボード
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で取得したもの) を貼り付けます。
保存を選択します。

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

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"
      }
    }
  }'

トラブルシューティング

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

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

ダッシュボード
CLI

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

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

statusフィールドがenabledになっていることを確認します。

送信先の認証情報を確認する：

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

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

監視コストが高い場合

想定以上にコストが高くなっている場合は、次の対策を検討してください。

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

概念

操作方法

リファレンス

Metric Streamsの作成方法

Datadog

New Relic

Splunk

前提条件

Datadogをセットアップする

前提条件

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

Datadogで確認する

ストリームの管理

New Relicをセットアップする

New Relic の認証情報を取得する

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

Splunk のセットアップ

Splunk の認証情報を取得する

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

トラブルシューティング

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

監視コストが高い場合

Datadog

New Relic

Splunk

​前提条件

​Datadogをセットアップする

​前提条件

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

​Datadogで確認する

​ストリームの管理

​New Relicをセットアップする

​New Relic の認証情報を取得する

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

​Splunk のセットアップ

​Splunk の認証情報を取得する

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

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

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

​監視コストが高い場合

前提条件

Datadogをセットアップする

前提条件

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

Datadogで確認する

ストリームの管理

New Relicをセットアップする

New Relic の認証情報を取得する

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

Splunk のセットアップ

Splunk の認証情報を取得する

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

トラブルシューティング

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

監視コストが高い場合