Collect data using TCP

Most recent version: v0.1.1

See the changelog of the TCP Listener type here.

Overview

Onum supports integration with Transmission Control Protocol.

Prerequisites

Contact Onum to get the cert information needed for TLS communication, which will be needed on the Listener setup.

TCP Setup

Transmission Control Protocol (TCP) is not a collector itself but a transport protocol that a collector component uses to receive data. In the context of observability and OpenTelemetry (OTel), you set up the OpenTelemetry Collector to listen on a TCP port using a specific Receiver component.

Onum Setup

1

Log in to your Onum tenant and click Listeners > New listener.

2

Double-click the TCP Listener.

3

Enter a Name for the new Listener. Optionally, add a Description and some Tags to identify the Listener.

4

Enter the IP Port* and Trailer Character*

Note that you won't see the Port setting in the creation form if you're defining this Listener in a Cloud instance, as these are already provided by Onum. Learn more about Cloud Listeners in this article.

A trailer in TCP typically refers to the end portion of a packet that may contain optional information like checksums, padding, or other metadata. It is part of the TCP header.

• LF - Line Feed character is a control character used to signify the end of a line of text or the start of a new line.

• CR+LF - Carriage Return (CR) followed by a Line Feed (LF) character pair, which is commonly used to signify the end of a line in text-based communication.

• NULL

5

In the TLS configuration section, enter the data you received from the Onum team (Certificate, Private key and CA chain). Choose No client certificate as Client authentication method and TLS v.1.0 as the Minimum TLS version.

Note that the parameters in this section are only mandatory if you decide to include TLS authentication in this Listener. Otherwise, leave blank.

• The predefined TLS Certificate*.

• The Private Key* of the corresponding certificate.

• The path containing the CA chain certificates.

• Choose the Client Authentication Method* between No, Request, Require, Verify, and Require & Verify.

• Select the Minimum TLS version* from the menu.

6

These values are stored as Secrets in Onum. Open the Secret fields and click New secret to create a new one:

• Give the secret a Name.

• Turn off the Expiration date option.

• Click Add new value and paste the secret corresponding to the JWT token you generated before. Remember that the token will be added in the Zscaler configuration.

• Click Save.

Learn more about secrets in Onum in this article.

You can now select the secret you just created in the corresponding fields.

7

Finally, click Create labels. Optionally, you can set labels to be used for internal Onum routing of data. By default, data will be set as Unlabeled. Click Create listener when you're done.

Learn more about labels in this article.

Click Create listener when you're done.