Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@sklarsa
sklarsa committed Sep 3, 2024
1 parent 72775c2 commit 0862ada
Showing 1 changed file with 188 additions and 42 deletions.
230 changes: 188 additions & 42 deletions docs/modules/components/pages/outputs/questdb.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,14 @@ output:
username: "" # No default (optional)
password: "" # No default (optional)
token: "" # No default (optional)
tlsEnabled: false # No default (optional)
tlsVerify: "on"
table: trades # No default (required)
designatedTimestampField: "" # No default (optional)
designatedTimestampUnit: auto
timestampStringFields: [] # No default (optional)
timestampStringFormat: Jan _2 15:04:05.000000Z0700
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)
errorOnEmptyMessages: false
error_on_empty_messages: false
```
--
Expand All @@ -76,23 +74,28 @@ output:
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)
tlsEnabled: false # No default (optional)
tlsVerify: "on"
retryTimeout: "" # No default (optional)
requestTimeout: "" # No default (optional)
requestMinThroughput: 0 # 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)
designatedTimestampField: "" # No default (optional)
designatedTimestampUnit: auto
timestampStringFields: [] # No default (optional)
timestampStringFormat: Jan _2 15:04:05.000000Z0700
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)
errorOnEmptyMessages: false
error_on_empty_messages: false
```
--
Expand Down Expand Up @@ -219,23 +222,113 @@ processors:
format: json_array
```
=== `address`
=== `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 3.45.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.
[CAUTION]
====
This field contains sensitive information that usually shouldn't be added to a config directly, read our xref:configuration:secrets.adoc[secrets page for more info].
====
Address of the QuestDB server's HTTP port (excluding protocol)
*Type*: `string`
*Default*: `""`
```yml
# Examples
address: localhost:9000
root_cas: |-
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
```
=== `username`
=== `tls.root_cas_file`
Username for HTTP basic auth
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*: `""`
```yml
# 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*: `[]`
```yml
# 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.
[CAUTION]
====
This field contains sensitive information that usually shouldn't be added to a config directly, read our xref:configuration:secrets.adoc[secrets page for more info].
Expand All @@ -245,10 +338,31 @@ This field contains sensitive information that usually shouldn't be added to a c
*Type*: `string`
*Default*: `""`
=== `password`
=== `tls.client_certs[].cert_file`
Password for HTTP basic auth
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.
Because the obsolete pbeWithMD5AndDES-CBC algorithm does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext.
[CAUTION]
====
This field contains sensitive information that usually shouldn't be added to a config directly, read our xref:configuration:secrets.adoc[secrets page for more info].
Expand All @@ -258,10 +372,33 @@ This field contains sensitive information that usually shouldn't be added to a c
*Type*: `string`
*Default*: `""`
```yml
# Examples
=== `token`
password: foo
Bearer token for HTTP auth (takes precedence over basic auth username & password)
password: ${KEY_PASSWORD}
```
=== `address`
Address of the QuestDB server's HTTP port (excluding protocol)
*Type*: `string`
```yml
# Examples
address: localhost:9000
```
=== `username`
Username for HTTP basic auth
[CAUTION]
====
This field contains sensitive information that usually shouldn't be added to a config directly, read our xref:configuration:secrets.adoc[secrets page for more info].
Expand All @@ -272,42 +409,51 @@ This field contains sensitive information that usually shouldn't be added to a c
*Type*: `string`
=== `tlsEnabled`
=== `password`
Password for HTTP basic auth
[CAUTION]
====
This field contains sensitive information that usually shouldn't be added to a config directly, read our xref:configuration:secrets.adoc[secrets page for more info].
====
Use TLS to secure the connection to the server
*Type*: `bool`
*Type*: `string`
=== `token`
=== `tlsVerify`
Bearer token for HTTP auth (takes precedence over basic auth username & password)
[CAUTION]
====
This field contains sensitive information that usually shouldn't be added to a config directly, read our xref:configuration:secrets.adoc[secrets page for more info].
====
Whether to verify the server's certificate. This should only be used for testing as a last resort and never used in production as it makes the connection vulnerable to man-in-the-middle attacks. Options are 'on' or 'unsafe_off'.
*Type*: `string`
*Default*: `"on"`
=== `retryTimeout`
=== `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`
=== `requestTimeout`
=== `request_timeout`
The time to wait for a response from the server. This is in addition to the calculation derived from the requestMinThroughput parameter.
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`
=== `requestMinThroughput`
=== `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 requestTimeout. This is useful for large requests. You can set this value to 0 to disable this logic.
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`
Expand All @@ -327,15 +473,15 @@ Destination table
table: trades
```
=== `designatedTimestampField`
=== `designated_timestamp_field`
Name of the designated timestamp field
*Type*: `string`
=== `designatedTimestampUnit`
=== `designated_timestamp_unit`
Designated timestamp field units
Expand All @@ -344,15 +490,15 @@ Designated timestamp field units
*Default*: `"auto"`
=== `timestampStringFields`
=== `timestamp_string_fields`
String fields with textual timestamps
*Type*: `array`
=== `timestampStringFormat`
=== `timestamp_string_format`
Timestamp format, used when parsing timestamp string fields. Specified in golang's time.Parse layout
Expand All @@ -377,7 +523,7 @@ Columns that should be double type, (int is default)
*Type*: `array`
=== `errorOnEmptyMessages`
=== `error_on_empty_messages`
Mark a message as errored if it is empty after field validation
Expand Down

0 comments on commit 0862ada

Please sign in to comment.