Module encoding

Module encoding 

Source
Expand description

A collection of support structures that are used in the process of encoding events into bytes.

Re-exports§

pub use chunking::Chunker;
pub use chunking::Chunking;
pub use chunking::GelfChunker;
pub use format::ArrowEncodingError;
pub use format::ArrowStreamSerializer;
pub use format::ArrowStreamSerializerConfig;
pub use format::SchemaProvider;
pub use format::AvroSerializer;
pub use format::AvroSerializerConfig;
pub use format::AvroSerializerOptions;
pub use format::CefSerializer;
pub use format::CefSerializerConfig;
pub use format::CsvSerializer;
pub use format::CsvSerializerConfig;
pub use format::GelfSerializer;
pub use format::GelfSerializerConfig;
pub use format::JsonSerializer;
pub use format::JsonSerializerConfig;
pub use format::JsonSerializerOptions;
pub use format::LogfmtSerializer;
pub use format::LogfmtSerializerConfig;
pub use format::NativeJsonSerializer;
pub use format::NativeJsonSerializerConfig;
pub use format::NativeSerializer;
pub use format::NativeSerializerConfig;
pub use format::ProtobufSerializer;
pub use format::ProtobufSerializerConfig;
pub use format::ProtobufSerializerOptions;
pub use format::RawMessageSerializer;
pub use format::RawMessageSerializerConfig;
pub use format::TextSerializer;
pub use format::TextSerializerConfig;
pub use format::OtlpSerializer;
pub use format::OtlpSerializerConfig;
pub use format::SyslogSerializer;
pub use format::SyslogSerializerConfig;
pub use framing::BoxedFramer;
pub use framing::BoxedFramingError;
pub use framing::BytesEncoder;
pub use framing::BytesEncoderConfig;
pub use framing::CharacterDelimitedEncoder;
pub use framing::CharacterDelimitedEncoderConfig;
pub use framing::CharacterDelimitedEncoderOptions;
pub use framing::Framer;
pub use framing::FramingConfig;
pub use framing::LengthDelimitedEncoder;
pub use framing::LengthDelimitedEncoderConfig;
pub use framing::NewlineDelimitedEncoder;
pub use framing::NewlineDelimitedEncoderConfig;
pub use framing::VarintLengthDelimitedEncoder;
pub use framing::VarintLengthDelimitedEncoderConfig;
pub use serializer::BatchSerializerConfig;
pub use serializer::Serializer;
pub use serializer::SerializerConfig;

Modules§

chunking
Optional extension for encoding formats to support chunking, used when the sink transport (e.g., UDP) has a payload size limit.
format
A collection of formats that can be used to convert from structured events to byte frames.
framing
A collection of framing methods that can be used to convert from byte chunks to byte frames with defined boundaries.
serializer
Serializer configuration and implementation for encoding structured events as bytes.

Structs§

BatchEncoder
An encoder that encodes batches of events.
Encoder
An encoder that can encode structured events into byte frames.
EncodingConfig
Encoding configuration. Configures how events are encoded into raw bytes. The selected encoding also determines which input types (logs, metrics, traces) are supported.
EncodingConfigWithFraming
Encoding configuration.
Transformer
Transformations to prepare an event for serialization.

Enums§

BatchSerializer
Serializers that support batch encoding (encoding all events at once).
EncoderKind
An wrapper that supports both framed and batch encoding modes.
Error
An error that occurred while encoding structured events.
SinkType
The way a sink processes outgoing events.
TimestampFormat
The format in which a timestamp should be represented.

Type Aliases§

BuildError
An error that occurred while building an encoder.