Skip to content

Commit

Permalink
chore(docs): Clarify bytes framing for streams (vectordotdev#17745)
Browse files Browse the repository at this point in the history
I'm not aware of any sources that separate "steam segments" so I updated
the language a bit to
account for how the `tcp` mode of the `socket` source handles `bytes`
framing.

Reference: vectordotdev#17136

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>
  • Loading branch information
jszwedko committed Jun 23, 2023
1 parent 7a0dec1 commit 7d10fc9
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion website/cue/reference/components/sources.cue
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ components: sources: [Name=string]: {
type: string: {
default: features.codecs.default_framing
enum: {
bytes: "Byte frames are passed through as-is according to the underlying I/O boundaries (e.g. split between messages or stream segments)."
bytes: "Byte frames are passed through as-is according to the underlying I/O boundaries (e.g. split between messages, payloads, or streams)."
character_delimited: "Byte frames which are delimited by a chosen character."
length_delimited: "Byte frames which are prefixed by an unsigned big-endian 32-bit integer indicating the length."
newline_delimited: "Byte frames which are delimited by a newline character."
Expand Down

0 comments on commit 7d10fc9

Please sign in to comment.