Skip to content

chore: Codify flag naming including sentinel values #17569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jszwedko merged 1 commit into from
Jun 2, 2023
Merged

chore: Codify flag naming including sentinel values #17569

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/specs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@ interpreted as described in [RFC 2119].
- [Introduction](#introduction)
- [Scope](#scope)
- [Terminology](#terminology)
- [Flag](#flag)
- [Entity](#entity)
- [Option](#option)
- [Schema](#schema)
- [Naming](#naming)
- [Flag naming](#flag-naming)
- [Entity naming](#entity-naming)
- [Option naming](#option-naming)
- [Types](#types)
Expand All @@ -37,6 +39,10 @@ relevant specifications, such as the [component specification].

## Terminology

### Flag

"Flag" refers to a CLI flag provided when running Vector.

### Entity

"Entity" refers to a Vector concept used to model Vector's processing graph.
Expand All @@ -53,6 +59,16 @@ under entities and also used to define global Vector behavior.

### Naming

#### Flag naming

- MUST only contain ASCII alphanumeric, lowercase, and hyphens
- MUST be in kebab-case format when multiple words are used (e.g., `config-dir`)
- For flags that take a value, but are also able to be "disabled", they SHOULD NOT use a sentinel
value. Instead they SHOULD have a second flag added prefixed with `no-` and SHOULD leave off any
unit suffixes. For example, to disable `--graceful-shutdown-limit-secs`,
a `--no-graceful-shutdown` flag was added. Vector MUST NOT allow both the flag and its negative to
be specified at the same time.

#### Entity naming

- MUST only contain ASCII alphanumeric, lowercase, and underscores
Expand Down