/usr/bin/vector

Usage: vector [OPTIONS] [COMMAND]

Commands:
  validate         Validate the target config, then exit
  convert-config   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         Generate a Vector configuration containing a list of components
  generate-schema  Generate the configuration schema for this version of Vector. (experimental)
  list             List available components, then exit
  test             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            Output the topology as visual representation using the DOT language which can be
                   rendered by GraphViz
  top              Display topology and metrics in the console, for a local or remote Vector
                   instance
  tap              Observe output log events from source or transform components. Logs are sampled
                   at a specified interval
  vrl              Vector Remap Language CLI
  help             Print this message or the help of the given subcommand(s)

Options:
  -c, --config <config>
          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

          [env: VECTOR_CONFIG=]

  -C, --config-dir <config-dir>
          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.

          [env: VECTOR_CONFIG_DIR=]

      --config-toml <config-toml>
          Read configuration from one or more files. Wildcard paths are supported. TOML file format
          is expected

          [env: VECTOR_CONFIG_TOML=]

      --config-json <config-json>
          Read configuration from one or more files. Wildcard paths are supported. JSON file format
          is expected

          [env: VECTOR_CONFIG_JSON=]

      --config-yaml <config-yaml>
          Read configuration from one or more files. Wildcard paths are supported. YAML file format
          is expected

          [env: VECTOR_CONFIG_YAML=]

  -r, --require-healthy <REQUIRE_HEALTHY>
          Exit on startup if any sinks fail healthchecks

          [env: VECTOR_REQUIRE_HEALTHY=]
          [possible values: true, false]

  -t, --threads <THREADS>
          Number of threads to use for processing (default is number of available cores)

          [env: VECTOR_THREADS=]

  -v, --verbose...
          Enable more detailed internal logging. Repeat to increase level. Overridden by `--quiet`

  -q, --quiet...
          Reduce detail of internal logging. Repeat to reduce further. Overrides `--verbose`

      --disable-env-var-interpolation
          Disable interpolation of environment variables in configuration files

          [env: VECTOR_DISABLE_ENV_VAR_INTERPOLATION=]

      --log-format <LOG_FORMAT>
          Set the logging format

          [env: VECTOR_LOG_FORMAT=]
          [default: text]
          [possible values: text, json]

      --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.

          [env: VECTOR_COLOR=]
          [default: auto]
          [possible values: auto, always, never]

  -w, --watch-config
          Watch for changes in configuration file, and reload accordingly

          [env: VECTOR_WATCH_CONFIG=]

      --watch-config-method <WATCH_CONFIG_METHOD>
          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.

          Possible values:
          - recommended: Recommended watcher for the current OS, usually `inotify` for Linux-based
            systems
          - poll:        Poll-based watcher, typically used for watching files on EFS/NFS-like
            network storage systems. The interval is determined by
            [`RootOpts::watch_config_poll_interval_seconds`]

          [env: VECTOR_WATCH_CONFIG_METHOD=]
          [default: recommended]

      --watch-config-poll-interval-seconds <WATCH_CONFIG_POLL_INTERVAL_SECONDS>
          Poll for changes in the configuration file at the given interval.

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

          [env: VECTOR_WATCH_CONFIG_POLL_INTERVAL_SECONDS=]
          [default: 30]

  -i, --internal-log-rate-limit <INTERNAL_LOG_RATE_LIMIT>
          Set the internal log rate limit in seconds.

          This controls the time window for rate limiting Vector's own internal logs. Within each
          time window, the first occurrence of a log is emitted, the second shows a suppression
          warning, and subsequent occurrences are silent until the window expires.

          Logs are grouped by their location in the code and the `component_id` field, so logs from
          different components are rate limited independently.

          Examples: - 1: Very verbose, logs can repeat every second - 10 (default): Logs can repeat
          every 10 seconds - 60: Less verbose, logs can repeat every minute

          [env: VECTOR_INTERNAL_LOG_RATE_LIMIT=]
          [default: 10]

      --graceful-shutdown-limit-secs <GRACEFUL_SHUTDOWN_LIMIT_SECS>
          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`

          [env: VECTOR_GRACEFUL_SHUTDOWN_LIMIT_SECS=]
          [default: 60]

      --no-graceful-shutdown-limit
          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`

          [env: VECTOR_NO_GRACEFUL_SHUTDOWN_LIMIT=]

      --allocation-tracing
          Set runtime allocation tracing

          [env: ALLOCATION_TRACING=]

      --allocation-tracing-reporting-interval-ms <ALLOCATION_TRACING_REPORTING_INTERVAL_MS>
          Set allocation tracing reporting rate in milliseconds

          [env: ALLOCATION_TRACING_REPORTING_INTERVAL_MS=]
          [default: 5000]

      --openssl-no-probe
          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.

          [env: VECTOR_OPENSSL_NO_PROBE=]

      --allow-empty-config
          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`

          [env: VECTOR_ALLOW_EMPTY_CONFIG=]

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version