Enum vector::cli::SubCommand

pub enum SubCommand {
    Validate(Opts),
    ConvertConfig(Opts),
    Generate(Opts),
    GenerateSchema,
    Config(Opts),
    List(Opts),
    Test(Opts),
    Graph(Opts),
    Top(Opts),
    Tap(Opts),
    Vrl(Opts),
}

Variants

Validate(Opts)

Validate the target config, then exit.

ConvertConfig(Opts)

Convert a config file from one format to another. This command can also walk directories recursively and convert all config files that are discovered. Note that this is a best effort conversion due to the following reasons:

• The comments from the original config file are not preserved.
• Explicitly set default values in the original implementation might be omitted.
• Depending on how each source/sink config struct configures serde, there might be entries with null values.

Generate(Opts)

Generate a Vector configuration containing a list of components.

GenerateSchema

Generate the configuration schema for this version of Vector. (experimental)

A JSON Schema document will be written to stdout that represents the valid schema for a Vector configuration. This schema is based on the “full” configuration, such that for usages where a configuration is split into multiple files, the schema would apply to those files only when concatenated together.

Config(Opts)

Output a provided Vector configuration file/dir as a single JSON object, useful for checking in to version control.

List(Opts)

List available components, then exit.

Test(Opts)

Run Vector config unit tests, then exit. This command is experimental and therefore subject to change. For guidance on how to write unit tests check out https://vector.dev/guides/level-up/unit-testing/.

Graph(Opts)

Output the topology as visual representation using the DOT language which can be rendered by GraphViz

Top(Opts)

Display topology and metrics in the console, for a local or remote Vector instance

Tap(Opts)

Observe output log events from source or transform components. Logs are sampled at a specified interval.

Vrl(Opts)

Vector Remap Language CLI

Implementations

impl SubCommand

pub async fn execute(&self, signals: SignalPair, color: bool) -> ExitCode

Trait Implementations

impl CommandFactory for SubCommand

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 SubCommand

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

Formats the value using the given formatter.

impl FromArgMatches for SubCommand

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<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for SubCommand

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.

impl Subcommand for SubCommand

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

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

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

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

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand