Struct vector::transforms::metric_to_log::MetricToLogConfig

pub struct MetricToLogConfig {
    pub host_tag: Option<String>,
    pub timezone: Option<TimeZone>,
    pub log_namespace: Option<bool>,
    pub metric_tag_values: MetricTagValues,
}

Configuration for the metric_to_log transform.

Fields

host_tag: Option<String>

Name of the tag in the metric to use for the source host.

If present, the value of the tag is set on the generated log event in the host field, where the field key uses the global host_key option.

timezone: Option<TimeZone>

The name of the time zone to apply to timestamp conversions that do not contain an explicit time zone.

This overrides the global timezone option. The time zone name may be any name in the TZ database or local to indicate system local time.

log_namespace: Option<bool>

The namespace to use for logs. This overrides the global setting.

metric_tag_values: MetricTagValues

Controls how metric tag values are encoded.

When set to single, only the last non-bare value of tags are displayed with the metric. When set to full, all metric tags are exposed as separate assignments as described by the native_json codec.

Implementations

impl MetricToLogConfig

pub fn build_transform(&self, context: &TransformContext) -> MetricToLog

Trait Implementations

impl Clone for MetricToLogConfig

fn clone(&self) -> MetricToLogConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for MetricToLogConfig

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 MetricToLogConfig

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

Formats the value using the given formatter.

impl Default for MetricToLogConfig

fn default() -> MetricToLogConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MetricToLogConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for MetricToLogConfig

fn generate_config() -> Value

impl NamedComponent for MetricToLogConfig

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

Gets the name of the component.

impl Serialize for MetricToLogConfig

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 MetricToLogConfig

fn to_value(&self) -> Value

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

impl TransformConfig for MetricToLogConfig

fn build<'life0, 'life1, 'async_trait>( &'life0 self, context: &'life1 TransformContext, ) -> Pin<Box<dyn Future<Output = Result<Transform>> + Send + 'async_trait>>

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

Builds the transform with the given context.

fn input(&self) -> Input

Gets the input configuration for this transform.

fn outputs( &self, _: TableRegistry, input_definitions: &[(OutputId, Definition)], global_log_namespace: LogNamespace, ) -> Vec<TransformOutput>

Gets the list of outputs exposed by this transform.

fn enable_concurrency(&self) -> bool

Whether or not concurrency should be enabled for this transform.

fn validate(&self, _merged_definition: &Definition) -> Result<(), Vec<String>>

Validates that the configuration of the transform is valid.

fn nestable(&self, _parents: &HashSet<&'static str>) -> bool

Whether or not this transform can be nested, given the types of transforms it would be nested within.