Struct vector::sources::dnstap::DnstapConfig

pub struct DnstapConfig {
    pub mode: Mode,
    pub max_frame_length: usize,
    pub host_key: Option<OptionalValuePath>,
    pub raw_data_only: Option<bool>,
    pub multithreaded: Option<bool>,
    pub max_frame_handling_tasks: Option<u32>,
    pub lowercase_hostnames: bool,
    pub log_namespace: Option<bool>,
}

Configuration for the dnstap source.

Fields

mode: Mode

max_frame_length: usize

Maximum DNSTAP frame length that the source accepts.

If any frame is longer than this, it is discarded.

host_key: Option<OptionalValuePath>

Overrides the name of the log field used to add the source path to each event.

The value is the socket path itself.

By default, the global log_schema.host_key option is used.

raw_data_only: Option<bool>

Whether or not to skip parsing or decoding of DNSTAP frames.

If set to true, frames are not parsed or decoded. The raw frame data is set as a field on the event (called rawData) and encoded as a base64 string.

multithreaded: Option<bool>

Whether or not to concurrently process DNSTAP frames.

max_frame_handling_tasks: Option<u32>

Maximum number of frames that can be processed concurrently.

lowercase_hostnames: bool

Whether to downcase all DNSTAP hostnames received for consistency

log_namespace: Option<bool>

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

Implementations

impl DnstapConfig

pub fn new(socket_path: PathBuf) -> Self

pub fn schema_definition(&self, log_namespace: LogNamespace) -> Definition

Trait Implementations

impl Clone for DnstapConfig

fn clone(&self) -> DnstapConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for DnstapConfig

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 DnstapConfig

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

Formats the value using the given formatter.

impl Default for DnstapConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DnstapConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for DnstapConfig

fn generate_config() -> Value

impl NamedComponent for DnstapConfig

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

Gets the name of the component.

impl Serialize for DnstapConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SourceConfig for DnstapConfig

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

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

Builds the source with the given context.

fn outputs(&self, global_log_namespace: LogNamespace) -> Vec<SourceOutput>

Gets the list of outputs exposed by this source.

fn can_acknowledge(&self) -> bool

Whether or not this source can acknowledge the events it emits.

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

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

impl ToValue for DnstapConfig

fn to_value(&self) -> Value

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