Forward source plugin
The Forward source plugin
(name: forward, alias: forward) lets you ingest data from your Forward
services into a telemetry pipeline.
This is a push-based source plugin.
Supported telemetry types
This plugin for Chronosphere Telemetry Pipeline supports these telemetry types:
| Logs | Metrics | Traces |
|---|---|---|
Configuration parameters
Use the parameters in this section to configure your plugin. The Telemetry Pipeline web interface uses the values in the Name column to describe the parameters. Items in the Key column are the YAML keys to use in pipeline configuration files.
General
| Name | Key | Description | Default |
|---|---|---|---|
| Host | listen | Required. The listener network interface. | 0.0.0.0 |
| Port | port | Required. The TCP port used for listening for incoming messages. | 24224 |
| Unix Socket Path | unix_path | Specifies the path to Unix socket to receive a Forward message. If set, listen and port are ignored. | none |
| Unix Socket | unix_perm | Sets the permission of the Unix socket file. If unix_path isn’t set, this parameter is ignored. | none |
| Buffer Chunk Size | buffer_chunk_size | Sets the default chunk (opens in a new tab) size for buffered data. If a single record exceeds this size, the plugin temporarily increases the chunk size up to the value of buffer_max_size to accommodate it. This value must follow Fluent Bit’s rules for unit sizes (opens in a new tab). | 1024000 |
| Buffer Max Size | buffer_max_size | Sets the maximum chunk (opens in a new tab) size for buffered data. If a single record exceeds this size, the plugin drops that record. This value must follow Fluent Bit’s rules for unit sizes (opens in a new tab). | 6144000 |
| Tag Prefix | tag_prefix | The prefix incoming tag with the defined value. | none |
| Memory Buffer Limit | mem_buf_limit | For pipelines with the Deployment or DaemonSet workload type only. Sets a limit for how much buffered data the plugin can write to memory, which affects backpressure. This value must follow Fluent Bit’s rules for unit sizes (opens in a new tab). If unspecified, no limit is enforced. | none |
Security and TLS
| Name | Key | Description | Default |
|---|---|---|---|
| TLS | tls | If true, enables TLS/SSL. If false, disables TLS/SSL. Accepted values: true, false. | false |
| TLS Certificate Validation | tls.verify | If on, and if tls is true, enables TLS/SSL certificate validation. If off, disables TLS/SSL certificate validation. Accepted values: on, off. | on |
| TLS Debug Level | tls.debug | Sets TLS debug verbosity level. Accepted values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational), 4 (Verbose). | 1 |
| CA Certificate File Path | tls.ca_file | Absolute path to CA certificate file. | none |
| Certificate File Path | tls.crt_file | Absolute path to certificate file. | none |
| Private Key File Path | tls.key_file | Absolute path to private key file. | none |
| Private Key Path Password | tls.key_passwd | Password for private key file. | none |
| TLS SNI Hostname Extension | tls.vhost | Hostname to be used for TLS SNI extension. | none |