Skip to main content

EncoderConfig

Enum EncoderConfig 

Source
#[non_exhaustive]
pub enum EncoderConfig { PrometheusText { precision: Option<u8>, }, InfluxLineProtocol { field_key: Option<String>, precision: Option<u8>, }, JsonLines { precision: Option<u8>, }, Syslog { hostname: Option<String>, app_name: Option<String>, }, RemoteWriteDisabled {}, OtlpDisabled {}, }
Expand description

Configuration selecting which encoder to use for a scenario.

This enum is serde-deserializable from YAML scenario files. The type field selects the variant: prometheus_text, influx_lp, json_lines, syslog, remote_write, or otlp.

Feature-gated encoders (remote_write, otlp) have companion *Disabled variants that are compiled in when their feature is absent. These accept the YAML tag so that deserialization succeeds with a descriptive error from create_encoder instead of a generic “unknown variant” error from serde.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

PrometheusText

Prometheus text exposition format (version 0.0.4).

precision optionally limits the number of decimal places in metric values.

Fields

§precision: Option<u8>

Maximum decimal places for metric values. None preserves full f64 precision.

§

InfluxLineProtocol

InfluxDB line protocol.

field_key sets the field key used for the metric value. Defaults to "value". precision optionally limits the number of decimal places in metric values.

Fields

§field_key: Option<String>

The InfluxDB field key for the metric value. Defaults to "value" if absent.

§precision: Option<u8>

Maximum decimal places for metric values. None preserves full f64 precision.

§

JsonLines

JSON Lines (NDJSON) format.

Each event is serialized as one JSON object per line. Compatible with Elasticsearch, Loki, and generic HTTP ingest endpoints.

precision optionally rounds the metric value before JSON serialization.

Fields

§precision: Option<u8>

Maximum decimal places for metric values. None preserves full f64 precision.

§

Syslog

RFC 5424 syslog format.

Encodes log events as syslog lines. hostname and app_name default to "sonda".

Fields

§hostname: Option<String>

The HOSTNAME field in the syslog header. Defaults to "sonda".

§app_name: Option<String>

The APP-NAME field in the syslog header. Defaults to "sonda".

§

RemoteWriteDisabled

Placeholder variant when the remote-write feature is not compiled in.

Deserializes the remote_write YAML tag so that the error message can point the user at the missing feature flag instead of producing a generic “unknown variant” error from serde.

§

OtlpDisabled

Placeholder variant when the otlp feature is not compiled in.

Deserializes the otlp YAML tag so that the error message can point the user at the missing feature flag instead of producing a generic “unknown variant” error from serde.

Trait Implementations§

Source§

impl Clone for EncoderConfig

Source§

fn clone(&self) -> EncoderConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EncoderConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for EncoderConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for EncoderConfig

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,