Edge Delta TCP Destination Node

Overview

The TCP destination node streams analytics and insights to streaming destinations. It can accept log and other data types: custom, metric, cluster_pattern_and_sample, and signal. It sends raw bytes that are generated via marshaling items as JSON.

• incoming_data_types: cluster_pattern_and_sample, log, metric, signal, custom

Example Configuration

nodes:
  - name: my_tcp_port
    type: tcp_output
    host: log_repo_host
    port: 23131

Required Parameters

name

A descriptive name for the node. This is the name that will appear in Visual Pipelines and you can reference this node in the YAML using the name. It must be unique across all nodes. It is a YAML list element so it begins with a - and a space followed by the string. It is a required parameter for all nodes.

nodes:
  - name: <node name>
    type: <node type>

type: tcp_output

The type parameter specifies the type of node being configured. It is specified as a string from a closed list of node types. It is a required parameter.

nodes:
  - name: <node name>
    type: <node type>

host

The host parameter defines the TCP stream endpoint along with the port. It is specified as a string and is required for TCP traffic.

nodes:
  - name: <node name>
    type: tcp_output
    host: <URI>
    port: <port number>

port

The port parameter defines the TCP stream port number along with the host. It is specified as a string and is required for TCP traffic.

nodes:
  - name: <node name>
    type: tcp_output
    host: <URI>
    port: <port number>

Optional Parameters

buffer_max_bytesize

The buffer_max_bytesize parameter configures the maximum byte size for total unsuccessful items. If the limit is reached, the remaining items are discarded until the buffer space becomes available. It is specified as a datasize.Size, has a default of 0 indicating no size limit, and it is optional.

nodes:
  - name: <node name>
    type: tcp_output
    host: <URI>
    port: <port number>
    buffer_max_bytesize: 2048

buffer_ttl

The buffer_ttl parameter configures the time-to-Live for unsuccessful items, which indicates when to discard them. It is specified as a duration, has a default of 10m, and it is optional.

nodes:
  - name: <node name>
    type: tcp_output
    host: <URI>
    port: <port number>
    buffer_ttl: 20m

buffer_path

The buffer_path parameter configures the path to store unsuccessful items. Unsuccessful items are stored there to be retried back (exactly once delivery). It is specified as a string and it is optional.

nodes:
  - name: <node name>
    type: tcp_output
    host: <URI>
    port: <port number>
    buffer_path: <path to unsuccessful items folder>

encoder

The encoder parameter specifies the encoding type used to stream data. It is specified as a string and is optional. You can specify msgpack or json. The default is raw data.

nodes:
  - name: <node name>
    type: tcp_output
    host: <URI>
    port: <port number>
    encoder: json

features

The features parameter defines which data types to stream to the destination. It is specified as a string of comma-separated list of item types. The default is metric,edac,cluster. It is optional.

nodes:
  - name: <node name>
    type: tcp_output
    host: <URI>
    port: <port number>
    features: <item type>,<item type>

pool_size

The pool_size parameter defines the size of the connection pool for TCP connections. It specifies how many connections can be maintained simultaneously for the given TCP endpoint. It is specified as an integer and it is optional.

nodes:
  - name: <node name>
    type: tcp_output
    host: <TCP host address>
    port: <TCP port number>
    pool_size: <number of connections>