OpenTelemetry source plugin
The OpenTelemetry source plugin lets you ingest metric, trace, and log data from your OpenTelemetry instances.
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.
Required
Name | Key | Description | Default |
---|---|---|---|
Port | port | Required. The TCP port used for listening for incoming messages. | 8088 |
Advanced
Name | Key | Description | Default |
---|---|---|---|
Tag from URI | tag_from_uri | Sets tag from URI. For example, v1_metrics from /v1/metrics. | false |
Tag Key | tag_key | Specifies the key name of a tag to overwrite. If set, the tag name will be overwritten by the specified tag key. | none |
Buffer Chunk Size | buffer_chunk_size | Sets the chunk size for incoming JSON messages. These chunks are then stored and managed in the space available by buffer_max_size . | 512K |
Buffer Max Size | buffer_max_size | Specifies the maximum buffer size in KB to receive a JSON message. | 4M |
Successful Response Code | successful_response_code | Sets the code returned by successful responses. Accepted values: 200 , 201 , 204 . | 201 |
Security and TLS
Name | Key | Description | Default |
---|---|---|---|
TLS | tls | Enable or disable TLS/SSL support. Accepted values: true , false . | false |
TLS Certificate Validation | tls.verify | Turn TLS/SSL certificate validation on or off. TLS must be on for this setting to be enabled. | on |
TLS Debug Level | tls.debug | Set 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 | Optional password for tls.key_file file. | none |
TLS SNI Hostname Extension | tls.vhost | Hostname to be used for TLS SNI extension. | none |