Docs » Splunk Distribution of the OpenTelemetry Collector の利用開始 » Collector コンポーネント » Collectorコンポーネント: エクステンション » 健全性チェック エクステンション

健全性チェック エクステンション 🔗

health_check エクステンションは、OpenTelemetry Collector のステータスをチェックするためにプローブ可能な HTTP URL を有効にします。このエクステンションは、Kubernetes 上で有効性または準備状況のプローブとして使用することができます。

はじめに 🔗

注釈

このコンポーネントは、ホスト監視 (エージェント) モードでデプロイする場合、Splunk Distribution of the OpenTelemetry Collector のデフォルト設定に含まれます。詳細は Collector のデプロイモード を参照してください。

デフォルト設定の詳細については、Helmで Collector for Kubernetes を設定するCollector for Linux のデフォルト設定、または Collector for Windows のデフォルト設定 を参照してください。この文書で説明されているように、いつでも設定をカスタマイズすることができます。

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

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

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

  2. Collector を再起動します。

サンプル構成 🔗

コンポーネントをアクティブにするには、設定ファイルの extensions セクションに health_check を追加します:

extensions:
  health_check:

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

service:
  extensions: [health_check]

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

  • endpoint.ヘルスチェックのステータスを公開するアドレス。デフォルトでは 0.0.0.0:13133 です。

  • path.ヘルスチェックサーバーに設定するパス。デフォルトでは "/" です。

  • response_body。ヘルスチェックサービスが返すデフォルトのレスポンスをオーバーライドする静的ボディ。デフォルトでは "" です。

  • enabled.Collectorパイプラインチェックを有効にするかどうか。デフォルトでは false です。

  • interval。障害数をチェックする間隔。デフォルトでは 5m です。

  • exporter_failure_threshold。コンテナを正常としてマークする障害数のしきい値。デフォルトでは 5 です。

設定例 🔗

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

extensions:
  health_check:
  health_check/1:
    endpoint: "localhost:13"
    tls:
      ca_file: "/path/to/ca.crt"
      cert_file: "/path/to/cert.crt"
      key_file: "/path/to/key.key"
    path: "/health/status"
    check_collector_pipeline:
      enabled: true
      interval: "5m"
      exporter_failure_threshold: 5

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

health_check:
health_check/1:
  endpoint: "localhost:13"
  tls:
    ca_file: "/path/to/ca"
    key_file: "/path/to/key"
    cert_file: "/path/to/cert"
  check_collector_pipeline:
    enabled: false
    interval: "5m"
    exporter_failure_threshold: 5
health_check/missingendpoint:
  endpoint: ""
  check_collector_pipeline:
    enabled: false
    interval: "5m"
    exporter_failure_threshold: 5
health_check/invalidthreshold:
  endpoint: "localhost:13"
  check_collector_pipeline:
    enabled: false
    interval: "5m"
    exporter_failure_threshold: -1
health_check/invalidpath:
  endpoint: "localhost:13"
  path: "invalid"
  check_collector_pipeline:
    enabled: false
    interval: "5m"
    exporter_failure_threshold: 5

Collectorのパイプラインをチェックする 🔗

オプションで、設定パラメータ check_collector_pipeline を使用して Collector パイプラインのヘルスチェックを有効にできます。有効にすると、コンポーネントが宛先へのデータ送信に失敗した回数を監視できます。

エクスポーターの故障にのみ対応し、レシーバーやプロセッサーには対応しないことに注意してください。

設定 🔗

次の表は、health_check エクステンションの設定オプションを示しています:

NameTypeDefaultDescription
endpointstringlocalhost:13133
tls (see fields)ptr

ServerConfig contains TLS configurations that are specific to server connections in addition to the common configurations. This should be used by components configuring TLS server connections.

cors (see fields)ptr
auth (see fields)ptr
max_request_body_sizeint64
include_metadataboolfalse
response_headersmap
compression_algorithmsslice
read_timeoutint64
read_header_timeoutint64
write_timeoutint64
idle_timeoutint64
pathstring/

Path represents the path the health check service will serve. The default path is "/".

response_body (see fields)ptr

ResponseBody represents the body of the response returned by the health check service. This overrides the default response that it would return.

check_collector_pipeline (see fields)struct

CheckCollectorPipeline contains the list of settings of collector pipeline health check

Fields of tls

NameTypeDefaultDescription
ca_filestring

Path to the CA cert. For a client this verifies the server certificate. For a server this verifies client certificates. If empty uses system root CA. (optional)

ca_pemstring

In memory PEM encoded cert. (optional)

include_system_ca_certs_poolboolfalse

If true, load system CA certificates pool in addition to the certificates configured in this struct.

cert_filestring

Path to the TLS cert to use for TLS required connections. (optional)

cert_pemstring

In memory PEM encoded TLS cert to use for TLS required connections. (optional)

key_filestring

Path to the TLS key to use for TLS required connections. (optional)

key_pemstring

In memory PEM encoded TLS key to use for TLS required connections. (optional)

min_versionstring

MinVersion sets the minimum TLS version that is acceptable. If not set, TLS 1.2 will be used. (optional)

max_versionstring

MaxVersion sets the maximum TLS version that is acceptable. If not set, refer to crypto/tls for defaults. (optional)

cipher_suitesslice

CipherSuites is a list of TLS cipher suites that the TLS transport can use. If left blank, a safe default list is used. See https://go.dev/src/crypto/tls/cipher_suites.go for a list of supported cipher suites.

reload_intervalint64

ReloadInterval specifies the duration after which the certificate will be reloaded If not set, it will never be reloaded (optional)

client_ca_filestring

Path to the TLS cert to use by the server to verify a client certificate. (optional) This sets the ClientCAs and ClientAuth to RequireAndVerifyClientCert in the TLSConfig. Please refer to https://godoc.org/crypto/tls#Config for more information. (optional)

client_ca_file_reloadboolfalse

Reload the ClientCAs file when it is modified (optional, default false)

Fields of cors

NameTypeDefaultDescription
allowed_originsslice
allowed_headersslice
max_ageint

Fields of auth

NameTypeDefaultDescription
authenticatorstruct

ID represents the identity for a component. It combines two values:

  • type - the Type of the component.
  • name - the name of that component. The component ID (combination type + name) is unique for a given component.Kind.
request_paramsslice

Fields of response_body

NameTypeDefaultDescription
healthystring

Healthy represents the body of the response returned when the collector is healthy. The default value is ""

unhealthystring

Unhealthy represents the body of the response returned when the collector is unhealthy. The default value is ""

Fields of check_collector_pipeline

NameTypeDefaultDescription
enabledboolfalse

Enabled indicates whether to not enable collector pipeline check.

intervalstring5m

Interval the time range to check healthy status of collector pipeline

exporter_failure_thresholdint5

ExporterFailureThreshold is the threshold of exporter failure numbers during the Interval

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

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

Splunk Observability Cloudをご利用のお客様

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

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

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

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