HTTP source plugin
The HTTP source plugin (name: http)
lets you collect data from various sources and ingest them 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 |
|---|---|---|---|
| Port | port | Required. The TCP port used for listening for incoming messages. | 9880 |
Advanced
| Name | Key | Description | Default |
|---|---|---|---|
| Tag Key | tag_key | Specifies the key name to overwrite a tag. If set, the value of that key overwrites the tag. | none |
| 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. | 4M |
| 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. | 512k |
| Successful Response Code | successful_response_code | Sets the code returned by successful responses. Accepted values: 200, 201, 204. | 200 |
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 |