Forward

Forward Source Plugin

Forward is a lightweight protocol that is optimized for low-latency and high-throughput data transmission over the network. The Forward protocol supports both TCP and UDP transport protocols and provides options for configuring data buffering and batching to optimize network usage.

You can use the Forward Source Plugin to configure your calyptia core pipeline to recieve data from your agents that can send with that format (E.g. Fluentd, Fluent Bit, even Calyptia Core itself)

Configuration Parameters

The following are General configuration Parameters for Forward Source Plugin.

Key
Host	Listener network interface
Port	TCP port to listen for incoming connections
Unix Socket Path	Specify the path to unix socket to receive a Forward message. If set, Listen and Port are ignored.
Unix Socket	Set the permission of the unix socket file. If Unix_Path is not set, this parameter is ignored
Max Buffer Size	Specify the maximum buffer memory size used to receive a Forward message. The value must be according to the Unit Size specification.
Buffer Chunk Size	By default the buffer to store the incoming Forward messages, do not allocate the maximum memory allowed, instead it allocate memory when is required. The rounds of allocations are set by Buffer_Chunk_Size. The value must be according to the Unit Size specification.
Tag Prefix	Prefix incoming tag with the defined value.

Key

Host

Listener network interface

Port

TCP port to listen for incoming connections

Unix Socket Path

Specify the path to unix socket to receive a Forward message. If set, Listen and Port are ignored.

Unix Socket

Set the permission of the unix socket file. If Unix_Path is not set, this parameter is ignored

Max Buffer Size

Specify the maximum buffer memory size used to receive a Forward message. The value must be according to the Unit Size specification.

Buffer Chunk Size

By default the buffer to store the incoming Forward messages, do not allocate the maximum memory allowed, instead it allocate memory when is required. The rounds of allocations are set by Buffer_Chunk_Size. The value must be according to the Unit Size specification.

Tag Prefix

Prefix incoming tag with the defined value.

The following are Security and TLS configuration Parameters for Forward Source Plugin.

Key	Description
TLS	Enable or Disable TLS/SSL support
TLS Certificate Validation	Turn TLS/SSL certificate validation on / off, TLS must be on for this setting to be enabled.
TLS Debug Level	Set TLS debug verbosity level. It accepts the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational), and 4 Verbose
CA Certificate File Path	Absolute path to CA certificate file
Certificate File Path	Absolute path to Certificate file
Private key File Path	Absolute path to private Key file
Private Key Path Password	Optional password for tls.key_file file
TLS SNI Hostname Extension	Hostname to be used for TLS SNI Extension

Key

Description

TLS

Enable or Disable TLS/SSL support

TLS Certificate Validation

Turn TLS/SSL certificate validation on / off, TLS must be on for this setting to be enabled.

TLS Debug Level

Set TLS debug verbosity level. It accepts the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational), and 4 Verbose

CA Certificate File Path

Absolute path to CA certificate file

Certificate File Path

Absolute path to Certificate file

Private key File Path

Absolute path to private Key file

Private Key Path Password

Optional password for tls.key_file file

TLS SNI Hostname Extension

Hostname to be used for TLS SNI Extension

PreviousTCP NextS3 Input

Last updated 9 months ago