Struct codecs::decoding::framing::ChunkedGelfDecoderOptions

pub struct ChunkedGelfDecoderOptions {
    pub timeout_secs: f64,
    pub pending_messages_limit: Option<usize>,
    pub max_length: Option<usize>,
    pub decompression: ChunkedGelfDecompressionConfig,
}

Options for building a ChunkedGelfDecoder.

Fields

timeout_secs: f64

The timeout, in seconds, for a message to be fully received. If the timeout is reached, the decoder drops all the received chunks of the timed out message.

pending_messages_limit: Option<usize>

The maximum number of pending incomplete messages. If this limit is reached, the decoder starts dropping chunks of new messages, ensuring the memory usage of the decoder’s state is bounded. If this option is not set, the decoder does not limit the number of pending messages and the memory usage of its messages buffer can grow unbounded. This matches Graylog Server’s behavior.

max_length: Option<usize>

The maximum length of a single GELF message, in bytes. Messages longer than this length will be dropped. If this option is not set, the decoder does not limit the length of messages and the per-message memory is unbounded.

Note that a message can be composed of multiple chunks and this limit is applied to the whole message, not to individual chunks.

This limit takes only into account the message’s payload and the GELF header bytes are excluded from the calculation. The message’s payload is the concatenation of all the chunks’ payloads.

decompression: ChunkedGelfDecompressionConfig

Decompression configuration for GELF messages.

Trait Implementations

impl Clone for ChunkedGelfDecoderOptions

fn clone(&self) -> ChunkedGelfDecoderOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for ChunkedGelfDecoderOptions

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 ChunkedGelfDecoderOptions

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

Formats the value using the given formatter.

impl Default for ChunkedGelfDecoderOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChunkedGelfDecoderOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ChunkedGelfDecoderOptions

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 ChunkedGelfDecoderOptions

fn to_value(&self) -> Value

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