Enum codecs::encoding::SerializerConfig

pub enum SerializerConfig {
    Avro {
        avro: AvroSerializerOptions,
    },
    Cef(CefSerializerConfig),
    Csv(CsvSerializerConfig),
    Gelf,
    Json(JsonSerializerConfig),
    Logfmt,
    Native,
    NativeJson,
    Protobuf(ProtobufSerializerConfig),
    RawMessage,
    Text(TextSerializerConfig),
}

Serializer configuration.

Variants

Avro

Encodes an event as an Apache Avro message.

Fields

avro: AvroSerializerOptions

Apache Avro-specific encoder options.

Cef(CefSerializerConfig)

Encodes an event as a CEF (Common Event Format) formatted message.

Tuple Fields

0: CefSerializerConfig

Options for the CEF encoder.

Csv(CsvSerializerConfig)

Encodes an event as a CSV message.

This codec must be configured with fields to encode.

Gelf

Encodes an event as a GELF message.

This codec is experimental for the following reason:

The GELF specification is more strict than the actual Graylog receiver. Vector’s encoder currently adheres more strictly to the GELF spec, with the exception that some characters such as @ are allowed in field names.

Other GELF codecs such as Loki’s, use a Go SDK that is maintained by Graylog, and is much more relaxed than the GELF spec.

Going forward, Vector will use that Go SDK as the reference implementation, which means the codec may continue to relax the enforcement of specification.

Json(JsonSerializerConfig)

Encodes an event as JSON.

Logfmt

Encodes an event as a logfmt message.

Native

Encodes an event in the native Protocol Buffers format.

This codec is experimental.

NativeJson

Encodes an event in the native JSON format.

This codec is experimental.

Protobuf(ProtobufSerializerConfig)

Encodes an event as a Protobuf message.

RawMessage

No encoding.

This encoding uses the message field of a log event.

Be careful if you are modifying your log events (for example, by using a remap transform) and removing the message field while doing additional parsing on it, as this could lead to the encoding emitting empty strings for the given event.

Text(TextSerializerConfig)

Plain text encoding.

This encoding uses the message field of a log event. For metrics, it uses an encoding that resembles the Prometheus export format.

Be careful if you are modifying your log events (for example, by using a remap transform) and removing the message field while doing additional parsing on it, as this could lead to the encoding emitting empty strings for the given event.

Implementations

impl SerializerConfig

pub fn build( &self, ) -> Result<Serializer, Box<dyn Error + Send + Sync + 'static>>

Build the Serializer from this configuration.

pub fn default_stream_framing(&self) -> FramingConfig

Return an appropriate default framer for the given serializer.

pub fn input_type(&self) -> DataType

The data type of events that are accepted by this Serializer.

pub fn schema_requirement(&self) -> Requirement

The schema required by the serializer.

Trait Implementations

impl Clone for SerializerConfig

fn clone(&self) -> SerializerConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Configurable for SerializerConfig

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for SerializerConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SerializerConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<AvroSerializerConfig> for SerializerConfig

fn from(config: AvroSerializerConfig) -> Self

Converts to this type from the input type.

impl From<CefSerializerConfig> for SerializerConfig

fn from(config: CefSerializerConfig) -> Self

Converts to this type from the input type.

impl From<CsvSerializerConfig> for SerializerConfig

fn from(config: CsvSerializerConfig) -> Self

Converts to this type from the input type.

impl From<GelfSerializerConfig> for SerializerConfig

fn from(_: GelfSerializerConfig) -> Self

Converts to this type from the input type.

impl From<JsonSerializerConfig> for SerializerConfig

fn from(config: JsonSerializerConfig) -> Self

Converts to this type from the input type.

impl From<LogfmtSerializerConfig> for SerializerConfig

fn from(_: LogfmtSerializerConfig) -> Self

Converts to this type from the input type.

impl From<NativeJsonSerializerConfig> for SerializerConfig

fn from(_: NativeJsonSerializerConfig) -> Self

Converts to this type from the input type.

impl From<NativeSerializerConfig> for SerializerConfig

fn from(_: NativeSerializerConfig) -> Self

Converts to this type from the input type.

impl From<ProtobufSerializerConfig> for SerializerConfig

fn from(config: ProtobufSerializerConfig) -> Self

Converts to this type from the input type.

impl From<RawMessageSerializerConfig> for SerializerConfig

fn from(_: RawMessageSerializerConfig) -> Self

Converts to this type from the input type.

impl From<TextSerializerConfig> for SerializerConfig

fn from(config: TextSerializerConfig) -> Self

Converts to this type from the input type.

impl Serialize for SerializerConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for SerializerConfig

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.