Skip to content

Commit 9c31958

Browse files
rubenhoenlerubenhoenle
authored
chore(observability): adjust example and default values (#937)
1 parent 0f8362c commit 9c31958

8 files changed

Lines changed: 27 additions & 27 deletions

File tree

‎docs/data-sources/observability_instance.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ data "stackit_observability_instance" "example" {
4444
- `logs_push_url` (String) Specifies URL for pushing logs.
4545
- `logs_url` (String) Specifies Logs URL.
4646
- `metrics_push_url` (String) Specifies URL for pushing metrics.
47-
- `metrics_retention_days` (Number) Specifies for how many days the raw metrics are kept.
48-
- `metrics_retention_days_1h_downsampling` (Number) Specifies for how many days the 1h downsampled metrics are kept. must be less than the value of the 5m downsampling retention. Default is set to `0` (disabled).
49-
- `metrics_retention_days_5m_downsampling` (Number) Specifies for how many days the 5m downsampled metrics are kept. must be less than the value of the general retention. Default is set to `0` (disabled).
47+
- `metrics_retention_days` (Number) Specifies for how many days the raw metrics are kept. Default is set to `90`.
48+
- `metrics_retention_days_1h_downsampling` (Number) Specifies for how many days the 1h downsampled metrics are kept. must be less than the value of the 5m downsampling retention. Default is set to `90`.
49+
- `metrics_retention_days_5m_downsampling` (Number) Specifies for how many days the 5m downsampled metrics are kept. must be less than the value of the general retention. Default is set to `90`.
5050
- `metrics_url` (String) Specifies metrics URL.
5151
- `name` (String) The name of the Observability instance.
5252
- `otlp_traces_url` (String)

‎docs/guides/using_loadbalancer_with_observability.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ This guide explains how to configure the STACKIT Loadbalancer product to send me
2727
name = "example-instance"
2828
plan_name = "Observability-Monitoring-Medium-EU01"
2929
acl = ["0.0.0.0/0"]
30-
metrics_retention_days = 30
31-
metrics_retention_days_5m_downsampling = 10
32-
metrics_retention_days_1h_downsampling = 5
30+
metrics_retention_days = 90
31+
metrics_retention_days_5m_downsampling = 90
32+
metrics_retention_days_1h_downsampling = 90
3333
}
3434
3535
resource "stackit_observability_credential" "observability01-credential" {

‎docs/resources/observability_instance.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ resource "stackit_observability_instance" "example" {
1818
name = "example-instance"
1919
plan_name = "Observability-Monitoring-Medium-EU01"
2020
acl = ["1.1.1.1/32", "2.2.2.2/32"]
21-
metrics_retention_days = 30
22-
metrics_retention_days_5m_downsampling = 10
23-
metrics_retention_days_1h_downsampling = 5
21+
metrics_retention_days = 90
22+
metrics_retention_days_5m_downsampling = 90
23+
metrics_retention_days_1h_downsampling = 90
2424
}
2525
2626
# Only use the import statement, if you want to import an existing observability instance
@@ -43,9 +43,9 @@ import {
4343

4444
- `acl` (Set of String) The access control list for this instance. Each entry is an IP address range that is permitted to access, in CIDR notation.
4545
- `alert_config` (Attributes) Alert configuration for the instance. (see [below for nested schema](#nestedatt--alert_config))
46-
- `metrics_retention_days` (Number) Specifies for how many days the raw metrics are kept.
47-
- `metrics_retention_days_1h_downsampling` (Number) Specifies for how many days the 1h downsampled metrics are kept. must be less than the value of the 5m downsampling retention. Default is set to `0` (disabled).
48-
- `metrics_retention_days_5m_downsampling` (Number) Specifies for how many days the 5m downsampled metrics are kept. must be less than the value of the general retention. Default is set to `0` (disabled).
46+
- `metrics_retention_days` (Number) Specifies for how many days the raw metrics are kept. Default is set to `90`.
47+
- `metrics_retention_days_1h_downsampling` (Number) Specifies for how many days the 1h downsampled metrics are kept. must be less than the value of the 5m downsampling retention. Default is set to `90`.
48+
- `metrics_retention_days_5m_downsampling` (Number) Specifies for how many days the 5m downsampled metrics are kept. must be less than the value of the general retention. Default is set to `90`.
4949
- `parameters` (Map of String) Additional parameters.
5050

5151
### Read-Only

‎examples/resources/stackit_observability_instance/resource.tf‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ resource "stackit_observability_instance" "example" {
33
name = "example-instance"
44
plan_name = "Observability-Monitoring-Medium-EU01"
55
acl = ["1.1.1.1/32", "2.2.2.2/32"]
6-
metrics_retention_days = 30
7-
metrics_retention_days_5m_downsampling = 10
8-
metrics_retention_days_1h_downsampling = 5
6+
metrics_retention_days = 90
7+
metrics_retention_days_5m_downsampling = 90
8+
metrics_retention_days_1h_downsampling = 90
99
}
1010

1111
# Only use the import statement, if you want to import an existing observability instance

‎stackit/internal/services/observability/instance/datasource.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,15 +133,15 @@ func (d *instanceDataSource) Schema(_ context.Context, _ datasource.SchemaReques
133133
Sensitive: true,
134134
},
135135
"metrics_retention_days": schema.Int64Attribute{
136-
Description: "Specifies for how many days the raw metrics are kept.",
136+
Description: "Specifies for how many days the raw metrics are kept. Default is set to `90`.",
137137
Computed: true,
138138
},
139139
"metrics_retention_days_5m_downsampling": schema.Int64Attribute{
140-
Description: "Specifies for how many days the 5m downsampled metrics are kept. must be less than the value of the general retention. Default is set to `0` (disabled).",
140+
Description: "Specifies for how many days the 5m downsampled metrics are kept. must be less than the value of the general retention. Default is set to `90`.",
141141
Computed: true,
142142
},
143143
"metrics_retention_days_1h_downsampling": schema.Int64Attribute{
144-
Description: "Specifies for how many days the 1h downsampled metrics are kept. must be less than the value of the 5m downsampling retention. Default is set to `0` (disabled).",
144+
Description: "Specifies for how many days the 1h downsampled metrics are kept. must be less than the value of the 5m downsampling retention. Default is set to `90`.",
145145
Computed: true,
146146
},
147147
"metrics_url": schema.StringAttribute{

‎stackit/internal/services/observability/instance/resource.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -473,17 +473,17 @@ func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, r
473473
},
474474
},
475475
"metrics_retention_days": schema.Int64Attribute{
476-
Description: "Specifies for how many days the raw metrics are kept.",
476+
Description: "Specifies for how many days the raw metrics are kept. Default is set to `90`.",
477477
Optional: true,
478478
Computed: true,
479479
},
480480
"metrics_retention_days_5m_downsampling": schema.Int64Attribute{
481-
Description: "Specifies for how many days the 5m downsampled metrics are kept. must be less than the value of the general retention. Default is set to `0` (disabled).",
481+
Description: "Specifies for how many days the 5m downsampled metrics are kept. must be less than the value of the general retention. Default is set to `90`.",
482482
Optional: true,
483483
Computed: true,
484484
},
485485
"metrics_retention_days_1h_downsampling": schema.Int64Attribute{
486-
Description: "Specifies for how many days the 1h downsampled metrics are kept. must be less than the value of the 5m downsampling retention. Default is set to `0` (disabled).",
486+
Description: "Specifies for how many days the 1h downsampled metrics are kept. must be less than the value of the 5m downsampling retention. Default is set to `90`.",
487487
Optional: true,
488488
Computed: true,
489489
},

‎stackit/internal/services/observability/observability_acc_test.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,9 @@ var testConfigVarsMax = config.Variables{
6969
"alert_annotation": config.StringVariable("annotation1"),
7070
"alert_interval": config.StringVariable("5h"),
7171
// max instance
72-
"metrics_retention_days": config.StringVariable("30"),
73-
"metrics_retention_days_5m_downsampling": config.StringVariable("10"),
74-
"metrics_retention_days_1h_downsampling": config.StringVariable("5"),
72+
"metrics_retention_days": config.StringVariable("90"),
73+
"metrics_retention_days_5m_downsampling": config.StringVariable("90"),
74+
"metrics_retention_days_1h_downsampling": config.StringVariable("90"),
7575
"instance_acl_1": config.StringVariable("1.2.3.4/32"),
7676
"instance_acl_2": config.StringVariable("111.222.111.222/32"),
7777
"receiver_name": config.StringVariable("OpsGenieReceiverInfo"),

‎templates/guides/using_loadbalancer_with_observability.md.tmpl‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ This guide explains how to configure the STACKIT Loadbalancer product to send me
2727
name = "example-instance"
2828
plan_name = "Observability-Monitoring-Medium-EU01"
2929
acl = ["0.0.0.0/0"]
30-
metrics_retention_days = 30
31-
metrics_retention_days_5m_downsampling = 10
32-
metrics_retention_days_1h_downsampling = 5
30+
metrics_retention_days = 90
31+
metrics_retention_days_5m_downsampling = 90
32+
metrics_retention_days_1h_downsampling = 90
3333
}
3434
3535
resource "stackit_observability_credential" "observability01-credential" {

0 commit comments

Comments
 (0)