Struct vector::sources::journald::JournaldConfig

pub struct JournaldConfig {
    pub since_now: bool,
    pub current_boot_only: bool,
    pub include_units: Vec<String>,
    pub exclude_units: Vec<String>,
    pub include_matches: HashMap<String, HashSet<String>>,
    pub exclude_matches: HashMap<String, HashSet<String>>,
    pub data_dir: Option<PathBuf>,
    pub extra_args: Vec<String>,
    pub batch_size: usize,
    pub journalctl_path: Option<PathBuf>,
    pub journal_directory: Option<PathBuf>,
    pub journal_namespace: Option<String>,
    /* private fields */
}

Configuration for the journald source.

Fields

since_now: bool

Only include entries that appended to the journal after the entries have been read.

current_boot_only: bool

Only include entries that occurred after the current boot of the system.

include_units: Vec<String>

A list of unit names to monitor.

If empty or not present, all units are accepted.

Unit names lacking a . have .service appended to make them a valid service unit name.

exclude_units: Vec<String>

A list of unit names to exclude from monitoring.

Unit names lacking a . have .service appended to make them a valid service unit name.

include_matches: HashMap<String, HashSet<String>>

A list of sets of field/value pairs to monitor.

If empty or not present, all journal fields are accepted.

If include_units is specified, it is merged into this list.

exclude_matches: HashMap<String, HashSet<String>>

A list of sets of field/value pairs that, if any are present in a journal entry, excludes the entry from this source.

If exclude_units is specified, it is merged into this list.

data_dir: Option<PathBuf>

The directory used to persist file checkpoint positions.

By default, the global data_dir option is used. Make sure the running user has write permissions to this directory.

If this directory is specified, then Vector will attempt to create it.

extra_args: Vec<String>

A list of extra command line arguments to pass to journalctl.

If specified, it is merged to the command line arguments as-is.

batch_size: usize

The systemd journal is read in batches, and a checkpoint is set at the end of each batch.

This option limits the size of the batch.

journalctl_path: Option<PathBuf>

The full path of the journalctl executable.

If not set, a search is done for the journalctl path.

journal_directory: Option<PathBuf>

The full path of the journal directory.

If not set, journalctl uses the default system journal path.

journal_namespace: Option<String>

The journal namespace.

This value is passed to journalctl through the --namespace option. If not set, journalctl uses the default namespace.

Trait Implementations

impl Clone for JournaldConfig

fn clone(&self) -> JournaldConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for JournaldConfig

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 JournaldConfig

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

Formats the value using the given formatter.

impl Default for JournaldConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JournaldConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for JournaldConfig

fn generate_config() -> Value

impl NamedComponent for JournaldConfig

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

Gets the name of the component.

impl Serialize for JournaldConfig

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 JournaldConfig

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 JournaldConfig

fn to_value(&self) -> Value

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