chore: Codify the use of abbreviate time units in config option names (…

…vectordotdev#17582) Codifying the status quo since there wasn't a strong motivator to change it and we want to maintain consistency. Signed-off-by: Jesse Szwedko <[email protected]> Signed-off-by: Jesse Szwedko <[email protected]>
aholmberg · Jun 2, 2023 · 8823561 · 8823561
1 parent 4af5e6d
commit 8823561
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/docs/specs/configuration.md b/docs/specs/configuration.md
@@ -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`)