Overview

Use Observability Pipelines’ Socket source to send logs to the Worker over a socket connection (TCP or UDP).

Prerequisites

If your forwarders are globally configured to enable SSL, you need the appropriate TLS certificates and the password for your private key.

Setup

Set up this source when you set up a pipeline. You can set up a pipeline in the UI, using the API, or with Terraform. The instructions in this section are for setting up the source in the UI.

After you select the Socket source in the pipeline UI:

1. Enter the identifier for your socket address. If you leave it blank, the default is used.
2. In the Mode dropdown menu, select the socket type to use.
3. In the Framing dropdown menu, select how to delimit the stream of events.

   FRAMING METHOD	DESCRIPTION
   newline_delimited	Byte frames are delimited by a newline character.
   bytes	Byte frames are passed through as-is according to the underlying I/O boundaries (for example, split between messages or stream segments).
   character_delimited	Byte frames are delimited by a chosen character.
   chunked_gelf	Byte frames are chunked GELF messages.
   octet_counting	Byte frames are delimited according to the octet counting format.

Optional TLS settings

Toggle the switch to Enable TLS.

• If you are using Secrets Management, enter the identifier for the key pass. See Set secrets for the default used if the field is left blank.
• The following certificate and key files are required:
  • 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).
  • CA Certificate Path: The path to the certificate file that is your Certificate Authority (CA) root file in DER, PEM, or CRT (X.509).
  • 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.

Secret defaults

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

Note: If you enter secret identifiers and then choose to use environment variables, the environment variable is the identifier entered and prepended with DD_OP. For example, if you entered PASSWORD_1 for a password identifier, the environment variable for that password is DD_OP_PASSWORD_1.