Axiom destination plugin
The Axiom destination plugin lets you integrate your telemetry data with Axiom for additional processing and analysis.
Configuration parameters
The Axiom destination plugin provides these configuration parameters. Items in the Name column display in the Telemetry Pipeline web interface. Items in the Key column are the YAML keys to use in pipeline configuration files.
General
| Name | Key | Description | Default |
|---|---|---|---|
| Axiom Token | header | Add a HTTP header key/value pair. You can set multiple header values. | none |
| Dataset Name | uri | Required. The dataset name used when routing data to the Axiom service. For more information, see Send data from Fluent Bit to Axiom (opens in a new tab) in the Axiom documentation. | none |
Advanced
| Name | Key | Description | Default |
|---|---|---|---|
| Host | host | Required. IP address or hostname of Axiom data collection endpoint. | cloud.axiom.co |
| Port | port | Required. The port used to communicate with the Axiom service. Use port 443 for TLS. | 443 |
| Compress | compress | Set payload compression mechanism. | gzip |
| HTTP Proxy | proxy | Specify an HTTP Proxy. The expected format of this value is http://host:port. | none |
| Format | format | Required. Specify the data format to be used in the HTTP request body. Accepted values: json, json_lines, json_stream, msgpack. | json |
| JSON Date Format | json_date_format | Specify the format of the date. Accepted values: 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), epoch. | iso8601 |
| JSON Date Key | json_date_key | Specify the name of the date field in output. | _time |
| 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 | 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. 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 |