Struct vector::sinks::loki::LokiConfig

pub struct LokiConfig {

    pub endpoint: UriSerde,
    pub path: String,
    pub encoding: EncodingConfig,
    pub tenant_id: Option<Template>,
    pub labels: HashMap<Template, Template>,
    pub remove_label_fields: bool,
    pub structured_metadata: HashMap<Template, Template>,
    pub remove_structured_metadata_fields: bool,
    pub remove_timestamp: bool,
    pub compression: Compression,
    pub out_of_order_action: OutOfOrderAction,
    pub auth: Option<Auth>,
    pub request: TowerRequestConfig,
    pub batch: BatchConfig<LokiDefaultBatchSettings>,
    pub tls: Option<TlsConfig>,
    /* private fields */
}

Configuration for the loki sink.

Fields

endpoint: UriSerde

The base URL of the Loki instance.

The path value is appended to this.

path: String

The path to use in the URL of the Loki instance.

encoding: EncodingConfig

tenant_id: Option<Template>

The tenant ID to specify in requests to Loki.

When running Loki locally, a tenant ID is not required.

labels: HashMap<Template, Template>

A set of labels that are attached to each batch of events.

Both keys and values are templateable, which enables you to attach dynamic labels to events.

Valid label keys include *, and prefixes ending with *, to allow for the expansion of objects into multiple labels. See Label expansion for more information.

Note: If the set of labels has high cardinality, this can cause drastic performance issues with Loki. To prevent this from happening, reduce the number of unique label keys and values.

remove_label_fields: bool

Whether or not to delete fields from the event when they are used as labels.

structured_metadata: HashMap<Template, Template>

Structured metadata that is attached to each batch of events.

Both keys and values are templateable, which enables you to attach dynamic structured metadata to events.

Valid metadata keys include *, and prefixes ending with *, to allow for the expansion of objects into multiple metadata entries. This follows the same logic as Label expansion.

remove_structured_metadata_fields: bool

Whether or not to delete fields from the event when they are used in structured metadata.

remove_timestamp: bool

Whether or not to remove the timestamp from the event payload.

The timestamp is still sent as event metadata for Loki to use for indexing.

compression: Compression

Compression configuration. Snappy compression implies sending push requests as Protocol Buffers.

out_of_order_action: OutOfOrderAction

auth: Option<Auth>

request: TowerRequestConfig

batch: BatchConfig<LokiDefaultBatchSettings>

tls: Option<TlsConfig>

Trait Implementations

impl Clone for LokiConfig

fn clone(&self) -> LokiConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for LokiConfig

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 LokiConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LokiConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for LokiConfig

fn generate_config() -> Value

impl NamedComponent for LokiConfig

fn get_component_name(&self) -> &'static str

Gets the name of the component.

impl Serialize for LokiConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SinkConfig for LokiConfig

fn build<'life0, 'async_trait>( &'life0 self, cx: SinkContext, ) -> Pin<Box<dyn Future<Output = Result<(VectorSink, Healthcheck)>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Builds the sink with the given context.

fn input(&self) -> Input

Gets the input configuration for this sink.

fn acknowledgements(&self) -> &AcknowledgementsConfig

Gets the acknowledgements configuration for this sink.

fn resources(&self) -> Vec<Resource>

Gets the list of resources, if any, used by this sink.

impl ToValue for LokiConfig

fn to_value(&self) -> Value

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