TELEMETRY PIPELINE
HTTP

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:

LogsMetricsTraces

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

NameKeyDescriptionDefault
HosthostRequired. IP address or hostname of the target HTTP Server.0.0.0.0
PortportRequired. TCP port of the target HTTP Server.80
URIuriRequired. Specify an optional HTTP URI for the target web server./
FormatformatRequired. Specify the data format to be used in the HTTP request body. Accepted values: json, json_lines, json_stream.json_lines

Advanced

NameKeyDescriptionDefault
HeadersheaderAdd a HTTP header key/value pair. You can set multiple headers.none
CompresscompressSet payload compression mechanism. Accepted values: gzip, no valuenone
HTTP ProxyproxySpecify an HTTP Proxy. The expected format of this value is http://host:port.none
JSON Date Formatjson_date_formatSpecify 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 Keyjson_date_keySpecify the name of the date field in output.none
Body Keybody_keySpecify the key which contains the body.none
Header Tagheader_tagSet a HTTP header which value is the tag of the record.none
Header Keyheaders_keySpecify the key which contains the headers.none

Security and TLS

NameKeyDescriptionDefault
TLStlsEnable or disable TLS/SSL support. Accepted values: true, false.false
TLS Certificate Validationtls.verifyEnable or disable TLS/SSL certificate validation. TLS must be enabled for certificates to be validated. Accepted values: off, on.on
TLS Debug Leveltls.debugSet TLS debug verbosity level. Accepted values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational), 4 (Verbose).1
CA Certificate File Pathtls.ca_fileAbsolute path to CA certificate file.none
Certificate File Pathtls.crt_fileAbsolute path to certificate file.none
Private Key File Pathtls.key_fileAbsolute path to private key file.none
Private Key Path Passwordtls.key_passwdPassword for private key file.none
TLS SNI Hostname Extensiontls.vhostHostname to be used for TLS SNI extension.none

Advanced Networking

NameKeyDescriptionDefault
DNS Modenet.dns.modeSelect the primary DNS connection type, which can be TCP or UDP.none
DNS Resolvernet.dns.resolverSelect the primary DNS connection type, which can be LEGACY or ASYNC.none
Prefer IPv4net.dns.prefer_ipv4Prioritize IPv4 DNS results when trying to establish a connection. Accepted values: true, false.false
Keepalivenet.keepaliveEnable or disable Keepalive support. Accepted values: true, false.true
Keepalive Idle Timeoutnet.keepalive_idle_timeoutSet maximum time allowed for an idle Keepalive connection.30s
Max Connect Timeoutnet.connect_timeoutSet maximum time allowed to establish a connection, which includes the TLS handshake.10s
Max Connect Timeout Log Errornet.connect_timeout_log_errorOn 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 Recyclenet.keepalive_max_recycleSet maximum number of times a keepalive connection can be used before it's retired.2000
Source Addressnet.source_addressSpecify network address to bind for data traffic.none

Basic Authentication

NameKeyDescriptionDefault
HTTP Usernamehttp_userBasic auth username.none
HTTP Passwordhttp_passwdBasic auth password. Requires http_user to be set.none

AWS Authentication

NameKeyDescriptionDefault
Enable AWS Authenticationaws_authEnable AWS Sigv4 Authentication. Accepted values: true, false.false
AWS Destination Service Codeaws_serviceAWS destination service code, used by SigV4 authentication.none
AWS Regionaws_regionAWS Region of your service.none
AWS STS Endpointaws_sts_endpointCustom endpoint for the AWS STS API, used with the aws_role_arn option.none
AWS IAM Assume Roleaws_role_arnARN of an IAM role to assume. For example, for cross account access.none
AWS External IDaws_external_idSpecify an external ID for the STS API. Can be used with the aws_role_arn parameter if your role requires an external ID.none