Skip to content

docs(sinks): Remove slash from max_bytes text #23035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pront merged 1 commit into from
May 12, 2025
Merged

docs(sinks): Remove slash from max_bytes text #23035

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/sinks/util/batch.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ where
/// The maximum size of a batch that is processed by a sink.
///
/// This is based on the uncompressed size of the batched events, before they are
/// serialized/compressed.
/// serialized or compressed.
#[serde(default = "default_max_bytes::<D>")]
#[configurable(metadata(docs::type_unit = "bytes"))]
pub max_bytes: Option<usize>,
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/appsignal.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ base: components: sinks: appsignal: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ base: components: sinks: aws_cloudwatch_logs: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/aws_cloudwatch_metrics.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ base: components: sinks: aws_cloudwatch_metrics: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: unit: "bytes"
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/aws_kinesis_firehose.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ base: components: sinks: aws_kinesis_firehose: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/aws_kinesis_streams.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ base: components: sinks: aws_kinesis_streams: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/aws_s3.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ base: components: sinks: aws_s3: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/axiom.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ base: components: sinks: axiom: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/azure_blob.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ base: components: sinks: azure_blob: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/azure_monitor_logs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ base: components: sinks: azure_monitor_logs: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/clickhouse.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ base: components: sinks: clickhouse: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/databend.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ base: components: sinks: databend: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/datadog_logs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ base: components: sinks: datadog_logs: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/datadog_metrics.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ base: components: sinks: datadog_metrics: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: unit: "bytes"
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/datadog_traces.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ base: components: sinks: datadog_traces: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/elasticsearch.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ base: components: sinks: elasticsearch: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/gcp_chronicle_unstructured.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ base: components: sinks: gcp_chronicle_unstructured: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/gcp_cloud_storage.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ base: components: sinks: gcp_cloud_storage: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/gcp_pubsub.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ base: components: sinks: gcp_pubsub: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/gcp_stackdriver_logs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ base: components: sinks: gcp_stackdriver_logs: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/gcp_stackdriver_metrics.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ base: components: sinks: gcp_stackdriver_metrics: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: unit: "bytes"
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/greptimedb.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ base: components: sinks: greptimedb: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: unit: "bytes"
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/greptimedb_logs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ base: components: sinks: greptimedb_logs: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: unit: "bytes"
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/greptimedb_metrics.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ base: components: sinks: greptimedb_metrics: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: unit: "bytes"
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/honeycomb.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ base: components: sinks: honeycomb: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/http.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ base: components: sinks: http: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/humio_logs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ base: components: sinks: humio_logs: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/humio_metrics.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ base: components: sinks: humio_metrics: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/influxdb_logs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ base: components: sinks: influxdb_logs: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/influxdb_metrics.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ base: components: sinks: influxdb_metrics: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: unit: "bytes"
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/kafka.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ base: components: sinks: kafka: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: unit: "bytes"
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/keep.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ base: components: sinks: keep: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/logdna.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ base: components: sinks: logdna: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/loki.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ base: components: sinks: loki: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/mezmo.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ base: components: sinks: mezmo: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/new_relic.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ base: components: sinks: new_relic: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/opentelemetry.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ base: components: sinks: opentelemetry: configuration: protocol: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/postgres.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ base: components: sinks: postgres: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/prometheus_remote_write.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ base: components: sinks: prometheus_remote_write: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: unit: "bytes"
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/redis.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ base: components: sinks: redis: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: unit: "bytes"
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/sematext_logs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ base: components: sinks: sematext_logs: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/sematext_metrics.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ base: components: sinks: sematext_metrics: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: unit: "bytes"
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/splunk_hec_logs.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ base: components: sinks: splunk_hec_logs: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sinks/base/splunk_hec_metrics.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ base: components: sinks: splunk_hec_metrics: configuration: {
The maximum size of a batch that is processed by a sink.

This is based on the uncompressed size of the batched events, before they are
serialized/compressed.
serialized or compressed.
"""
required: false
type: uint: {
Expand Down
Loading
Loading