chore(observability): adjust example and default values (#937)

This commit is contained in:
Ruben Hönle 2025-08-26 13:58:41 +02:00 committed by GitHub
parent 0f8362ca74
commit 9c319584a5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 27 additions and 27 deletions

View file

@ -44,9 +44,9 @@ data "stackit_observability_instance" "example" {
- `logs_push_url` (String) Specifies URL for pushing logs.
- `logs_url` (String) Specifies Logs URL.
- `metrics_push_url` (String) Specifies URL for pushing metrics.
- `metrics_retention_days` (Number) Specifies for how many days the raw metrics are kept.
- `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).
- `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).
- `metrics_retention_days` (Number) Specifies for how many days the raw metrics are kept. Default is set to `90`.
- `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`.
- `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`.
- `metrics_url` (String) Specifies metrics URL.
- `name` (String) The name of the Observability instance.
- `otlp_traces_url` (String)

View file

@ -27,9 +27,9 @@ This guide explains how to configure the STACKIT Loadbalancer product to send me
name = "example-instance"
plan_name = "Observability-Monitoring-Medium-EU01"
acl = ["0.0.0.0/0"]
metrics_retention_days = 30
metrics_retention_days_5m_downsampling = 10
metrics_retention_days_1h_downsampling = 5
metrics_retention_days = 90
metrics_retention_days_5m_downsampling = 90
metrics_retention_days_1h_downsampling = 90
}
resource "stackit_observability_credential" "observability01-credential" {

View file

@ -18,9 +18,9 @@ resource "stackit_observability_instance" "example" {
name = "example-instance"
plan_name = "Observability-Monitoring-Medium-EU01"
acl = ["1.1.1.1/32", "2.2.2.2/32"]
metrics_retention_days = 30
metrics_retention_days_5m_downsampling = 10
metrics_retention_days_1h_downsampling = 5
metrics_retention_days = 90
metrics_retention_days_5m_downsampling = 90
metrics_retention_days_1h_downsampling = 90
}
# Only use the import statement, if you want to import an existing observability instance
@ -43,9 +43,9 @@ import {
- `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.
- `alert_config` (Attributes) Alert configuration for the instance. (see [below for nested schema](#nestedatt--alert_config))
- `metrics_retention_days` (Number) Specifies for how many days the raw metrics are kept.
- `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).
- `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).
- `metrics_retention_days` (Number) Specifies for how many days the raw metrics are kept. Default is set to `90`.
- `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`.
- `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`.
- `parameters` (Map of String) Additional parameters.
### Read-Only

View file

@ -3,9 +3,9 @@ resource "stackit_observability_instance" "example" {
name = "example-instance"
plan_name = "Observability-Monitoring-Medium-EU01"
acl = ["1.1.1.1/32", "2.2.2.2/32"]
metrics_retention_days = 30
metrics_retention_days_5m_downsampling = 10
metrics_retention_days_1h_downsampling = 5
metrics_retention_days = 90
metrics_retention_days_5m_downsampling = 90
metrics_retention_days_1h_downsampling = 90
}
# Only use the import statement, if you want to import an existing observability instance

View file

@ -133,15 +133,15 @@ func (d *instanceDataSource) Schema(_ context.Context, _ datasource.SchemaReques
Sensitive: true,
},
"metrics_retention_days": schema.Int64Attribute{
Description: "Specifies for how many days the raw metrics are kept.",
Description: "Specifies for how many days the raw metrics are kept. Default is set to `90`.",
Computed: true,
},
"metrics_retention_days_5m_downsampling": schema.Int64Attribute{
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).",
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`.",
Computed: true,
},
"metrics_retention_days_1h_downsampling": schema.Int64Attribute{
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).",
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`.",
Computed: true,
},
"metrics_url": schema.StringAttribute{

View file

@ -473,17 +473,17 @@ func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, r
},
},
"metrics_retention_days": schema.Int64Attribute{
Description: "Specifies for how many days the raw metrics are kept.",
Description: "Specifies for how many days the raw metrics are kept. Default is set to `90`.",
Optional: true,
Computed: true,
},
"metrics_retention_days_5m_downsampling": schema.Int64Attribute{
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).",
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`.",
Optional: true,
Computed: true,
},
"metrics_retention_days_1h_downsampling": schema.Int64Attribute{
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).",
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`.",
Optional: true,
Computed: true,
},

View file

@ -69,9 +69,9 @@ var testConfigVarsMax = config.Variables{
"alert_annotation": config.StringVariable("annotation1"),
"alert_interval": config.StringVariable("5h"),
// max instance
"metrics_retention_days": config.StringVariable("30"),
"metrics_retention_days_5m_downsampling": config.StringVariable("10"),
"metrics_retention_days_1h_downsampling": config.StringVariable("5"),
"metrics_retention_days": config.StringVariable("90"),
"metrics_retention_days_5m_downsampling": config.StringVariable("90"),
"metrics_retention_days_1h_downsampling": config.StringVariable("90"),
"instance_acl_1": config.StringVariable("1.2.3.4/32"),
"instance_acl_2": config.StringVariable("111.222.111.222/32"),
"receiver_name": config.StringVariable("OpsGenieReceiverInfo"),

View file

@ -27,9 +27,9 @@ This guide explains how to configure the STACKIT Loadbalancer product to send me
name = "example-instance"
plan_name = "Observability-Monitoring-Medium-EU01"
acl = ["0.0.0.0/0"]
metrics_retention_days = 30
metrics_retention_days_5m_downsampling = 10
metrics_retention_days_1h_downsampling = 5
metrics_retention_days = 90
metrics_retention_days_5m_downsampling = 90
metrics_retention_days_1h_downsampling = 90
}
resource "stackit_observability_credential" "observability01-credential" {