Docs » Splunk Distribution of the OpenTelemetry Collector の利用開始 » Collector コンポーネント » Collectorコンポーネント: エクステンション » OAuth2 Client Auth extension

OAuth2 Client Auth extension 🔗

oauth2client 拡張モジュールは、HTTPおよびgRPCベースのエクスポーターにOAuth2クライアント認証フロー認証を提供します。この拡張は、トークンの有効期限が切れると自動的にトークンを取得してリフレッシュします。

OAuth2 クライアント認証情報のフロー(2 レッグワークフロー)の詳細については、OAuth 2.0認証フレームワーク仕様の Client Credentials Grant を参照してください。

For information about the available exporters, see Collectorコンポーネント: エクスポーター.

はじめに 🔗

以下の手順に従って、コンポーネントの設定とアクティベーションを行ってください:

  1. Splunk Distribution of the OpenTelemetry Collector をホストまたはコンテナプラットフォームにデプロイします:

  1. 次のセクションで説明するように、エクステンションを設定します。

  2. Collector を再起動します。

サンプル構成 🔗

To activate the component, add oauth2client to the extensions section of your configuration file:

extensions:
  oauth2client:

設定を完了するには、設定ファイルの service セクションに拡張子を含めます:

service:
  extensions: [oauth2client]

注釈

OAuth2 Client Authエクステンションを使用して、エクスポーターで認証タイプを oauth2client に設定します。設定例 を参照してください。

コンフィギュレーション設定 🔗

エクステンションの設定には以下の設定が必要です:

  • token_url。リソースサーバーのトークンエンドポイントURL。

  • client_id。クライアントに発行されたクライアント識別子。

  • client_id_file。クライアントに発行されたクライアントIDを取得するためのファイルパス。エクステンションはこのファイルを読み込み、新しいトークンを発行する必要があるときにクライアントIDを更新します。

    • このパラメータを使用すると、トークンをローテーションする必要がある場合などに、ファイルの内容を修正することでクライアントの認証情報を動的に変更することができます。

    • この設定は client_id よりも優先されます。

  • client_secret。識別子に関連付けられたシークレット文字列。

  • client_secret_file。識別子に関連付けられたシークレット文字列を取得するためのファイルパス。エクステンションはこのファイルを読み込んで、新しいトークンを発行する際にクライアントのシークレットを更新します。

    • このパラメータにより、例えばトークンをローテーションする必要がある場合に、ファイルの内容を修正することでクライアントの認証情報を動的に変更することができます。

    • この設定は client_secret よりも優先されます。

  • endpoint_params。トークンのエンドポイントに送信される追加パラメータ。

  • scopes。オプション。クライアントに関連付けられた要求されたアクセス許可。

  • timeout.オプション。認証サーバーがトークンをフェッチするための、基礎となるクライアントのタイムアウトを、初期と更新中の両方に、指定します。

    • 無効の場合、クライアントにタイムアウトはありません。

For more information on the client side TLS settings, see Configure TLS.

設定例 🔗

これはエクステンションの設定例です:

extensions:
  oauth2client:
    client_id: someclientid
    client_secret: someclientsecret
    endpoint_params:
      audience: someaudience
    token_url: https://example.com/oauth2/default/v1/token
    scopes: ["api.metrics"]
    # tls settings for the token client
    tls:
      insecure: true
      ca_file: /var/lib/mycert.pem
      cert_file: certfile
      key_file: keyfile
    # timeout for the token client
    timeout: 2s

receivers:
  hostmetrics:
    scrapers:
      memory:
  otlp:
    protocols:
      grpc:

exporters:
  otlphttp/withauth:
    endpoint: http://localhost:9000
    auth:
      authenticator: oauth2client

  otlp/withauth:
    endpoint: 0.0.0.0:5000
    tls:
      ca_file: /tmp/certs/ca.pem
    auth:
      authenticator: oauth2client

service:
  extensions: [oauth2client]
  pipelines:
    metrics:
      receivers: [hostmetrics]
      processors: []
      exporters: [otlphttp/withauth, otlp/withauth]

設定 🔗

The following table shows the configuration options for the oauth2client extension:

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

Splunk Observability Cloudをご利用のお客様で、Splunk Observability Cloudでデータを確認できない場合は、以下の方法でサポートを受けることができます。

Splunk Observability Cloudをご利用のお客様

見込み客および無料トライアルユーザー様

  • Splunk Answers のコミュニティサポートで質問し、回答を得る

  • Splunk #observability ユーザーグループの Slack チャンネルに参加して、世界中の顧客、パートナー、Splunk 社員とのコミュニケーションを図る。参加するには、Get Started with Splunk Community マニュアルの チャットグループ を参照してください。

このページは 2024年12月12日 に最終更新されました。