diff --git a/lib/codecs/src/decoding/format/gelf.rs b/lib/codecs/src/decoding/format/gelf.rs index bc30acf057e3b..282d11749dd25 100644 --- a/lib/codecs/src/decoding/format/gelf.rs +++ b/lib/codecs/src/decoding/format/gelf.rs @@ -20,11 +20,11 @@ use super::{default_lossy, Deserializer}; use crate::gelf::GELF_TARGET_PATHS; use crate::{gelf_fields::*, VALID_FIELD_REGEX}; -/// On GELF decoding behavior: -/// Graylog has a relaxed decoding. They are much more lenient than the spec would -/// suggest. We've elected to take a more strict approach to maintain backwards compatibility -/// in the event that we need to change the behavior to be more relaxed, so that prior versions -/// of vector will still work with the new relaxed decoding. +// On GELF decoding behavior: +// Graylog has a relaxed decoding. They are much more lenient than the spec would +// suggest. We've elected to take a more strict approach to maintain backwards compatibility +// in the event that we need to change the behavior to be more relaxed, so that prior versions +// of vector will still work with the new relaxed decoding. /// Config used to build a `GelfDeserializer`. #[configurable_component] diff --git a/lib/codecs/src/decoding/mod.rs b/lib/codecs/src/decoding/mod.rs index 008de9d9d245e..f4465fcacb434 100644 --- a/lib/codecs/src/decoding/mod.rs +++ b/lib/codecs/src/decoding/mod.rs @@ -216,7 +216,7 @@ pub enum DeserializerConfig { /// [rfc5424]: https://www.ietf.org/rfc/rfc5424.txt Syslog(SyslogDeserializerConfig), - /// Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + /// Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. /// /// This codec is **[experimental][experimental]**. /// @@ -224,7 +224,7 @@ pub enum DeserializerConfig { /// [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs Native, - /// Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + /// Decodes the raw bytes as [native JSON format][vector_native_json]. /// /// This codec is **[experimental][experimental]**. /// diff --git a/lib/codecs/src/encoding/format/csv.rs b/lib/codecs/src/encoding/format/csv.rs index a440c994d01ef..cc485139fdee7 100644 --- a/lib/codecs/src/encoding/format/csv.rs +++ b/lib/codecs/src/encoding/format/csv.rs @@ -15,22 +15,22 @@ use vector_core::{ #[derive(Copy, Clone, Debug, PartialEq, Eq, Default)] #[serde(rename_all = "snake_case")] pub enum QuoteStyle { - /// This puts quotes around every field. Always. + /// Always puts quotes around every field. Always, - /// This puts quotes around fields only when necessary. - /// They are necessary when fields contain a quote, delimiter or record terminator. + /// Puts quotes around fields only when necessary. + /// They are necessary when fields contain a quote, delimiter, or record terminator. /// Quotes are also necessary when writing an empty record /// (which is indistinguishable from a record with one empty field). #[default] Necessary, - /// This puts quotes around all fields that are non-numeric. + /// Puts quotes around all fields that are non-numeric. /// Namely, when writing a field that does not parse as a valid float or integer, - /// then quotes will be used even if they aren’t strictly necessary. + /// then quotes are used even if they aren't strictly necessary. NonNumeric, - /// This never writes quotes, even if it would produce invalid CSV data. + /// Never writes quotes, even if it produces invalid CSV data. Never, } @@ -97,7 +97,7 @@ pub struct CsvSerializerOptions { /// In some variants of CSV, quotes are escaped using a special escape character /// like \ (instead of escaping quotes by doubling them). /// - /// To use this `double_quotes` needs to be disabled as well otherwise it is ignored + /// To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. #[serde( default = "default_escape", with = "vector_core::serde::ascii_char", diff --git a/src/sources/file.rs b/src/sources/file.rs index f0fd0be30811b..6a4d2224db2d9 100644 --- a/src/sources/file.rs +++ b/src/sources/file.rs @@ -206,7 +206,7 @@ pub struct FileConfig { pub multiline: Option, /// Max amount of bytes to read from a single file before switching over to the next file. - /// **Note:** This does not apply when `oldest_first` is `true. + /// **Note:** This does not apply when `oldest_first` is `true`. /// /// This allows distributing the reads more or less evenly across /// the files. @@ -214,7 +214,7 @@ pub struct FileConfig { #[configurable(metadata(docs::type_unit = "bytes"))] pub max_read_bytes: usize, - /// Instead of balancing read capacity fairly across all watched files, prioritize draining the oldest files before moving on to read data from younger files. + /// Instead of balancing read capacity fairly across all watched files, prioritize draining the oldest files before moving on to read data from more recent files. #[serde(default)] pub oldest_first: bool, diff --git a/src/sources/kubernetes_logs/mod.rs b/src/sources/kubernetes_logs/mod.rs index 890d05586436b..6bd20e9b77c93 100644 --- a/src/sources/kubernetes_logs/mod.rs +++ b/src/sources/kubernetes_logs/mod.rs @@ -164,14 +164,14 @@ pub struct Config { ignore_older_secs: Option, /// Max amount of bytes to read from a single file before switching over to the next file. - /// **Note:** This does not apply when `oldest_first` is `true. + /// **Note:** This does not apply when `oldest_first` is `true`. /// /// This allows distributing the reads more or less evenly across /// the files. #[configurable(metadata(docs::type_unit = "bytes"))] max_read_bytes: usize, - /// Instead of balancing read capacity fairly across all watched files, prioritize draining the oldest files before moving on to read data from younger files. + /// Instead of balancing read capacity fairly across all watched files, prioritize draining the oldest files before moving on to read data from more recent files. #[serde(default = "default_oldest_first")] pub oldest_first: bool, diff --git a/website/cue/reference/components/sinks/base/amqp.cue b/website/cue/reference/components/sinks/base/amqp.cue index 213a2e226c245..366520be4c1a2 100644 --- a/website/cue/reference/components/sinks/base/amqp.cue +++ b/website/cue/reference/components/sinks/base/amqp.cue @@ -158,7 +158,7 @@ base: components: sinks: amqp: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -187,18 +187,18 @@ base: components: sinks: amqp: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue b/website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue index e18453f47703d..7f9bdd91998cb 100644 --- a/website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue +++ b/website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue @@ -329,7 +329,7 @@ base: components: sinks: aws_cloudwatch_logs: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -358,18 +358,18 @@ base: components: sinks: aws_cloudwatch_logs: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/aws_kinesis_firehose.cue b/website/cue/reference/components/sinks/base/aws_kinesis_firehose.cue index 71bdc26dc6b30..38fed9c23a1b2 100644 --- a/website/cue/reference/components/sinks/base/aws_kinesis_firehose.cue +++ b/website/cue/reference/components/sinks/base/aws_kinesis_firehose.cue @@ -308,7 +308,7 @@ base: components: sinks: aws_kinesis_firehose: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -337,18 +337,18 @@ base: components: sinks: aws_kinesis_firehose: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/aws_kinesis_streams.cue b/website/cue/reference/components/sinks/base/aws_kinesis_streams.cue index 77b8fe21a94f8..7e537909094cc 100644 --- a/website/cue/reference/components/sinks/base/aws_kinesis_streams.cue +++ b/website/cue/reference/components/sinks/base/aws_kinesis_streams.cue @@ -308,7 +308,7 @@ base: components: sinks: aws_kinesis_streams: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -337,18 +337,18 @@ base: components: sinks: aws_kinesis_streams: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/aws_s3.cue b/website/cue/reference/components/sinks/base/aws_s3.cue index 802bf4111a340..1ae27bb0672d0 100644 --- a/website/cue/reference/components/sinks/base/aws_s3.cue +++ b/website/cue/reference/components/sinks/base/aws_s3.cue @@ -417,7 +417,7 @@ base: components: sinks: aws_s3: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -446,18 +446,18 @@ base: components: sinks: aws_s3: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/aws_sns.cue b/website/cue/reference/components/sinks/base/aws_sns.cue index 3cde47292280d..f6ee85a91d494 100644 --- a/website/cue/reference/components/sinks/base/aws_sns.cue +++ b/website/cue/reference/components/sinks/base/aws_sns.cue @@ -244,7 +244,7 @@ base: components: sinks: aws_sns: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -273,18 +273,18 @@ base: components: sinks: aws_sns: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/aws_sqs.cue b/website/cue/reference/components/sinks/base/aws_sqs.cue index 4a9cf238eb0e7..a130903629ac9 100644 --- a/website/cue/reference/components/sinks/base/aws_sqs.cue +++ b/website/cue/reference/components/sinks/base/aws_sqs.cue @@ -244,7 +244,7 @@ base: components: sinks: aws_sqs: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -273,18 +273,18 @@ base: components: sinks: aws_sqs: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/azure_blob.cue b/website/cue/reference/components/sinks/base/azure_blob.cue index df84255dec51e..10bf1b1fac14c 100644 --- a/website/cue/reference/components/sinks/base/azure_blob.cue +++ b/website/cue/reference/components/sinks/base/azure_blob.cue @@ -271,7 +271,7 @@ base: components: sinks: azure_blob: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -300,18 +300,18 @@ base: components: sinks: azure_blob: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/console.cue b/website/cue/reference/components/sinks/base/console.cue index 5b22906133e9d..bfa8a11acbfb2 100644 --- a/website/cue/reference/components/sinks/base/console.cue +++ b/website/cue/reference/components/sinks/base/console.cue @@ -142,7 +142,7 @@ base: components: sinks: console: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -171,18 +171,18 @@ base: components: sinks: console: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/databend.cue b/website/cue/reference/components/sinks/base/databend.cue index d1acbb167c4a1..63cafbb7ea6d9 100644 --- a/website/cue/reference/components/sinks/base/databend.cue +++ b/website/cue/reference/components/sinks/base/databend.cue @@ -187,7 +187,7 @@ base: components: sinks: databend: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -216,18 +216,18 @@ base: components: sinks: databend: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/file.cue b/website/cue/reference/components/sinks/base/file.cue index 0c2696db0c8b2..b98956de02479 100644 --- a/website/cue/reference/components/sinks/base/file.cue +++ b/website/cue/reference/components/sinks/base/file.cue @@ -162,7 +162,7 @@ base: components: sinks: file: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -191,18 +191,18 @@ base: components: sinks: file: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/gcp_chronicle_unstructured.cue b/website/cue/reference/components/sinks/base/gcp_chronicle_unstructured.cue index d34ce7b9d3187..f25743635bb8b 100644 --- a/website/cue/reference/components/sinks/base/gcp_chronicle_unstructured.cue +++ b/website/cue/reference/components/sinks/base/gcp_chronicle_unstructured.cue @@ -211,7 +211,7 @@ base: components: sinks: gcp_chronicle_unstructured: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -240,18 +240,18 @@ base: components: sinks: gcp_chronicle_unstructured: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/gcp_cloud_storage.cue b/website/cue/reference/components/sinks/base/gcp_cloud_storage.cue index dc3e43c5aeb8e..8d09718f0cc85 100644 --- a/website/cue/reference/components/sinks/base/gcp_cloud_storage.cue +++ b/website/cue/reference/components/sinks/base/gcp_cloud_storage.cue @@ -295,7 +295,7 @@ base: components: sinks: gcp_cloud_storage: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -324,18 +324,18 @@ base: components: sinks: gcp_cloud_storage: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/gcp_pubsub.cue b/website/cue/reference/components/sinks/base/gcp_pubsub.cue index eae172d862485..97b42d2311c0e 100644 --- a/website/cue/reference/components/sinks/base/gcp_pubsub.cue +++ b/website/cue/reference/components/sinks/base/gcp_pubsub.cue @@ -209,7 +209,7 @@ base: components: sinks: gcp_pubsub: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -238,18 +238,18 @@ base: components: sinks: gcp_pubsub: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/http.cue b/website/cue/reference/components/sinks/base/http.cue index 1b2d54839ac06..7efa9e3beacda 100644 --- a/website/cue/reference/components/sinks/base/http.cue +++ b/website/cue/reference/components/sinks/base/http.cue @@ -250,7 +250,7 @@ base: components: sinks: http: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -279,18 +279,18 @@ base: components: sinks: http: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/humio_logs.cue b/website/cue/reference/components/sinks/base/humio_logs.cue index fd60d17745e7b..e5c6cbc397957 100644 --- a/website/cue/reference/components/sinks/base/humio_logs.cue +++ b/website/cue/reference/components/sinks/base/humio_logs.cue @@ -203,7 +203,7 @@ base: components: sinks: humio_logs: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -232,18 +232,18 @@ base: components: sinks: humio_logs: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/kafka.cue b/website/cue/reference/components/sinks/base/kafka.cue index 40486db2f2824..630a2a7a5cd2c 100644 --- a/website/cue/reference/components/sinks/base/kafka.cue +++ b/website/cue/reference/components/sinks/base/kafka.cue @@ -197,7 +197,7 @@ base: components: sinks: kafka: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -226,18 +226,18 @@ base: components: sinks: kafka: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/loki.cue b/website/cue/reference/components/sinks/base/loki.cue index bf3aad7a2c162..1f4ecab16673f 100644 --- a/website/cue/reference/components/sinks/base/loki.cue +++ b/website/cue/reference/components/sinks/base/loki.cue @@ -254,7 +254,7 @@ base: components: sinks: loki: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -283,18 +283,18 @@ base: components: sinks: loki: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/nats.cue b/website/cue/reference/components/sinks/base/nats.cue index b6895c9990873..5eca633b7fab0 100644 --- a/website/cue/reference/components/sinks/base/nats.cue +++ b/website/cue/reference/components/sinks/base/nats.cue @@ -242,7 +242,7 @@ base: components: sinks: nats: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -271,18 +271,18 @@ base: components: sinks: nats: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/papertrail.cue b/website/cue/reference/components/sinks/base/papertrail.cue index 746ce8cf7d5a7..99a2794e5cfee 100644 --- a/website/cue/reference/components/sinks/base/papertrail.cue +++ b/website/cue/reference/components/sinks/base/papertrail.cue @@ -142,7 +142,7 @@ base: components: sinks: papertrail: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -171,18 +171,18 @@ base: components: sinks: papertrail: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/pulsar.cue b/website/cue/reference/components/sinks/base/pulsar.cue index c528b90805739..ddfd315be19a5 100644 --- a/website/cue/reference/components/sinks/base/pulsar.cue +++ b/website/cue/reference/components/sinks/base/pulsar.cue @@ -236,7 +236,7 @@ base: components: sinks: pulsar: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -265,18 +265,18 @@ base: components: sinks: pulsar: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/redis.cue b/website/cue/reference/components/sinks/base/redis.cue index eeb31cacf99b4..345e99ec9dcee 100644 --- a/website/cue/reference/components/sinks/base/redis.cue +++ b/website/cue/reference/components/sinks/base/redis.cue @@ -195,7 +195,7 @@ base: components: sinks: redis: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -224,18 +224,18 @@ base: components: sinks: redis: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/socket.cue b/website/cue/reference/components/sinks/base/socket.cue index bb0da606ac175..6d08b5a959d80 100644 --- a/website/cue/reference/components/sinks/base/socket.cue +++ b/website/cue/reference/components/sinks/base/socket.cue @@ -154,7 +154,7 @@ base: components: sinks: socket: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -183,18 +183,18 @@ base: components: sinks: socket: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/splunk_hec_logs.cue b/website/cue/reference/components/sinks/base/splunk_hec_logs.cue index 1310e15065c15..adba632fc5a30 100644 --- a/website/cue/reference/components/sinks/base/splunk_hec_logs.cue +++ b/website/cue/reference/components/sinks/base/splunk_hec_logs.cue @@ -253,7 +253,7 @@ base: components: sinks: splunk_hec_logs: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -282,18 +282,18 @@ base: components: sinks: splunk_hec_logs: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/webhdfs.cue b/website/cue/reference/components/sinks/base/webhdfs.cue index caec116384336..9c13ce1bb894f 100644 --- a/website/cue/reference/components/sinks/base/webhdfs.cue +++ b/website/cue/reference/components/sinks/base/webhdfs.cue @@ -203,7 +203,7 @@ base: components: sinks: webhdfs: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -232,18 +232,18 @@ base: components: sinks: webhdfs: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sinks/base/websocket.cue b/website/cue/reference/components/sinks/base/websocket.cue index 8b3770715ceff..3e1f2b6277baf 100644 --- a/website/cue/reference/components/sinks/base/websocket.cue +++ b/website/cue/reference/components/sinks/base/websocket.cue @@ -189,7 +189,7 @@ base: components: sinks: websocket: configuration: { In some variants of CSV, quotes are escaped using a special escape character like \\ (instead of escaping quotes by doubling them). - To use this `double_quotes` needs to be disabled as well otherwise it is ignored + To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false type: uint: default: 34 @@ -218,18 +218,18 @@ base: components: sinks: websocket: configuration: { type: string: { default: "necessary" enum: { - always: "This puts quotes around every field. Always." + always: "Always puts quotes around every field." necessary: """ - This puts quotes around fields only when necessary. - They are necessary when fields contain a quote, delimiter or record terminator. + Puts quotes around fields only when necessary. + They are necessary when fields contain a quote, delimiter, or record terminator. Quotes are also necessary when writing an empty record (which is indistinguishable from a record with one empty field). """ - never: "This never writes quotes, even if it would produce invalid CSV data." + never: "Never writes quotes, even if it produces invalid CSV data." non_numeric: """ - This puts quotes around all fields that are non-numeric. + Puts quotes around all fields that are non-numeric. Namely, when writing a field that does not parse as a valid float or integer, - then quotes will be used even if they aren’t strictly necessary. + then quotes are used even if they aren't strictly necessary. """ } } diff --git a/website/cue/reference/components/sources/base/amqp.cue b/website/cue/reference/components/sources/base/amqp.cue index 8100c736a7c46..3bb2fcca6451f 100644 --- a/website/cue/reference/components/sources/base/amqp.cue +++ b/website/cue/reference/components/sources/base/amqp.cue @@ -68,7 +68,7 @@ base: components: sources: amqp: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -76,7 +76,7 @@ base: components: sources: amqp: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**. diff --git a/website/cue/reference/components/sources/base/aws_kinesis_firehose.cue b/website/cue/reference/components/sources/base/aws_kinesis_firehose.cue index eb7af974c2350..ba1cf3d4bd642 100644 --- a/website/cue/reference/components/sources/base/aws_kinesis_firehose.cue +++ b/website/cue/reference/components/sources/base/aws_kinesis_firehose.cue @@ -71,7 +71,7 @@ base: components: sources: aws_kinesis_firehose: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -79,7 +79,7 @@ base: components: sources: aws_kinesis_firehose: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**. diff --git a/website/cue/reference/components/sources/base/aws_s3.cue b/website/cue/reference/components/sources/base/aws_s3.cue index ee9e3adcee02f..ebe01f1b5e592 100644 --- a/website/cue/reference/components/sources/base/aws_s3.cue +++ b/website/cue/reference/components/sources/base/aws_s3.cue @@ -166,7 +166,7 @@ base: components: sources: aws_s3: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -174,7 +174,7 @@ base: components: sources: aws_s3: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**. diff --git a/website/cue/reference/components/sources/base/aws_sqs.cue b/website/cue/reference/components/sources/base/aws_sqs.cue index aae7840898789..dc52cfa2ebb2d 100644 --- a/website/cue/reference/components/sources/base/aws_sqs.cue +++ b/website/cue/reference/components/sources/base/aws_sqs.cue @@ -161,7 +161,7 @@ base: components: sources: aws_sqs: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -169,7 +169,7 @@ base: components: sources: aws_sqs: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**. diff --git a/website/cue/reference/components/sources/base/datadog_agent.cue b/website/cue/reference/components/sources/base/datadog_agent.cue index eafd6916cc374..a0dde3557be12 100644 --- a/website/cue/reference/components/sources/base/datadog_agent.cue +++ b/website/cue/reference/components/sources/base/datadog_agent.cue @@ -53,7 +53,7 @@ base: components: sources: datadog_agent: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -61,7 +61,7 @@ base: components: sources: datadog_agent: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**. diff --git a/website/cue/reference/components/sources/base/demo_logs.cue b/website/cue/reference/components/sources/base/demo_logs.cue index e57db31371b89..cb5310c080d01 100644 --- a/website/cue/reference/components/sources/base/demo_logs.cue +++ b/website/cue/reference/components/sources/base/demo_logs.cue @@ -32,7 +32,7 @@ base: components: sources: demo_logs: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -40,7 +40,7 @@ base: components: sources: demo_logs: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**. diff --git a/website/cue/reference/components/sources/base/exec.cue b/website/cue/reference/components/sources/base/exec.cue index a68980e48d992..89398ac37c3cf 100644 --- a/website/cue/reference/components/sources/base/exec.cue +++ b/website/cue/reference/components/sources/base/exec.cue @@ -33,7 +33,7 @@ base: components: sources: exec: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -41,7 +41,7 @@ base: components: sources: exec: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**. diff --git a/website/cue/reference/components/sources/base/file.cue b/website/cue/reference/components/sources/base/file.cue index bee8ec0fbd7e0..521b93fcb1d8b 100644 --- a/website/cue/reference/components/sources/base/file.cue +++ b/website/cue/reference/components/sources/base/file.cue @@ -230,7 +230,7 @@ base: components: sources: file: configuration: { max_read_bytes: { description: """ Max amount of bytes to read from a single file before switching over to the next file. - **Note:** This does not apply when `oldest_first` is `true. + **Note:** This does not apply when `oldest_first` is `true`. This allows distributing the reads more or less evenly across the files. @@ -325,7 +325,7 @@ base: components: sources: file: configuration: { ] } oldest_first: { - description: "Instead of balancing read capacity fairly across all watched files, prioritize draining the oldest files before moving on to read data from younger files." + description: "Instead of balancing read capacity fairly across all watched files, prioritize draining the oldest files before moving on to read data from more recent files." required: false type: bool: default: false } diff --git a/website/cue/reference/components/sources/base/file_descriptor.cue b/website/cue/reference/components/sources/base/file_descriptor.cue index 7a98e6e531d46..f5329a3b6621c 100644 --- a/website/cue/reference/components/sources/base/file_descriptor.cue +++ b/website/cue/reference/components/sources/base/file_descriptor.cue @@ -23,7 +23,7 @@ base: components: sources: file_descriptor: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -31,7 +31,7 @@ base: components: sources: file_descriptor: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**. diff --git a/website/cue/reference/components/sources/base/gcp_pubsub.cue b/website/cue/reference/components/sources/base/gcp_pubsub.cue index b1a87f22af305..0b1914852cef4 100644 --- a/website/cue/reference/components/sources/base/gcp_pubsub.cue +++ b/website/cue/reference/components/sources/base/gcp_pubsub.cue @@ -99,7 +99,7 @@ base: components: sources: gcp_pubsub: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -107,7 +107,7 @@ base: components: sources: gcp_pubsub: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**. diff --git a/website/cue/reference/components/sources/base/heroku_logs.cue b/website/cue/reference/components/sources/base/heroku_logs.cue index b08134e07dee5..896e817d64fea 100644 --- a/website/cue/reference/components/sources/base/heroku_logs.cue +++ b/website/cue/reference/components/sources/base/heroku_logs.cue @@ -65,7 +65,7 @@ base: components: sources: heroku_logs: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -73,7 +73,7 @@ base: components: sources: heroku_logs: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**. diff --git a/website/cue/reference/components/sources/base/http.cue b/website/cue/reference/components/sources/base/http.cue index d47eca98423a7..7a8186916e9fd 100644 --- a/website/cue/reference/components/sources/base/http.cue +++ b/website/cue/reference/components/sources/base/http.cue @@ -67,7 +67,7 @@ base: components: sources: http: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -75,7 +75,7 @@ base: components: sources: http: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**. diff --git a/website/cue/reference/components/sources/base/http_client.cue b/website/cue/reference/components/sources/base/http_client.cue index eb2df43a013d4..82f0ea4b7a5ce 100644 --- a/website/cue/reference/components/sources/base/http_client.cue +++ b/website/cue/reference/components/sources/base/http_client.cue @@ -65,7 +65,7 @@ base: components: sources: http_client: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -73,7 +73,7 @@ base: components: sources: http_client: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**. diff --git a/website/cue/reference/components/sources/base/http_server.cue b/website/cue/reference/components/sources/base/http_server.cue index 5d2e305b0dd08..1d8c26fc5afbc 100644 --- a/website/cue/reference/components/sources/base/http_server.cue +++ b/website/cue/reference/components/sources/base/http_server.cue @@ -67,7 +67,7 @@ base: components: sources: http_server: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -75,7 +75,7 @@ base: components: sources: http_server: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**. diff --git a/website/cue/reference/components/sources/base/kafka.cue b/website/cue/reference/components/sources/base/kafka.cue index 3834952d75297..35e538f2764a8 100644 --- a/website/cue/reference/components/sources/base/kafka.cue +++ b/website/cue/reference/components/sources/base/kafka.cue @@ -77,7 +77,7 @@ base: components: sources: kafka: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -85,7 +85,7 @@ base: components: sources: kafka: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**. diff --git a/website/cue/reference/components/sources/base/kubernetes_logs.cue b/website/cue/reference/components/sources/base/kubernetes_logs.cue index 4d0d37c15496f..f240b4f3ff8a9 100644 --- a/website/cue/reference/components/sources/base/kubernetes_logs.cue +++ b/website/cue/reference/components/sources/base/kubernetes_logs.cue @@ -166,7 +166,7 @@ base: components: sources: kubernetes_logs: configuration: { max_read_bytes: { description: """ Max amount of bytes to read from a single file before switching over to the next file. - **Note:** This does not apply when `oldest_first` is `true. + **Note:** This does not apply when `oldest_first` is `true`. This allows distributing the reads more or less evenly across the files. @@ -210,7 +210,7 @@ base: components: sources: kubernetes_logs: configuration: { } } oldest_first: { - description: "Instead of balancing read capacity fairly across all watched files, prioritize draining the oldest files before moving on to read data from younger files." + description: "Instead of balancing read capacity fairly across all watched files, prioritize draining the oldest files before moving on to read data from more recent files." required: false type: bool: default: true } diff --git a/website/cue/reference/components/sources/base/nats.cue b/website/cue/reference/components/sources/base/nats.cue index 90c5395bee521..81bc4bdca5b86 100644 --- a/website/cue/reference/components/sources/base/nats.cue +++ b/website/cue/reference/components/sources/base/nats.cue @@ -120,7 +120,7 @@ base: components: sources: nats: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -128,7 +128,7 @@ base: components: sources: nats: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**. diff --git a/website/cue/reference/components/sources/base/redis.cue b/website/cue/reference/components/sources/base/redis.cue index f43534be91d58..34bd7a4c7139a 100644 --- a/website/cue/reference/components/sources/base/redis.cue +++ b/website/cue/reference/components/sources/base/redis.cue @@ -38,7 +38,7 @@ base: components: sources: redis: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -46,7 +46,7 @@ base: components: sources: redis: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**. diff --git a/website/cue/reference/components/sources/base/socket.cue b/website/cue/reference/components/sources/base/socket.cue index 331327f19253e..13312f97f7efa 100644 --- a/website/cue/reference/components/sources/base/socket.cue +++ b/website/cue/reference/components/sources/base/socket.cue @@ -40,7 +40,7 @@ base: components: sources: socket: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -48,7 +48,7 @@ base: components: sources: socket: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**. diff --git a/website/cue/reference/components/sources/base/stdin.cue b/website/cue/reference/components/sources/base/stdin.cue index 84d030db05a6f..9835cc3b3e892 100644 --- a/website/cue/reference/components/sources/base/stdin.cue +++ b/website/cue/reference/components/sources/base/stdin.cue @@ -23,7 +23,7 @@ base: components: sources: stdin: configuration: { [json]: https://www.json.org/ """ native: """ - Decodes the raw bytes as Vector’s [native Protocol Buffers format][vector_native_protobuf]. + Decodes the raw bytes as [native Protocol Buffers format][vector_native_protobuf]. This codec is **[experimental][experimental]**. @@ -31,7 +31,7 @@ base: components: sources: stdin: configuration: { [experimental]: https://vector.dev/highlights/2022-03-31-native-event-codecs """ native_json: """ - Decodes the raw bytes as Vector’s [native JSON format][vector_native_json]. + Decodes the raw bytes as [native JSON format][vector_native_json]. This codec is **[experimental][experimental]**.