Forward source plugin
The Forward source plugin lets you configure Chronosphere Telemetry Pipeline to collect data from your Forward services.
Supported telemetry types
This plugin 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 |
| Max Buffer Size | buffer_max_size | Specifies the maximum buffer memory size used to receive a Forward message. The value must be according to the Unit Size specification. | 6144000 |
| Buffer Chunk Size | buffer_chunk_size | By default, the buffer to store the incoming Forward messages doesn't allocate the maximum memory allowed. Instead, it allocates memory as required. The rounds of allocations are set by buffer_chunk_size. The value must be according to the Unit Size specification. | 1024000 |
| Tag Prefix | tag_prefix | The prefix incoming tag with the defined value. | none |
Security and TLS
| Name | Key | Description | Default |
|---|---|---|---|
| TLS | tls | Enables or disables TLS/SSL support. Accepted values: true, false. | false |
| TLS Certificate Validation | tls.verify | Enables or disables TLS/SSL certificate validation. TLS must be enabled for certificates to be validated. Accepted values: off, on. | 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 |