Struct vector::cli::RootOpts

pub struct RootOpts {

    pub config_paths: Vec<PathBuf>,
    pub config_dirs: Vec<PathBuf>,
    pub config_paths_toml: Vec<PathBuf>,
    pub config_paths_json: Vec<PathBuf>,
    pub config_paths_yaml: Vec<PathBuf>,
    pub require_healthy: Option<bool>,
    pub threads: Option<usize>,
    pub verbose: u8,
    pub quiet: u8,
    pub log_format: LogFormat,
    pub color: Color,
    pub watch_config: bool,
    pub watch_config_method: WatchConfigMethod,
    pub watch_config_poll_interval_seconds: NonZeroU64,
    pub internal_log_rate_limit: u64,
    pub graceful_shutdown_limit_secs: NonZeroU64,
    pub no_graceful_shutdown_limit: bool,
    pub allocation_tracing: bool,
    pub allocation_tracing_reporting_interval_ms: u64,
    pub openssl_no_probe: bool,
    pub allow_empty_config: bool,
}

Fields

config_paths: Vec<PathBuf>

Read configuration from one or more files. Wildcard paths are supported. File format is detected from the file name. If zero files are specified, the deprecated default config path /etc/vector/vector.yaml is targeted.

config_dirs: Vec<PathBuf>

Read configuration from files in one or more directories. File format is detected from the file name.

Files not ending in .toml, .json, .yaml, or .yml will be ignored.

config_paths_toml: Vec<PathBuf>

Read configuration from one or more files. Wildcard paths are supported. TOML file format is expected.

config_paths_json: Vec<PathBuf>

Read configuration from one or more files. Wildcard paths are supported. JSON file format is expected.

config_paths_yaml: Vec<PathBuf>

Read configuration from one or more files. Wildcard paths are supported. YAML file format is expected.

require_healthy: Option<bool>

Exit on startup if any sinks fail healthchecks

threads: Option<usize>

Number of threads to use for processing (default is number of available cores)

verbose: u8

Enable more detailed internal logging. Repeat to increase level. Overridden by --quiet.

quiet: u8

Reduce detail of internal logging. Repeat to reduce further. Overrides --verbose.

log_format: LogFormat

Set the logging format

color: Color

Control when ANSI terminal formatting is used.

By default vector will try and detect if stdout is a terminal, if it is ANSI will be enabled. Otherwise it will be disabled. By providing this flag with the --color always option will always enable ANSI terminal formatting. --color never will disable all ANSI terminal formatting. --color auto will attempt to detect it automatically.

watch_config: bool

Watch for changes in configuration file, and reload accordingly.

watch_config_method: WatchConfigMethod

Method for configuration watching.

By default, vector uses recommended watcher for host OS

• inotify for Linux-based systems.
• kqueue for unix/macos
• ReadDirectoryChangesWatcher for windows

The poll watcher can be used in cases where inotify doesn’t work, e.g., when attaching the configuration via NFS.

watch_config_poll_interval_seconds: NonZeroU64

Poll for changes in the configuration file at the given interval.

This setting is only applicable if Poll is set in --watch-config-method.

internal_log_rate_limit: u64

Set the internal log rate limit

graceful_shutdown_limit_secs: NonZeroU64

Set the duration in seconds to wait for graceful shutdown after SIGINT or SIGTERM are received. After the duration has passed, Vector will force shutdown. To never force shutdown, use --no-graceful-shutdown-limit.

no_graceful_shutdown_limit: bool

Never time out while waiting for graceful shutdown after SIGINT or SIGTERM received. This is useful when you would like for Vector to attempt to send data until terminated by a SIGKILL. Overrides/cannot be set with --graceful-shutdown-limit-secs.

allocation_tracing: bool

Set runtime allocation tracing

allocation_tracing_reporting_interval_ms: u64

Set allocation tracing reporting rate in milliseconds.

openssl_no_probe: bool

Disable probing and configuration of root certificate locations on the system for OpenSSL.

The probe functionality manipulates the SSL_CERT_FILE and SSL_CERT_DIR environment variables in the Vector process. This behavior can be problematic for users of the exec source, which by default inherits the environment of the Vector process.

allow_empty_config: bool

Allow the configuration to run without any components. This is useful for loading in an empty stub config that will later be replaced with actual components. Note that this is likely not useful without also watching for config file changes as described in --watch-config.

Implementations

impl RootOpts

pub fn config_paths_with_formats(&self) -> Vec<ConfigPath>

Return a list of config paths with the associated formats.

pub fn init_global(&self)

Trait Implementations

impl Args for RootOpts

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl CommandFactory for RootOpts

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for RootOpts

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

Formats the value using the given formatter.

impl FromArgMatches for RootOpts

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for RootOpts

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.