Skip to content

Commit 8f255e1

Browse files
sunng87sunng87
committed
docs: add website docs
1 parent 58ba5ff commit 8f255e1

File tree

1 file changed

+312
-0
lines changed

1 file changed

+312
-0
lines changed

‎website/cue/reference/components/sinks/base/greptimedb.cue

+312
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,312 @@
1+
package metadata
2+
3+
base: components: sinks: greptimedb: configuration: {
4+
acknowledgements: {
5+
description: """
6+
Controls how acknowledgements are handled for this sink.
7+
8+
See [End-to-end Acknowledgements][e2e_acks] for more information on how event acknowledgement is handled.
9+
10+
[e2e_acks]: https://vector.dev/docs/about/under-the-hood/architecture/end-to-end-acknowledgements/
11+
"""
12+
required: false
13+
type: object: options: enabled: {
14+
description: """
15+
Whether or not end-to-end acknowledgements are enabled.
16+
17+
When enabled for a sink, any source connected to that sink, where the source supports
18+
end-to-end acknowledgements as well, waits for events to be acknowledged by the sink
19+
before acknowledging them at the source.
20+
21+
Enabling or disabling acknowledgements at the sink level takes precedence over any global
22+
[`acknowledgements`][global_acks] configuration.
23+
24+
[global_acks]: https://vector.dev/docs/reference/configuration/global-options/#acknowledgements
25+
"""
26+
required: false
27+
type: bool: {}
28+
}
29+
}
30+
batch: {
31+
description: "Event batching behavior."
32+
required: false
33+
type: object: options: {
34+
max_bytes: {
35+
description: """
36+
The maximum size of a batch that is processed by a sink.
37+
38+
This is based on the uncompressed size of the batched events, before they are
39+
serialized/compressed.
40+
"""
41+
required: false
42+
type: uint: unit: "bytes"
43+
}
44+
max_events: {
45+
description: "The maximum size of a batch before it is flushed."
46+
required: false
47+
type: uint: {
48+
default: 20
49+
unit: "events"
50+
}
51+
}
52+
timeout_secs: {
53+
description: "The maximum age of a batch before it is flushed."
54+
required: false
55+
type: float: {
56+
default: 1.0
57+
unit: "seconds"
58+
}
59+
}
60+
}
61+
}
62+
dbname: {
63+
description: "The database name to connect"
64+
required: false
65+
type: string: examples: [
66+
"public",
67+
]
68+
}
69+
endpoint: {
70+
description: "The host and port of greptimedb grpc service"
71+
required: true
72+
type: string: examples: ["example.com:4001"]
73+
}
74+
password: {
75+
description: "The password of greptimedb"
76+
required: false
77+
type: string: examples: ["password"]
78+
}
79+
request: {
80+
description: """
81+
Middleware settings for outbound requests.
82+
83+
Various settings can be configured, such as concurrency and rate limits, timeouts, etc.
84+
"""
85+
required: false
86+
type: object: options: {
87+
adaptive_concurrency: {
88+
description: """
89+
Configuration of adaptive concurrency parameters.
90+
91+
These parameters typically do not require changes from the default, and incorrect values can lead to meta-stable or
92+
unstable performance and sink behavior. Proceed with caution.
93+
"""
94+
required: false
95+
type: object: options: {
96+
decrease_ratio: {
97+
description: """
98+
The fraction of the current value to set the new concurrency limit when decreasing the limit.
99+
100+
Valid values are greater than `0` and less than `1`. Smaller values cause the algorithm to scale back rapidly
101+
when latency increases.
102+
103+
Note that the new limit is rounded down after applying this ratio.
104+
"""
105+
required: false
106+
type: float: default: 0.9
107+
}
108+
ewma_alpha: {
109+
description: """
110+
The weighting of new measurements compared to older measurements.
111+
112+
Valid values are greater than `0` and less than `1`.
113+
114+
ARC uses an exponentially weighted moving average (EWMA) of past RTT measurements as a reference to compare with
115+
the current RTT. Smaller values cause this reference to adjust more slowly, which may be useful if a service has
116+
unusually high response variability.
117+
"""
118+
required: false
119+
type: float: default: 0.4
120+
}
121+
rtt_deviation_scale: {
122+
description: """
123+
Scale of RTT deviations which are not considered anomalous.
124+
125+
Valid values are greater than or equal to `0`, and we expect reasonable values to range from `1.0` to `3.0`.
126+
127+
When calculating the past RTT average, we also compute a secondary “deviation” value that indicates how variable
128+
those values are. We use that deviation when comparing the past RTT average to the current measurements, so we
129+
can ignore increases in RTT that are within an expected range. This factor is used to scale up the deviation to
130+
an appropriate range. Larger values cause the algorithm to ignore larger increases in the RTT.
131+
"""
132+
required: false
133+
type: float: default: 2.5
134+
}
135+
}
136+
}
137+
concurrency: {
138+
description: "Configuration for outbound request concurrency."
139+
required: false
140+
type: {
141+
string: {
142+
default: "none"
143+
enum: {
144+
adaptive: """
145+
Concurrency will be managed by Vector's [Adaptive Request Concurrency][arc] feature.
146+
147+
[arc]: https://vector.dev/docs/about/under-the-hood/networking/arc/
148+
"""
149+
none: """
150+
A fixed concurrency of 1.
151+
152+
Only one request can be outstanding at any given time.
153+
"""
154+
}
155+
}
156+
uint: {}
157+
}
158+
}
159+
rate_limit_duration_secs: {
160+
description: "The time window used for the `rate_limit_num` option."
161+
required: false
162+
type: uint: {
163+
default: 1
164+
unit: "seconds"
165+
}
166+
}
167+
rate_limit_num: {
168+
description: "The maximum number of requests allowed within the `rate_limit_duration_secs` time window."
169+
required: false
170+
type: uint: {
171+
default: 9223372036854775807
172+
unit: "requests"
173+
}
174+
}
175+
retry_attempts: {
176+
description: """
177+
The maximum number of retries to make for failed requests.
178+
179+
The default, for all intents and purposes, represents an infinite number of retries.
180+
"""
181+
required: false
182+
type: uint: {
183+
default: 9223372036854775807
184+
unit: "retries"
185+
}
186+
}
187+
retry_initial_backoff_secs: {
188+
description: """
189+
The amount of time to wait before attempting the first retry for a failed request.
190+
191+
After the first retry has failed, the fibonacci sequence is used to select future backoffs.
192+
"""
193+
required: false
194+
type: uint: {
195+
default: 1
196+
unit: "seconds"
197+
}
198+
}
199+
retry_max_duration_secs: {
200+
description: "The maximum amount of time to wait between retries."
201+
required: false
202+
type: uint: {
203+
default: 3600
204+
unit: "seconds"
205+
}
206+
}
207+
timeout_secs: {
208+
description: """
209+
The time a request can take before being aborted.
210+
211+
Datadog highly recommends that you do not lower this value below the service's internal timeout, as this could
212+
create orphaned requests, pile on retries, and result in duplicate data downstream.
213+
"""
214+
required: false
215+
type: uint: {
216+
default: 60
217+
unit: "seconds"
218+
}
219+
}
220+
}
221+
}
222+
tls: {
223+
description: "TLS configuration."
224+
required: false
225+
type: object: options: {
226+
alpn_protocols: {
227+
description: """
228+
Sets the list of supported ALPN protocols.
229+
230+
Declare the supported ALPN protocols, which are used during negotiation with peer. They are prioritized in the order
231+
that they are defined.
232+
"""
233+
required: false
234+
type: array: items: type: string: examples: ["h2"]
235+
}
236+
ca_file: {
237+
description: """
238+
Absolute path to an additional CA certificate file.
239+
240+
The certificate must be in the DER or PEM (X.509) format. Additionally, the certificate can be provided as an inline string in PEM format.
241+
"""
242+
required: false
243+
type: string: examples: ["/path/to/certificate_authority.crt"]
244+
}
245+
crt_file: {
246+
description: """
247+
Absolute path to a certificate file used to identify this server.
248+
249+
The certificate must be in DER, PEM (X.509), or PKCS#12 format. Additionally, the certificate can be provided as
250+
an inline string in PEM format.
251+
252+
If this is set, and is not a PKCS#12 archive, `key_file` must also be set.
253+
"""
254+
required: false
255+
type: string: examples: ["/path/to/host_certificate.crt"]
256+
}
257+
key_file: {
258+
description: """
259+
Absolute path to a private key file used to identify this server.
260+
261+
The key must be in DER or PEM (PKCS#8) format. Additionally, the key can be provided as an inline string in PEM format.
262+
"""
263+
required: false
264+
type: string: examples: ["/path/to/host_certificate.key"]
265+
}
266+
key_pass: {
267+
description: """
268+
Passphrase used to unlock the encrypted key file.
269+
270+
This has no effect unless `key_file` is set.
271+
"""
272+
required: false
273+
type: string: examples: ["${KEY_PASS_ENV_VAR}", "PassWord1"]
274+
}
275+
verify_certificate: {
276+
description: """
277+
Enables certificate verification.
278+
279+
If enabled, certificates must not be expired and must be issued by a trusted
280+
issuer. This verification operates in a hierarchical manner, checking that the leaf certificate (the
281+
certificate presented by the client/server) is not only valid, but that the issuer of that certificate is also valid, and
282+
so on until the verification process reaches a root certificate.
283+
284+
Relevant for both incoming and outgoing connections.
285+
286+
Do NOT set this to `false` unless you understand the risks of not verifying the validity of certificates.
287+
"""
288+
required: false
289+
type: bool: {}
290+
}
291+
verify_hostname: {
292+
description: """
293+
Enables hostname verification.
294+
295+
If enabled, the hostname used to connect to the remote host must be present in the TLS certificate presented by
296+
the remote host, either as the Common Name or as an entry in the Subject Alternative Name extension.
297+
298+
Only relevant for outgoing connections.
299+
300+
Do NOT set this to `false` unless you understand the risks of not verifying the remote hostname.
301+
"""
302+
required: false
303+
type: bool: {}
304+
}
305+
}
306+
}
307+
username: {
308+
description: "The username of greptimedb"
309+
required: false
310+
type: string: examples: ["username"]
311+
}
312+
}

0 commit comments

Comments
 (0)