Skip to content

chore: Codify the use of abbreviate time units in config option names #17582

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 the use of abbreviate time units in config option names #17582

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
3 changes: 2 additions & 1 deletion docs/specs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ under entities and also used to define global Vector behavior.
- MUST only contain ASCII alphanumeric, lowercase, and underscores
- MUST be in snake case format when multiple words are used (e.g., `timeout_seconds`)
- SHOULD use nouns, not verbs, as names (e.g., `fingerprint` instead of `fingerprinting`)
- MUST suffix options with their _full_ unit name (e.g., `_seconds`, `_bytes`, etc.)
- MUST suffix options with their _full_ unit name (e.g., `_megabytes` rather than `_mb`) or the
following abbreviations for time units: `_secs`, `_ms`, `_ns`.
- SHOULD consistent with units within the same scope. (e.g., don't mix seconds and milliseconds)
- MUST NOT repeat the name space in the option name (e.g., `fingerprint.bytes` instead of `fingerprint.fingerprint_bytes`)

Expand Down