Splunk Heavy または Universal Forwarders (TCP) ソース

利用可能な対象:

ログ

概要

Observability Pipelines の Splunk Heavy および Universal Forwarders (TCP) ソースを使用して、Splunk Forwarders に送信されたログを受信します。

前提条件

To use Observability Pipelines’ Splunk TCP source, you have a Splunk Enterprise or Cloud Instance alongside either a Splunk Universal Forwarder or a Splunk Heavy Forwarder routing data to your Splunk instance. You also have the following information available:

  • The bind address that your Observability Pipelines Worker will listen on to receive logs from your applications. For example, 0.0.0.0:8088. Later on, you configure your applications to send logs to this address.
  • The appropriate TLS certificates and the password you used to create your private key if your forwarders are globally configured to enable SSL.

See Deploy a Universal Forwarder or Deploy a Heavy Forwarder for more information on Splunk forwarders.

セットアップ

シークレット管理の場合: Splunk TCP アドレスの識別子、および該当する場合は TLS キーパスの識別子のみを入力してください。実際の値は入力しないでください。

パイプラインをセットアップ する際に、このソースをセットアップします。パイプラインのセットアップは、UI で、API を使用して、または Terraform で行えます。このセクションの手順は、UI でソースをセットアップするためのものです。

パイプライン UI で Splunk TCP ソースを選択した後、Splunk TCP アドレスの識別子を入力します。空白のままにすると、デフォルトが使用されます。

注:

  • デフォルトでは、Splunk TCP ソースはイベントのサイズを制限しません。形式が正しくない接続や無期限に開いたままの接続など、無制限のメモリ消費を防ぐには、環境変数 DD_OP_SPLUNK_TCP_MAX_FRAME_LENGTH を使用して最大フレーム長をバイト単位で設定します。
  • シークレット識別子を入力してから環境変数を使用することを選択した場合、環境変数は入力された識別子となり、DD_OP_ が前に付加されます。たとえば、パスワード識別子に PASSWORD_1 と入力した場合、そのパスワードの環境変数は DD_OP_PASSWORD_1 となります。

オプション設定

最大接続時間

接続を開いたままにする最大秒数を入力します。設定しない場合、接続が無期限に開いたままになる可能性があります。

TLS の有効化

Toggle the switch to Enable TLS.

  • If you are using Secrets Management, enter the identifier for the key pass. See Secret defaults for the default used if the field is left blank.
  • Enter the following certificate and key files:
    • Server Certificate Path: The path to the certificate file that has been signed by your Certificate Authority (CA) root file in DER, PEM, or CRT (X.509).
    • (Optional) CA Certificate Path: The path to the certificate file that is your Certificate Authority (CA) root file in DER, PEM, or CRT (X.509).
    • (Optional) Private Key Path: The path to the .key private key file that belongs to your Server Certificate Path in DER, PEM, or CRT (PKCS #8) format.
    • Notes:
      • The configuration data directory /var/lib/observability-pipelines-worker/config/ is automatically appended to the file paths. See Advanced Worker Configurations for more information.
      • The file must be readable by the observability-pipelines-worker group and user.
  • (Optional) Toggle Verify certificate to require connecting clients to present a valid client certificate. This enforces mutual TLS (mTLS), where the Worker verifies the identity of each connecting client.

シークレットのデフォルト

These are the defaults used for secret identifiers and environment variables.

  • Splunk TCP アドレス識別子:
    • Observability Pipelines Worker が Splunk Forwarder からログを受信するためにリッスンする、0.0.0.0:9997 などのソケットアドレスを参照します。
    • デフォルトの識別子は SOURCE_SPLUNK_TCP_ADDRESS です。
  • Splunk TCP TLS パスフレーズ識別子 (TLS が有効な場合):
    • デフォルトの識別子は SOURCE_SPLUNK_TCP_KEY_PASS です。
  • Splunk TCP address:
    • The Observability Pipelines Worker listens to this socket address to receive logs from the Splunk Forwarder. For example, 0.0.0.0:9997.
    • The default environment variable is DD_OP_SOURCE_SPLUNK_TCP_ADDRESS.
  • Splunk TCP TLS passphrase (when enabled):
    • The default environment variable is DD_OP_SOURCE_SPLUNK_TCP_KEY_PASS.

Connect Splunk Forwarder to the Observability Pipelines Worker

To forward your logs to the Worker, add the following configuration to your Splunk Heavy/Universal Forwarder’s etc/system/local/outputs.conf and replace <OPW_HOST> with the IP/URL of the host (or load balancer) associated with the Observability Pipelines Worker:

[tcpout]
compressed=false
sendCookedData=false
defaultGroup=opw

[tcpout:opw]
server=<OPW_HOST>:8099

<OPW_HOST> is the IP/URL of the host (or load balancer) associated with the Observability Pipelines Worker. For CloudFormation installs, the LoadBalancerDNS CloudFormation output has the correct URL to use. For Kubernetes installs, the internal DNS record of the Observability Pipelines Worker service can be used. For example: opw-observability-pipelines-worker.default.svc.cluster.local.

At this point, your logs should be going to the Worker, processed by the pipeline, and delivered to the configured destination.