Skip to content

Commit

Permalink
chore: Codify the use of abbreviate time units in config option names
Browse files Browse the repository at this point in the history
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 <jesse.szwedko@datadoghq.com>
  • Loading branch information
jszwedko committed Jun 2, 2023
1 parent 8a741d5 commit 9aaa9c5
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/specs/configuration.md
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

0 comments on commit 9aaa9c5

Please sign in to comment.