mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-22 15:11:07 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
43 lines
1.5 KiB
Plaintext
43 lines
1.5 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Duration String Format
|
|
description: A description of Vault's duration string format used throughout Vault.
|
|
---
|
|
|
|
> [!IMPORTANT]
|
|
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
|
|
|
# Duration string format
|
|
|
|
Vault uses a unique duration string format as part of its configuration and APIs.
|
|
This format is used throughout Vault wherever durations are provided. For
|
|
example, telemetry configuration contains various options using this format, such as
|
|
`usage_gauge_period`, which is the interval of collection for high-cardinality usage data.
|
|
|
|
## How it works
|
|
|
|
A duration string is a possibly signed sequence of decimal numbers, each with an optional fraction and
|
|
an optional unit suffix. If no unit is given, we interpret the numbers as seconds.
|
|
|
|
Valid time units are:
|
|
|
|
- `ns` Nanoseconds
|
|
- `us` (or `µs`): Microseconds
|
|
- `ms`: Milliseconds
|
|
- `s`: Seconds
|
|
- `m`: Minutes
|
|
- `h`: Hours
|
|
- `d`: Days
|
|
|
|
## Examples
|
|
|
|
Example values could be:
|
|
|
|
- `100` (One hundred seconds, equivalent to `100s`)
|
|
- `60h` (Sixty hours)
|
|
- `1.5h` (One and a half hours)
|
|
- `50d` (Fifty days)
|
|
- `100ms` (One hundred milliseconds)
|
|
- `50ns` (Fifty nanoseconds)
|
|
|