Skip to content

Commit a5b1208

Browse files
committed
Revert "Update docs"
This reverts commit aee2a7f.
1 parent da116e6 commit a5b1208

14 files changed

Lines changed: 448 additions & 3 deletions

website/cue/reference/components/sinks/generated/appsignal.cue

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,37 @@ generated: components: sinks: appsignal: configuration: {
323323
}
324324
}
325325
}
326+
retry_strategy: {
327+
description: """
328+
Configurable retry strategy for `http` based sinks.
329+
330+
For more information about error responses, see [Client Error Responses][error_responses].
331+
332+
[error_responses]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status#client_error_responses
333+
"""
334+
required: false
335+
type: object: options: {
336+
status_codes: {
337+
description: "Retry on these specific HTTP status codes"
338+
relevant_when: "type = \"custom\""
339+
required: true
340+
type: array: items: type: uint: {}
341+
}
342+
type: {
343+
description: "The retry strategy enum."
344+
required: false
345+
type: string: {
346+
default: "default"
347+
enum: {
348+
all: "Retry on *all* HTTP status codes except for success codes (2xx)"
349+
custom: "Custom retry strategy"
350+
default: "Default strategy. See [`RetryStrategy::retry_action`] for more details."
351+
none: "Don't retry any errors, including request timeouts."
352+
}
353+
}
354+
}
355+
}
356+
}
326357
tls: {
327358
description: "Configures the TLS options for incoming/outgoing connections."
328359
required: false

website/cue/reference/components/sinks/generated/aws_s3.cue

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,79 @@ generated: components: sinks: aws_s3: configuration: {
256256
}
257257
}
258258
}
259+
batch_encoding: {
260+
description: """
261+
Batch encoding configuration for columnar formats.
262+
263+
When set, events are encoded together as a batch in a columnar format (Parquet)
264+
instead of the standard per-event framing-based encoding. The columnar format handles
265+
its own internal compression, so the top-level `compression` setting is bypassed.
266+
"""
267+
required: false
268+
type: object: options: {
269+
codec: {
270+
description: """
271+
Encodes events in [Apache Parquet][apache_parquet] columnar format.
272+
273+
[apache_parquet]: https://parquet.apache.org/
274+
"""
275+
required: true
276+
type: string: enum: parquet: """
277+
Encodes events in [Apache Parquet][apache_parquet] columnar format.
278+
279+
[apache_parquet]: https://parquet.apache.org/
280+
"""
281+
}
282+
compression: {
283+
description: "Compression codec applied per column page inside the Parquet file."
284+
required: false
285+
type: object: options: {
286+
algorithm: {
287+
description: "Compression codec applied per column page inside the Parquet file."
288+
required: false
289+
type: string: {
290+
default: "snappy"
291+
enum: {
292+
gzip: "Gzip compression. Level must be between 1 and 9."
293+
lz4: "LZ4 raw compression"
294+
none: "No compression"
295+
snappy: "Snappy compression (no level)."
296+
zstd: "Zstd compression. Level must be between 1 and 21."
297+
}
298+
}
299+
}
300+
level: {
301+
description: "Compression level (1–21). This is the range Vector supports; higher values compress more but are slower."
302+
relevant_when: "algorithm = \"zstd\" or algorithm = \"gzip\""
303+
required: true
304+
type: uint: {}
305+
}
306+
}
307+
}
308+
schema_file: {
309+
description: """
310+
Path to a native Parquet schema file (`.schema`).
311+
312+
Required unless `schema_mode` is `auto_infer`. The file must contain a valid
313+
Parquet message type definition.
314+
"""
315+
required: false
316+
type: string: {}
317+
}
318+
schema_mode: {
319+
description: "Controls how events with fields not present in the schema are handled."
320+
required: false
321+
type: string: {
322+
default: "relaxed"
323+
enum: {
324+
auto_infer: "Auto infer schema based on the batch. No schema file needed."
325+
relaxed: "Missing fields become null. Extra fields are silently dropped."
326+
strict: "Missing fields become null. Extra fields cause an error."
327+
}
328+
}
329+
}
330+
}
331+
}
259332
bucket: {
260333
description: """
261334
The S3 bucket name.

website/cue/reference/components/sinks/generated/axiom.cue

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,37 @@ generated: components: sinks: axiom: configuration: {
305305
}
306306
}
307307
}
308+
retry_strategy: {
309+
description: """
310+
Configurable retry strategy for `http` based sinks.
311+
312+
For more information about error responses, see [Client Error Responses][error_responses].
313+
314+
[error_responses]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status#client_error_responses
315+
"""
316+
required: false
317+
type: object: options: {
318+
status_codes: {
319+
description: "Retry on these specific HTTP status codes"
320+
relevant_when: "type = \"custom\""
321+
required: true
322+
type: array: items: type: uint: {}
323+
}
324+
type: {
325+
description: "The retry strategy enum."
326+
required: false
327+
type: string: {
328+
default: "default"
329+
enum: {
330+
all: "Retry on *all* HTTP status codes except for success codes (2xx)"
331+
custom: "Custom retry strategy"
332+
default: "Default strategy. See [`RetryStrategy::retry_action`] for more details."
333+
none: "Don't retry any errors, including request timeouts."
334+
}
335+
}
336+
}
337+
}
338+
}
308339
tls: {
309340
description: """
310341
The TLS settings for the connection.

website/cue/reference/components/sinks/generated/azure_logs_ingestion.cue

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -408,6 +408,37 @@ generated: components: sinks: azure_logs_ingestion: configuration: {
408408
}
409409
}
410410
}
411+
retry_strategy: {
412+
description: """
413+
Configurable retry strategy for `http` based sinks.
414+
415+
For more information about error responses, see [Client Error Responses][error_responses].
416+
417+
[error_responses]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status#client_error_responses
418+
"""
419+
required: false
420+
type: object: options: {
421+
status_codes: {
422+
description: "Retry on these specific HTTP status codes"
423+
relevant_when: "type = \"custom\""
424+
required: true
425+
type: array: items: type: uint: {}
426+
}
427+
type: {
428+
description: "The retry strategy enum."
429+
required: false
430+
type: string: {
431+
default: "default"
432+
enum: {
433+
all: "Retry on *all* HTTP status codes except for success codes (2xx)"
434+
custom: "Custom retry strategy"
435+
default: "Default strategy. See [`RetryStrategy::retry_action`] for more details."
436+
none: "Don't retry any errors, including request timeouts."
437+
}
438+
}
439+
}
440+
}
441+
}
411442
stream_name: {
412443
description: """
413444
The [Stream name][stream_name] for the Data collection rule.

website/cue/reference/components/sinks/generated/azure_monitor_logs.cue

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,37 @@ generated: components: sinks: azure_monitor_logs: configuration: {
314314
}
315315
}
316316
}
317+
retry_strategy: {
318+
description: """
319+
Configurable retry strategy for `http` based sinks.
320+
321+
For more information about error responses, see [Client Error Responses][error_responses].
322+
323+
[error_responses]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status#client_error_responses
324+
"""
325+
required: false
326+
type: object: options: {
327+
status_codes: {
328+
description: "Retry on these specific HTTP status codes"
329+
relevant_when: "type = \"custom\""
330+
required: true
331+
type: array: items: type: uint: {}
332+
}
333+
type: {
334+
description: "The retry strategy enum."
335+
required: false
336+
type: string: {
337+
default: "default"
338+
enum: {
339+
all: "Retry on *all* HTTP status codes except for success codes (2xx)"
340+
custom: "Custom retry strategy"
341+
default: "Default strategy. See [`RetryStrategy::retry_action`] for more details."
342+
none: "Don't retry any errors, including request timeouts."
343+
}
344+
}
345+
}
346+
}
347+
}
317348
shared_key: {
318349
description: """
319350
The [primary or the secondary key][shared_key] for the Log Analytics workspace.

website/cue/reference/components/sinks/generated/clickhouse.cue

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -256,12 +256,12 @@ generated: components: sinks: clickhouse: configuration: {
256256
description: """
257257
Allow null values for non-nullable fields in the schema.
258258
259-
When enabled, missing or incompatible values will be encoded as null even for fields
259+
When enabled, missing or incompatible values are encoded as null, even for fields
260260
marked as non-nullable in the Arrow schema. This is useful when working with downstream
261261
systems that can handle null values through defaults, computed columns, or other mechanisms.
262262
263-
When disabled (default), missing values for non-nullable fields will cause encoding errors,
264-
ensuring all required data is present before sending to the sink.
263+
When disabled (default), missing values for non-nullable fields results in encoding errors. This is to
264+
help ensure all required data is present before sending it to the sink.
265265
"""
266266
required: false
267267
type: bool: default: false

website/cue/reference/components/sinks/generated/datadog_events.cue

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,37 @@ generated: components: sinks: datadog_events: configuration: {
242242
}
243243
}
244244
}
245+
retry_strategy: {
246+
description: """
247+
Configurable retry strategy for `http` based sinks.
248+
249+
For more information about error responses, see [Client Error Responses][error_responses].
250+
251+
[error_responses]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status#client_error_responses
252+
"""
253+
required: false
254+
type: object: options: {
255+
status_codes: {
256+
description: "Retry on these specific HTTP status codes"
257+
relevant_when: "type = \"custom\""
258+
required: true
259+
type: array: items: type: uint: {}
260+
}
261+
type: {
262+
description: "The retry strategy enum."
263+
required: false
264+
type: string: {
265+
default: "default"
266+
enum: {
267+
all: "Retry on *all* HTTP status codes except for success codes (2xx)"
268+
custom: "Custom retry strategy"
269+
default: "Default strategy. See [`RetryStrategy::retry_action`] for more details."
270+
none: "Don't retry any errors, including request timeouts."
271+
}
272+
}
273+
}
274+
}
275+
}
245276
site: {
246277
description: """
247278
The Datadog [site][dd_site] to send observability data to.

website/cue/reference/components/sinks/generated/gcp_stackdriver_logs.cue

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -420,6 +420,37 @@ generated: components: sinks: gcp_stackdriver_logs: configuration: {
420420
}
421421
}
422422
}
423+
retry_strategy: {
424+
description: """
425+
Configurable retry strategy for `http` based sinks.
426+
427+
For more information about error responses, see [Client Error Responses][error_responses].
428+
429+
[error_responses]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status#client_error_responses
430+
"""
431+
required: false
432+
type: object: options: {
433+
status_codes: {
434+
description: "Retry on these specific HTTP status codes"
435+
relevant_when: "type = \"custom\""
436+
required: true
437+
type: array: items: type: uint: {}
438+
}
439+
type: {
440+
description: "The retry strategy enum."
441+
required: false
442+
type: string: {
443+
default: "default"
444+
enum: {
445+
all: "Retry on *all* HTTP status codes except for success codes (2xx)"
446+
custom: "Custom retry strategy"
447+
default: "Default strategy. See [`RetryStrategy::retry_action`] for more details."
448+
none: "Don't retry any errors, including request timeouts."
449+
}
450+
}
451+
}
452+
}
453+
}
423454
severity_key: {
424455
description: """
425456
The field of the log event from which to take the outgoing log’s `severity` field.

website/cue/reference/components/sinks/generated/gcp_stackdriver_metrics.cue

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,37 @@ generated: components: sinks: gcp_stackdriver_metrics: configuration: {
334334
}
335335
}
336336
}
337+
retry_strategy: {
338+
description: """
339+
Configurable retry strategy for `http` based sinks.
340+
341+
For more information about error responses, see [Client Error Responses][error_responses].
342+
343+
[error_responses]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status#client_error_responses
344+
"""
345+
required: false
346+
type: object: options: {
347+
status_codes: {
348+
description: "Retry on these specific HTTP status codes"
349+
relevant_when: "type = \"custom\""
350+
required: true
351+
type: array: items: type: uint: {}
352+
}
353+
type: {
354+
description: "The retry strategy enum."
355+
required: false
356+
type: string: {
357+
default: "default"
358+
enum: {
359+
all: "Retry on *all* HTTP status codes except for success codes (2xx)"
360+
custom: "Custom retry strategy"
361+
default: "Default strategy. See [`RetryStrategy::retry_action`] for more details."
362+
none: "Don't retry any errors, including request timeouts."
363+
}
364+
}
365+
}
366+
}
367+
}
337368
tls: {
338369
description: "TLS configuration."
339370
required: false

website/cue/reference/components/sinks/generated/honeycomb.cue

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -321,4 +321,35 @@ generated: components: sinks: honeycomb: configuration: {
321321
}
322322
}
323323
}
324+
retry_strategy: {
325+
description: """
326+
Configurable retry strategy for `http` based sinks.
327+
328+
For more information about error responses, see [Client Error Responses][error_responses].
329+
330+
[error_responses]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status#client_error_responses
331+
"""
332+
required: false
333+
type: object: options: {
334+
status_codes: {
335+
description: "Retry on these specific HTTP status codes"
336+
relevant_when: "type = \"custom\""
337+
required: true
338+
type: array: items: type: uint: {}
339+
}
340+
type: {
341+
description: "The retry strategy enum."
342+
required: false
343+
type: string: {
344+
default: "default"
345+
enum: {
346+
all: "Retry on *all* HTTP status codes except for success codes (2xx)"
347+
custom: "Custom retry strategy"
348+
default: "Default strategy. See [`RetryStrategy::retry_action`] for more details."
349+
none: "Don't retry any errors, including request timeouts."
350+
}
351+
}
352+
}
353+
}
354+
}
324355
}

0 commit comments

Comments
 (0)