HTTP destination plugin
The HTTP destination plugin lets you configure Chronosphere Telemetry Pipeline to send your data to remote servers or services over the internet to an HTTP endpoint, such as a web server or an API.
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 | host | Required. IP address or hostname of the target HTTP Server. | 0.0.0.0 |
| Port | port | Required. TCP port of the target HTTP Server. | 80 |
| URI | uri | Required. Specify an optional HTTP URI for the target web server. | / |
| Format | format | Required. Specify the data format to be used in the HTTP request body. Accepted values: json, json_lines, json_stream. | json_lines |
Advanced
| Name | Key | Description | Default |
|---|---|---|---|
| Headers | header | Add a HTTP header key/value pair. You can set multiple headers. | none |
| Compress | compress | Set payload compression mechanism. Accepted values: gzip, no value | none |
| HTTP Proxy | proxy | Specify an HTTP Proxy. The expected format of this value is http://host:port. | none |
| JSON Date Format | json_date_format | Specify the format of the date. Accepted values: double, epoch, iso8601 (for example, 2018-05-30T09:39:52.000681Z), java_sql_timestamp (for example, 2018-05-30 09:39:52.000681, which can be used with AWS Athena). | none |
| JSON Date Key | json_date_key | Specify the name of the date field in output. | none |
| Body Key | body_key | Specify the key which contains the body. | none |
| Header Tag | header_tag | Set a HTTP header which value is the tag of the record. | none |
| Header Key | headers_key | Specify the key which contains the headers. | none |
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 | Enable or disable TLS/SSL certificate validation. TLS must be enabled for certificates to be validated. Accepted values: off, on. | 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 | Password for private key file. | none |
| TLS SNI Hostname Extension | tls.vhost | Hostname to be used for TLS SNI extension. | none |
Advanced Networking
| Name | Key | Description | Default |
|---|---|---|---|
| DNS Mode | net.dns.mode | Select the primary DNS connection type, which can be TCP or UDP. | none |
| DNS Resolver | net.dns.resolver | Select the primary DNS connection type, which can be LEGACY or ASYNC. | none |
| Prefer IPv4 | net.dns.prefer_ipv4 | Prioritize IPv4 DNS results when trying to establish a connection. Accepted values: true, false. | false |
| Keepalive | net.keepalive | Enable or disable Keepalive support. Accepted values: true, false. | true |
| Keepalive Idle Timeout | net.keepalive_idle_timeout | Set maximum time allowed for an idle Keepalive connection. | 30s |
| Max Connect Timeout | net.connect_timeout | Set maximum time allowed to establish a connection, which includes the TLS handshake. | 10s |
| Max Connect Timeout Log Error | net.connect_timeout_log_error | On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message. Accepted values: true, false. | true |
| Max Keepalive Recycle | net.keepalive_max_recycle | Set maximum number of times a keepalive connection can be used before it's retired. | 2000 |
| Source Address | net.source_address | Specify network address to bind for data traffic. | none |
Basic Authentication
| Name | Key | Description | Default |
|---|---|---|---|
| HTTP Username | http_user | Basic auth username. | none |
| HTTP Password | http_passwd | Basic auth password. Requires http_user to be set. | none |
AWS Authentication
| Name | Key | Description | Default |
|---|---|---|---|
| Enable AWS Authentication | aws_auth | Enable AWS Sigv4 Authentication. Accepted values: true, false. | false |
| AWS Destination Service Code | aws_service | AWS destination service code, used by SigV4 authentication. | none |
| AWS Region | aws_region | AWS Region of your service. | none |
| AWS STS Endpoint | aws_sts_endpoint | Custom endpoint for the AWS STS API, used with the aws_role_arn option. | none |
| AWS IAM Assume Role | aws_role_arn | ARN of an IAM role to assume. For example, for cross account access. | none |
| AWS External ID | aws_external_id | Specify an external ID for the STS API. Can be used with the aws_role_arn parameter if your role requires an external ID. | none |