Amazon Kinesis Firehose source plugin
The Amazon Kinesis Firehose source plugin lets you retrieve data from your Amazon Kinesis Firehose instances and ingest it into Chronosphere Telemetry Pipeline.
Configuration parameters
The Amazon Kinesis Firehose source plugin provides these configuration parameters. Items in the Name column display in the Calyptia Dashboard. Items in the Key column are the YAML keys to use in pipeline configuration files.
Metadata
| Name | Key | Description | Default |
|---|---|---|---|
| Name | Name | Plugin instance name for identification purposes. | none |
General
| Name | Key | Description | Default |
|---|---|---|---|
| Port | port | Required. The port to listen to for incoming Kinesis Firehose messages. | 9880 |
Advanced
| Name | Key | Description | Default |
|---|---|---|---|
| Tag Key | tag_key | Specify the key name to overwrite a tag. If set, tag is overwritten by a value of the key. | none |
| Buffer Max Size | buffer_max_size | Specify the maximum buffer size in KB to receive a JSON message. | 4M |
| Buffer Chunk Size | buffer_chunk_size | Sets the chunk size for incoming JSON messages. Chunks are then stored and managed in the space available by buffer_max_size. | 512k |
| Successful Response Code | successful_response_code | Allows setting of successful response codes. Accepted values: 200, 201, 204. | 200 |
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 |