OTLP/HTTP エクスポーター

OTLP/HTTP エクスポータは、OpenTelemetry Collector が OTLP 形式を使用して HTTP 経由でメトリクス、トレース、ログを送信できるようにします。コンポーネントの設定方法については、続きをお読みください。

注: Splunk Observability Cloudにトレースを送信するデフォルトの方法として、OTLP/HTTP エクスポーターを使用します。

OTLP/HTTP エクスポータは、OTLP 形式を使用して、メトリクス、トレース、ログを HTTP 経由で送信します。サポートされるパイプラインタイプは、tracesmetricslogs です。詳細については「パイプラインでデータを処理する」を参照してください。

また、gRPC プロトコルを使用してデータを送信する高度なオプションに OTLP エクスポータを使用することもできます。詳細については「OTLP エクスポータ」を参照してください。

OTLP 形式についての詳細は、OTel リポジトリの「OpenTelemetry Protocol Specification」を参照してください。

はじめに

注: このコンポーネントは、Splunk Distribution of the OpenTelemetry Collector のデフォルト設定に含まれており、ホスト監視(エージェント)モードでのデプロイの場合に Splunk Observability Cloud にトレースを送信します。詳細については、「Collector deployment modes」を参照してください。デフォルト設定の詳細については、「Helm で Collector for Kubernetes を設定する」、「Collector for Linux のデフォルト設定」、または「Collector for Windows のデフォルト設定」を参照してください。このドキュメントで説明されているように、いつでも設定をカスタマイズできます。

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

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

  2. 次のセクションで説明するようにエクスポーターを設定します。

  3. Collector を再起動します。

設定オプション

以下の設定が必要です:

  • traces_endpointします。トレースデータの送信先 URL。Splunk Observability Cloud の場合は、https://ingest.<realm>.signalfx.com/v2/trace/otlp です。

以下の設定は任意であり、より高度なユースケースの場合に構成に追加することができます:

  • logs_endpointします。ログデータの送信先 URL。たとえば、https://example.com:4318/v1/logs のようになります。

  • metrics_endpointします。メトリクスデータの送信先 URL。たとえば、カスタムメトリクスを Splunk Observability Cloud に送信する場合は "https://ingest.<realm>.signalfx.com/v2/datapoint/otlp" です。

  • tlsします。利用可能なオプションの完全なセットについては、本ドキュメントの「TLS Configuration Settings」を参照してください。カスタムエンドポイントへのデータ送信にのみ適用されます。

  • timeout。デフォルトでは 30s です。HTTP リクエストの時間制限。詳細については、https://golang.org/pkg/net/http/#Client を参照してください。

  • read_buffer_size。デフォルトでは 0 です。HTTP クライアントの ReadBufferSize。

  • write_buffer_size。デフォルトでは 512 * 1024 です。HTTP クライアントの WriteBufferSize。

サンプル構成

OTLP over HTTP を使用してトレースとメトリクスを Splunk Observability Cloud に送信するには、REST API インジェストエンドポイントに metrics_endpointtraces_endpoint の設定を行います。例:

YAML
exporters:
  otlphttp:
    # The target URL to send trace data to. By default it's set to ``https://ingest.${SPLUNK_REALM}.signalfx.com/v2/trace/otlp``.
    traces_endpoint: https://ingest.<realm>.signalfx.com/v2/trace/otlp
    # The target URL to send metrics data to. By default it's set to 
    metrics_endpoint: https://ingest.<realm>.signalfx.com/v2/datapoint/otlp
    # Set of HTTP headers added to every request.
    headers:
      # X-SF-Token is the authentication token provided by Splunk Observability Cloud.
      X-SF-Token: <access_token>

設定を完了するには、構成ファイルの service セクションの必要なパイプラインにエクスポータを含めます。例:

YAML
service:
  pipelines:
    metrics:
      exporters: [otlphttp]
    traces:
      exporters: [otlphttp]

設定例

これは詳細な設定例です:

YAML
endpoint: "https://1.2.3.4:1234"
traces_endpoint: https://ingest.<realm>.signalfx.com/v2/trace/otlp
metrics_endpoint: https://ingest.<realm>.signalfx.com/v2/datapoint/otlp
headers:
  X-SF-Token: <access_token>
timeout: 10s
read_buffer_size: 123
write_buffer_size: 345
sending_queue:
  enabled: true
  num_consumers: 2
  queue_size: 10
retry_on_failure:
  enabled: true
  initial_interval: 10s
  randomization_factor: 0.7
  multiplier: 1.3
  max_interval: 60s
  max_elapsed_time: 10m
compression: gzip

gzip圧縮を設定する

デフォルトでは、gzip 圧縮は有効になっています。これをオフにするには、次の設定を使用します。

YAML
exporters:
  otlphttp:
    ...
    compression: none

パススルーをアクセストークンに関連付ける

Splunk APM(SAPM)エクスポータ(廃止)からの設定 access_token_passthrough は使用できなくなりました。

データポイントを組織のアクセストークンに関連付けるには、以下のことを確認します:

  • include_metadataotlpの設定でtrueに設定されています。

  • metadata_keysバッチプロセッサの org トークンに設定されます。

例:

YAML
extensions:
  headers_setter:
    headers:
      - action: upsert
        key: X-SF-TOKEN
        from_context: X-SF-TOKEN

receivers:
  otlp:
    protocols:
      http:
        include_metadata: true

processors:
  batch:
    metadata_keys:
    - X-SF-Token

exporters:
  otlphttp:
    metrics_endpoint: https://ingest.<realm>.signalfx.com/v2/datapoint/otlp
    traces_endpoint: https://ingest.<realm>.signalfx.com/v2/trace/otlp
    headers:
        "X-SF-Token": "mytoken"
    auth:
      authenticator: headers_setter

設定

次の表に、OTLP/HTTPエクスポーターの設定オプションを示します:

同梱

https://raw.githubusercontent.com/splunk/collector-config-tools/main/cfg-metadata/exporter/otlphttp.yaml

トラブルシューティング

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

Available to prospective customers and free trial users

  • Ask a question and get answers through community support at Splunk Answers.

  • Join the Splunk community #observability Slack channel to communicate with customers, partners, and Splunk employees worldwide.