socket.md

title	Socket Destination
disable_toc	false
products	name icon url Logs logs /observability_pipelines/configuration/?tab=logs#pipeline-types

{{< product-availability >}}

Overview

Use Observability Pipelines' Socket destination to send logs to a socket endpoint.

Setup

Set up the Socket destination and its environment variables when you set up a pipeline. The following information is configured in the pipelines UI.

Set up the destination

Only enter the identifier for the socket address and, if appliable, the key pass. Do not enter the actual values.

1. Enter the identifier for your 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 Encoding dropdown menu, select either JSON or Raw message as the output format.

Optional settings

Enable TLS

{{% observability_pipelines/tls_settings %}}

Buffering

{{% observability_pipelines/destination_buffer %}}

Set secrets

{{% observability_pipelines/set_secrets_intro %}}

{{< tabs >}} {{% tab "Secrets Management" %}}

• Socket address identifier:
  • References the address to which the Observability Pipelines Worker sends processed logs.
  • The default identifier is DESTINATION_SOCKET_ADDRESS.
• Socket TLS passphrase identifier (when TLS is enabled):
  • The default identifier is DESTINATION_SOCKET_KEY_PASS.

{{% /tab %}}

{{% tab "Environment Variables" %}}

{{% observability_pipelines/configure_existing_pipelines/destination_env_vars/socket %}}

{{% /tab %}} {{< /tabs >}}

How the destination works

Event batching

The Socket destination does not batch events.