questdb
This component is experimental and therefore subject to change or removal outside of major version releases.
Pushes messages to a QuestDB table.
- Common
- Advanced
# Common config fields, showing default values
output:
label: ""
questdb:
max_in_flight: 64
batching:
count: 0
byte_size: 0
period: ""
check: ""
address: localhost:9000 # No default (required)
username: "" # No default (optional)
password: "" # No default (optional)
token: "" # No default (optional)
table: trades # No default (required)
designated_timestamp_field: "" # No default (optional)
designated_timestamp_unit: auto
timestamp_string_fields: [] # No default (optional)
timestamp_string_format: Jan _2 15:04:05.000000Z0700
symbols: [] # No default (optional)
doubles: [] # No default (optional)
error_on_empty_messages: false
# All config fields, showing default values
output:
label: ""
questdb:
max_in_flight: 64
batching:
count: 0
byte_size: 0
period: ""
check: ""
processors: [] # No default (optional)
tls:
enabled: false
skip_cert_verify: false
enable_renegotiation: false
root_cas: ""
root_cas_file: ""
client_certs: []
address: localhost:9000 # No default (required)
username: "" # No default (optional)
password: "" # No default (optional)
token: "" # No default (optional)
retry_timeout: "" # No default (optional)
request_timeout: "" # No default (optional)
request_min_throughput: 0 # No default (optional)
table: trades # No default (required)
designated_timestamp_field: "" # No default (optional)
designated_timestamp_unit: auto
timestamp_string_fields: [] # No default (optional)
timestamp_string_format: Jan _2 15:04:05.000000Z0700
symbols: [] # No default (optional)
doubles: [] # No default (optional)
error_on_empty_messages: false
We recommend that the dedupe feature is enabled on the QuestDB server. Please visit https://questdb.io/docs/ for more information about deploying, configuring, and using QuestDB.
Performance
This output benefits from sending multiple messages in flight in parallel for improved performance. You can tune the max number of in flight messages (or message batches) with the field max_in_flight
.
This output benefits from sending messages as a batch for improved performance. Batches can be formed at both the input and output level. You can find out more in this doc.
Fields
max_in_flight
The maximum number of messages to have in flight at a given time. Increase this to improve throughput.
Type: int
Default: 64
batching
Allows you to configure a batching policy.
Type: object
# Examples
batching:
byte_size: 5000
count: 0
period: 1s
batching:
count: 10
period: 1s
batching:
check: this.contains("END BATCH")
count: 0
period: 1m
batching.count
A number of messages at which the batch should be flushed. If 0
disables count based batching.
Type: int
Default: 0
batching.byte_size
An amount of bytes at which the batch should be flushed. If 0
disables size based batching.
Type: int
Default: 0
batching.period
A period in which an incomplete batch should be flushed regardless of its size.
Type: string
Default: ""
# Examples
period: 1s
period: 1m
period: 500ms
batching.check
A Bloblang query that should return a boolean value indicating whether a message should end a batch.
Type: string
Default: ""
# Examples
check: this.type == "end_of_transaction"
batching.processors
A list of processors to apply to a batch as it is flushed. This allows you to aggregate and archive the batch however you see fit. Please note that all resulting messages are flushed as a single batch, therefore splitting the batch into smaller batches using these processors is a no-op.
Type: array
# Examples
processors:
- archive:
format: concatenate
processors:
- archive:
format: lines
processors:
- archive:
format: json_array
tls
Custom TLS settings can be used to override system defaults.
Type: object
tls.enabled
Whether custom TLS settings are enabled.
Type: bool
Default: false
tls.skip_cert_verify
Whether to skip server side certificate verification.
Type: bool
Default: false
tls.enable_renegotiation
Whether to allow the remote server to repeatedly request renegotiation. Enable this option if you're seeing the error message local error: tls: no renegotiation
.
Type: bool
Default: false
Requires version 1.0.0 or newer
tls.root_cas
An optional root certificate authority to use. This is a string, representing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate.
This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info.
Type: string
Default: ""
# Examples
root_cas: |-
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
tls.root_cas_file
An optional path of a root certificate authority file to use. This is a file, often with a .pem extension, containing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate.
Type: string
Default: ""
# Examples
root_cas_file: ./root_cas.pem
tls.client_certs
A list of client certificates to use. For each certificate either the fields cert
and key
, or cert_file
and key_file
should be specified, but not both.
Type: array
Default: []
# Examples
client_certs:
- cert: foo
key: bar
client_certs:
- cert_file: ./example.pem
key_file: ./example.key
tls.client_certs[].cert
A plain text certificate to use.
Type: string
Default: ""
tls.client_certs[].key
A plain text certificate key to use.
This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info.
Type: string
Default: ""
tls.client_certs[].cert_file
The path of a certificate to use.
Type: string
Default: ""
tls.client_certs[].key_file
The path of a certificate key to use.
Type: string
Default: ""
tls.client_certs[].password
A plain text password for when the private key is password encrypted in PKCS#1 or PKCS#8 format. The obsolete pbeWithMD5AndDES-CBC
algorithm is not supported for the PKCS#8 format. Warning: Since it does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext.
This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info.
Type: string
Default: ""
# Examples
password: foo
password: ${KEY_PASSWORD}
address
Address of the QuestDB server's HTTP port (excluding protocol)
Type: string
# Examples
address: localhost:9000
username
Username for HTTP basic auth
Type: string
password
Password for HTTP basic auth
This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info.
Type: string
token
Bearer token for HTTP auth (takes precedence over basic auth username & password)
This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info.
Type: string
retry_timeout
The time to continue retrying after a failed HTTP request. The interval between retries is an exponential backoff starting at 10ms and doubling after each failed attempt up to a maximum of 1 second.
Type: string
request_timeout
The time to wait for a response from the server. This is in addition to the calculation derived from the request_min_throughput parameter.
Type: string
request_min_throughput
Minimum expected throughput in bytes per second for HTTP requests. If the throughput is lower than this value, the connection will time out. This is used to calculate an additional timeout on top of request_timeout. This is useful for large requests. You can set this value to 0 to disable this logic.
Type: int
table
Destination table
Type: string
# Examples
table: trades
designated_timestamp_field
Name of the designated timestamp field
Type: string
designated_timestamp_unit
Designated timestamp field units
Type: string
Default: "auto"
Options: nanos
, micros
, millis
, seconds
, auto
.
timestamp_string_fields
String fields with textual timestamps
Type: array
timestamp_string_format
Timestamp format, used when parsing timestamp string fields. Specified in golang's time.Parse layout
Type: string
Default: "Jan _2 15:04:05.000000Z0700"
symbols
Columns that should be the SYMBOL type (string values default to STRING)
Type: array
doubles
Columns that should be double type, (int is default)
Type: array
error_on_empty_messages
Mark a message as errored if it is empty after field validation
Type: bool
Default: false