HTTP destination plugin
You use HTTP to send your processed telemetry data to an HTTP endpoint, such as a web server or an API. With the HTTP destination plugin, you can seamlessly integrate Calyptia Core with various external systems that support HTTP, allowing you to send your data to remote servers or services over the internet. By using HTTP destination plugin, you can transmit your data securely and reliably, ensuring that your data reaches its intended destination in a timely and efficient manner.
Configuration parameters
The HTTP destination plugin provides these configuration parameters.
General
| Key | Description |
|---|---|
| Host | IP address or hostname of the target HTTP Server. |
| Port | TCP port of the target HTTP Server. |
| URI | Specify an optional HTTP URI for the target web server. |
| Format | Specify the data format to be used in the HTTP request body, by default it uses json_lines. Other supported formats are json and json_stream. |
Advanced
| Key | Description |
|---|---|
| Headers | Add a HTTP header key/value pair. Multiple headers can be set. |
| Compress | Set payload compression mechanism. |
| HTTP Proxy | Specify an HTTP Proxy. The expected format of this value is http://host:port. |
| JSON Date Format | Specify the format of the date, supported formats: double, 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), and epoch. |
| JSON Date Key | Specify the name of the date field in output. |
| Body Key | Specify the key which contains the body. |
| Header Tag | Set a HTTP header which value is the tag of the record. |
| Header Key | Specify the key which contains the headers. |
Security and TLS
| Name | Key | Description | Default |
|---|---|---|---|
| TLS | tls | Enable or disable TLS/SSL support. | none |
| 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 |
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. Valid values are true or false. | none |
| Keepalive | net.keepalive | Enable or disable Keepalive support. Valid values are true or 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. Valid values are true or false. | true |
| Max Keepalive Recycle | net.keepalive_max_recycle | Set maximum number of times a keepalive connection can be used before it is 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_password | Basic Auth Password. Requires http_user to be set. | none |
AWS authentication
| Key | Description |
|---|---|
| Enable AWS Authentication | Enable AWS Sigv4 Authentication. |
| Enable AWS Sigv4 Authentication | AWS destination service code, used by SigV4 authentication. |
| AWS Region | AWS Region of your service. |
| AWS STS Endpoint | Custom endpoint for the AWS STS API, used with the AWS_Role_ARN option. |
| AWS IAM Assume Role | ARN of an IAM role to assume (for example, cross-account access). |
| 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. |