Prometheus Retention Schema¶
Note
This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.
Return to the root config schema
https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/prometheus/properties/retention
Configure retention for Prometheus.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | config/schemas/config.yaml* |
TYPE:
object (Prometheus Retention)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| age | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| size | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| alertmanager | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
age¶
Configure the time range Prometheus will retain metrics for.
age
-
is optional
-
Type:
string(Prometheus Retention Age) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Prometheus Retention Age)
DEFAULTS:
The default value is:
"3d"
size¶
Configure the total size Prometheus will retain metrics for.
size
-
is optional
-
Type:
string(Prometheus Retention Size) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Prometheus Retention Size)
DEFAULTS:
The default value is:
"4GiB"
alertmanager¶
An amount of time
alertmanager
-
is optional
-
Type:
string(Time Range) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Time Range)
CONSTRAINTS:
pattern: the string must match the following regular expression:
^[0-9]+[hmsd]+$
DEFAULTS:
The default value is:
"72h"
EXAMPLES:
300s
72h
3d
Return to the root config schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main