Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/data-sources/observability_instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/using_loadbalancer_with_observability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" {
Expand Down
12 changes: 6 additions & 6 deletions docs/resources/observability_instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
```

Expand All @@ -37,9 +37,9 @@ resource "stackit_observability_instance" "example" {

- `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
Expand Down
6 changes: 3 additions & 3 deletions examples/resources/stackit_observability_instance/resource.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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
}
6 changes: 3 additions & 3 deletions stackit/internal/services/observability/instance/datasource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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{
Expand Down
6 changes: 3 additions & 3 deletions stackit/internal/services/observability/instance/resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -468,17 +468,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,
},
Expand Down
6 changes: 3 additions & 3 deletions stackit/internal/services/observability/observability_acc_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
Expand Down
6 changes: 3 additions & 3 deletions templates/guides/using_loadbalancer_with_observability.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" {
Expand Down
Loading