Skip to content

Commit 8823561

Browse files
authored
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]>
1 parent 4af5e6d commit 8823561

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/specs/configuration.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,8 @@ under entities and also used to define global Vector behavior.
6464
- MUST only contain ASCII alphanumeric, lowercase, and underscores
6565
- MUST be in snake case format when multiple words are used (e.g., `timeout_seconds`)
6666
- SHOULD use nouns, not verbs, as names (e.g., `fingerprint` instead of `fingerprinting`)
67-
- MUST suffix options with their _full_ unit name (e.g., `_seconds`, `_bytes`, etc.)
67+
- MUST suffix options with their _full_ unit name (e.g., `_megabytes` rather than `_mb`) or the
68+
following abbreviations for time units: `_secs`, `_ms`, `_ns`.
6869
- SHOULD consistent with units within the same scope. (e.g., don't mix seconds and milliseconds)
6970
- MUST NOT repeat the name space in the option name (e.g., `fingerprint.bytes` instead of `fingerprint.fingerprint_bytes`)
7071

0 commit comments

Comments
 (0)