HTTP

HTTP Destination Plugin

HTTP d allows you to easily send your processed telemetry data to an HTTP endpoint, such as a web server or an API. With 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 easily transmit your data securely and reliably, ensuring that your data reaches its intended destination in a timely and efficient manner.
Configuration Parameters
The following are configuration Parameters for HTTP Destination Plugin.
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, e.g: /something
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.
The following are Advanced configuration Parameters for HTTP Destination Plugin.
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 (e.g: 2018-05-30T09:39:52.000681Z), java_sql_timestamp (e.g: 2018-05-30 09:39:52.000681, useful for 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
The following are Security and TLS configuration Parameters for HTTP Destination Plugin.
Key
Description
TLS
Enable or Disable TLS/SSL support
TLS Certificate Validation
Turn TLS/SSL certificate validation on / off, TLS must be on for this setting to be enabled
TLS Debug Level
Set TLS debug verbosity level. It accepts the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational), and 4 Verbose
CA Cerificate File Path
Absolute path to CA certificate file
Cerficate File Path
Absolute path to Certificate file
Private Key File Path
Absolute path to private Key file
Private Key File Password
Optional password for tls.key_file file
TLS SNI Hostname Extension
Hostname to be used for TLS SNI Extension
The following are Advanced Networking configuration Parameters for HTTP Destination Plugin.
Key
Description
DNS Mode
Select the primary DNS connection type (TCP or UDP)
DNS Resolver
Select the primary DNS connection type (TCP or UDP)
Prefer IPv4
Prioritize IPv4 DNS results when trying to establish a connection
Keepalive
Enable or disable Keepalive support
Keepalive Idle Timeout
Set maximum time allowed for an idle Keepalive connection
Max Connect Timeout
Set maximum time allowed to establish a connection, this time includes the TLS handshake
Max Connect Timeout Log Error
On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message
Max Keepalive Recycle
Set maximum number of times a keepalive connection can be used before it is retired.
Source Address
Specify network address to bind for data traffic
The following are Basic Authentication configuration Parameters for HTTP Destination Plugin.
Key
Description
HTTP Username
Basic Auth Username
HTTP Password
Basic Auth Password. Requires HTTP_User to be set
The following are AWS Authentication configuration Parameters for HTTP Destination Plugin.
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 (ex. for 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.

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, e.g: /something
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.

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 (e.g: 2018-05-30T09:39:52.000681Z), java_sql_timestamp (e.g: 2018-05-30 09:39:52.000681, useful for 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

Key	Description
TLS	Enable or Disable TLS/SSL support
TLS Certificate Validation	Turn TLS/SSL certificate validation on / off, TLS must be on for this setting to be enabled
TLS Debug Level	Set TLS debug verbosity level. It accepts the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational), and 4 Verbose
CA Cerificate File Path	Absolute path to CA certificate file
Cerficate File Path	Absolute path to Certificate file
Private Key File Path	Absolute path to private Key file
Private Key File Password	Optional password for tls.key_file file
TLS SNI Hostname Extension	Hostname to be used for TLS SNI Extension

Key	Description
DNS Mode	Select the primary DNS connection type (TCP or UDP)
DNS Resolver	Select the primary DNS connection type (TCP or UDP)
Prefer IPv4	Prioritize IPv4 DNS results when trying to establish a connection
Keepalive	Enable or disable Keepalive support
Keepalive Idle Timeout	Set maximum time allowed for an idle Keepalive connection
Max Connect Timeout	Set maximum time allowed to establish a connection, this time includes the TLS handshake
Max Connect Timeout Log Error	On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message
Max Keepalive Recycle	Set maximum number of times a keepalive connection can be used before it is retired.
Source Address	Specify network address to bind for data traffic

Key	Description
HTTP Username	Basic Auth Username
HTTP Password	Basic Auth Password. Requires HTTP_User to be set

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 (ex. for 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.

Integrations - Previous

Destination Plugins

Forward

Last modified 2mo ago