Merge pull request #57 from netdata/feat/add-notification-repeat

witalisoft · web-flow · commit e5e929430967 · 2025-01-02T13:26:48.000+01:00
feat: add notification repeat option
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 0.2.2
+
+FEATURES:
+
+- option to specify notification repeat interval `repeat_notification_min` for the paid notification channels
+
 ## 0.2.1
 
 BUGFIXES:
diff --git a/docs/resources/notification_discord_channel.md b/docs/resources/notification_discord_channel.md
@@ -16,12 +16,13 @@ Resource for managing centralized notifications for Discord. Available only in p
 resource "netdata_notification_discord_channel" "test" {
   name = "discord notifications"
 
-  enabled      = true
-  space_id     = "<space_id>"
-  rooms_id     = ["<room_id>"]
-  webhook_url  = "https://discord.com/api/webhooks/0000000000000/XXXXXXXXXXXXXXXXXXXXXXXX"
-  alarms       = "ALARMS_SETTING_ALL"
-  channel_type = "text"
+  enabled                 = true
+  space_id                = "<space_id>"
+  rooms_id                = ["<room_id>"]
+  repeat_notification_min = 30
+  webhook_url             = "https://discord.com/api/webhooks/0000000000000/XXXXXXXXXXXXXXXXXXXXXXXX"
+  alarms                  = "ALARMS_SETTING_ALL"
+  channel_type            = "text"
 }
 ```
 
@@ -40,6 +41,7 @@ resource "netdata_notification_discord_channel" "test" {
 ### Optional
 
 - `channel_thread` (String) Discord channel thread name required if channel type is `forum`
+- `repeat_notification_min` (Number) The time interval for the Discord notification to be repeated. The interval is presented in minutes and should be between 30 and 1440, or 0 to avoid repetition, which is the default.
 - `rooms_id` (List of String) The list of room IDs to set the Discord notification. If the rooms list is null, the Discord notification will be applied to `All rooms`
 
 ### Read-Only
diff --git a/docs/resources/notification_pagerduty_channel.md b/docs/resources/notification_pagerduty_channel.md
@@ -16,12 +16,13 @@ Resource for managing centralized notifications for Pagerduty. Available only in
 resource "netdata_notification_pagerduty_channel" "test" {
   name = "pagerduty notifications"
 
-  enabled          = true
-  space_id         = netdata_space.test.id
-  rooms_id         = ["<room_id>"]
-  alarms           = "ALARMS_SETTING_ALL"
-  alert_events_url = "https://events.pagerduty.com/v2/enqueue"
-  integration_key  = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+  enabled                 = true
+  space_id                = netdata_space.test.id
+  rooms_id                = ["<room_id>"]
+  alarms                  = "ALARMS_SETTING_ALL"
+  repeat_notification_min = 30
+  alert_events_url        = "https://events.pagerduty.com/v2/enqueue"
+  integration_key         = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
 }
 ```
 
@@ -39,6 +40,7 @@ resource "netdata_notification_pagerduty_channel" "test" {
 
 ### Optional
 
+- `repeat_notification_min` (Number) The time interval for the Pagerduty notification to be repeated. The interval is presented in minutes and should be between 30 and 1440, or 0 to avoid repetition, which is the default.
 - `rooms_id` (List of String) The list of room IDs to set the Pagerduty notification. If the rooms list is null, the Pagerduty notification will be applied to `All rooms`
 
 ### Read-Only
diff --git a/docs/resources/notification_slack_channel.md b/docs/resources/notification_slack_channel.md
@@ -16,11 +16,12 @@ Resource for managing centralized notifications for Slack. Available only in pai
 resource "netdata_notification_slack_channel" "test" {
   name = "slack notifications"
 
-  enabled     = true
-  space_id    = "<space_id>"
-  rooms_id    = ["<room_id>"]
-  webhook_url = "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
-  alarms      = "ALARMS_SETTING_ALL"
+  enabled                 = true
+  space_id                = "<space_id>"
+  rooms_id                = ["<room_id>"]
+  repeat_notification_min = 30
+  webhook_url             = "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
+  alarms                  = "ALARMS_SETTING_ALL"
 }
 ```
 
@@ -37,6 +38,7 @@ resource "netdata_notification_slack_channel" "test" {
 
 ### Optional
 
+- `repeat_notification_min` (Number) The time interval for the Slack notification to be repeated. The interval is presented in minutes and should be between 30 and 1440, or 0 to avoid repetition, which is the default.
 - `rooms_id` (List of String) The list of room IDs to set the Slack notification. If the rooms list is null, the Slack notification will be applied to `All rooms`
 
 ### Read-Only
diff --git a/examples/complete/main.tf b/examples/complete/main.tf
@@ -44,11 +44,12 @@ resource "netdata_node_room_member" "test" {
 resource "netdata_notification_slack_channel" "test" {
   name = "slack"
 
-  enabled     = true
-  space_id    = netdata_space.test.id
-  rooms_id    = [netdata_room.test.id]
-  alarms      = "ALARMS_SETTING_ALL"
-  webhook_url = "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
+  enabled                 = true
+  space_id                = netdata_space.test.id
+  rooms_id                = [netdata_room.test.id]
+  alarms                  = "ALARMS_SETTING_ALL"
+  repeat_notification_min = 60
+  webhook_url             = "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
 }
 
 resource "netdata_notification_discord_channel" "test" {
diff --git a/examples/resources/netdata_notification_discord_channel/resource.tf b/examples/resources/netdata_notification_discord_channel/resource.tf
@@ -1,10 +1,11 @@
 resource "netdata_notification_discord_channel" "test" {
   name = "discord notifications"
 
-  enabled      = true
-  space_id     = "<space_id>"
-  rooms_id     = ["<room_id>"]
-  webhook_url  = "https://discord.com/api/webhooks/0000000000000/XXXXXXXXXXXXXXXXXXXXXXXX"
-  alarms       = "ALARMS_SETTING_ALL"
-  channel_type = "text"
+  enabled                 = true
+  space_id                = "<space_id>"
+  rooms_id                = ["<room_id>"]
+  repeat_notification_min = 30
+  webhook_url             = "https://discord.com/api/webhooks/0000000000000/XXXXXXXXXXXXXXXXXXXXXXXX"
+  alarms                  = "ALARMS_SETTING_ALL"
+  channel_type            = "text"
 }
diff --git a/examples/resources/netdata_notification_pagerduty_channel/resource.tf b/examples/resources/netdata_notification_pagerduty_channel/resource.tf
@@ -1,10 +1,11 @@
 resource "netdata_notification_pagerduty_channel" "test" {
   name = "pagerduty notifications"
 
-  enabled          = true
-  space_id         = netdata_space.test.id
-  rooms_id         = ["<room_id>"]
-  alarms           = "ALARMS_SETTING_ALL"
-  alert_events_url = "https://events.pagerduty.com/v2/enqueue"
-  integration_key  = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+  enabled                 = true
+  space_id                = netdata_space.test.id
+  rooms_id                = ["<room_id>"]
+  alarms                  = "ALARMS_SETTING_ALL"
+  repeat_notification_min = 30
+  alert_events_url        = "https://events.pagerduty.com/v2/enqueue"
+  integration_key         = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
 }
diff --git a/examples/resources/netdata_notification_slack_channel/resource.tf b/examples/resources/netdata_notification_slack_channel/resource.tf
@@ -1,9 +1,10 @@
 resource "netdata_notification_slack_channel" "test" {
   name = "slack notifications"
 
-  enabled     = true
-  space_id    = "<space_id>"
-  rooms_id    = ["<room_id>"]
-  webhook_url = "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
-  alarms      = "ALARMS_SETTING_ALL"
+  enabled                 = true
+  space_id                = "<space_id>"
+  rooms_id                = ["<room_id>"]
+  repeat_notification_min = 30
+  webhook_url             = "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
+  alarms                  = "ALARMS_SETTING_ALL"
 }
diff --git a/internal/client/models.go b/internal/client/models.go
@@ -29,13 +29,14 @@ type NotificationIntegrations struct {
 }
 
 type NotificationChannel struct {
-	ID          string                  `json:"id"`
-	Enabled     bool                    `json:"enabled"`
-	Name        string                  `json:"name"`
-	Integration NotificationIntegration `json:"integration"`
-	Alarms      string                  `json:"alarms"`
-	Rooms       []string                `json:"rooms"`
-	Secrets     json.RawMessage         `json:"secrets"`
+	ID                       string                  `json:"id"`
+	Enabled                  bool                    `json:"enabled"`
+	Name                     string                  `json:"name"`
+	Integration              NotificationIntegration `json:"integration"`
+	Alarms                   string                  `json:"alarms"`
+	Rooms                    []string                `json:"rooms"`
+	Secrets                  json.RawMessage         `json:"secrets"`
+	RepeatNotificationMinute int64                   `json:"repeat_notification_min,omitempty"`
 }
 
 type NotificationIntegration struct {
@@ -61,11 +62,12 @@ type NotificationPagerdutyChannel struct {
 }
 
 type notificationRequestPayload struct {
-	Name          string          `json:"name"`
-	IntegrationID string          `json:"integrationID"`
-	Alarms        string          `json:"alarms"`
-	Rooms         []string        `json:"rooms"`
-	Secrets       json.RawMessage `json:"secrets"`
+	Name                     string          `json:"name"`
+	IntegrationID            string          `json:"integrationID"`
+	Alarms                   string          `json:"alarms"`
+	Rooms                    []string        `json:"rooms"`
+	Secrets                  json.RawMessage `json:"secrets"`
+	RepeatNotificationMinute int64           `json:"repeat_notification_min,omitempty"`
 }
 
 type Invitation struct {
diff --git a/internal/client/notification_discord.go b/internal/client/notification_discord.go
@@ -14,10 +14,11 @@ func (c *Client) CreateDiscordChannel(spaceID string, commonParams NotificationC
 	}
 
 	reqBody := notificationRequestPayload{
-		Name:          commonParams.Name,
-		IntegrationID: commonParams.Integration.ID,
-		Rooms:         commonParams.Rooms,
-		Alarms:        commonParams.Alarms,
+		Name:                     commonParams.Name,
+		IntegrationID:            commonParams.Integration.ID,
+		Rooms:                    commonParams.Rooms,
+		Alarms:                   commonParams.Alarms,
+		RepeatNotificationMinute: commonParams.RepeatNotificationMinute,
 	}
 
 	secretsJson, err := json.Marshal(discordParams)
@@ -70,9 +71,10 @@ func (c *Client) UpdateDiscordChannelByID(spaceID string, commonParams Notificat
 	}
 
 	reqBody := notificationRequestPayload{
-		Name:   commonParams.Name,
-		Rooms:  commonParams.Rooms,
-		Alarms: commonParams.Alarms,
+		Name:                     commonParams.Name,
+		Rooms:                    commonParams.Rooms,
+		Alarms:                   commonParams.Alarms,
+		RepeatNotificationMinute: commonParams.RepeatNotificationMinute,
 	}
 
 	secretsJson, err := json.Marshal(discordParams)
diff --git a/internal/client/notification_pagerduty.go b/internal/client/notification_pagerduty.go
@@ -14,10 +14,11 @@ func (c *Client) CreatePagerdutyChannel(spaceID string, commonParams Notificatio
 	}
 
 	reqBody := notificationRequestPayload{
-		Name:          commonParams.Name,
-		IntegrationID: commonParams.Integration.ID,
-		Rooms:         commonParams.Rooms,
-		Alarms:        commonParams.Alarms,
+		Name:                     commonParams.Name,
+		IntegrationID:            commonParams.Integration.ID,
+		Rooms:                    commonParams.Rooms,
+		Alarms:                   commonParams.Alarms,
+		RepeatNotificationMinute: commonParams.RepeatNotificationMinute,
 	}
 
 	secretsJson, err := json.Marshal(pagerdutyParams)
@@ -69,9 +70,10 @@ func (c *Client) UpdatePagerdutyChannelByID(spaceID string, commonParams Notific
 	}
 
 	reqBody := notificationRequestPayload{
-		Name:   commonParams.Name,
-		Rooms:  commonParams.Rooms,
-		Alarms: commonParams.Alarms,
+		Name:                     commonParams.Name,
+		Rooms:                    commonParams.Rooms,
+		Alarms:                   commonParams.Alarms,
+		RepeatNotificationMinute: commonParams.RepeatNotificationMinute,
 	}
 
 	secretsJson, err := json.Marshal(pagerdutyParams)
diff --git a/internal/client/notification_slack.go b/internal/client/notification_slack.go
@@ -14,10 +14,11 @@ func (c *Client) CreateSlackChannel(spaceID string, commonParams NotificationCha
 	}
 
 	reqBody := notificationRequestPayload{
-		Name:          commonParams.Name,
-		IntegrationID: commonParams.Integration.ID,
-		Rooms:         commonParams.Rooms,
-		Alarms:        commonParams.Alarms,
+		Name:                     commonParams.Name,
+		IntegrationID:            commonParams.Integration.ID,
+		Rooms:                    commonParams.Rooms,
+		Alarms:                   commonParams.Alarms,
+		RepeatNotificationMinute: commonParams.RepeatNotificationMinute,
 	}
 
 	secretsJson, err := json.Marshal(slackParams)
@@ -68,9 +69,10 @@ func (c *Client) UpdateSlackChannelByID(spaceID string, commonParams Notificatio
 	}
 
 	reqBody := notificationRequestPayload{
-		Name:   commonParams.Name,
-		Rooms:  commonParams.Rooms,
-		Alarms: commonParams.Alarms,
+		Name:                     commonParams.Name,
+		Rooms:                    commonParams.Rooms,
+		Alarms:                   commonParams.Alarms,
+		RepeatNotificationMinute: commonParams.RepeatNotificationMinute,
 	}
 	secretsJson, err := json.Marshal(slackParams)
 	if err != nil {
diff --git a/internal/provider/notification_discord_channel_resource.go b/internal/provider/notification_discord_channel_resource.go
@@ -31,15 +31,16 @@ type discordChannelResource struct {
 }
 
 type discordChannelResourceModel struct {
-	ID            types.String `tfsdk:"id"`
-	Name          types.String `tfsdk:"name"`
-	Enabled       types.Bool   `tfsdk:"enabled"`
-	SpaceID       types.String `tfsdk:"space_id"`
-	RoomsID       types.List   `tfsdk:"rooms_id"`
-	Alarms        types.String `tfsdk:"alarms"`
-	WebhookURL    types.String `tfsdk:"webhook_url"`
-	ChannelType   types.String `tfsdk:"channel_type"`
-	ChannelThread types.String `tfsdk:"channel_thread"`
+	ID                       types.String `tfsdk:"id"`
+	Name                     types.String `tfsdk:"name"`
+	Enabled                  types.Bool   `tfsdk:"enabled"`
+	SpaceID                  types.String `tfsdk:"space_id"`
+	RoomsID                  types.List   `tfsdk:"rooms_id"`
+	Alarms                   types.String `tfsdk:"alarms"`
+	RepeatNotificationMinute types.Int64  `tfsdk:"repeat_notification_min"`
+	WebhookURL               types.String `tfsdk:"webhook_url"`
+	ChannelType              types.String `tfsdk:"channel_type"`
+	ChannelThread            types.String `tfsdk:"channel_thread"`
 }
 
 func (s *discordChannelResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
@@ -118,11 +119,12 @@ func (s *discordChannelResource) Create(ctx context.Context, req resource.Create
 	plan.RoomsID.ElementsAs(ctx, &roomsID, false)
 
 	commonParams := client.NotificationChannel{
-		Name:        plan.Name.ValueString(),
-		Integration: *notificationIntegration,
-		Rooms:       roomsID,
-		Alarms:      plan.Alarms.ValueString(),
-		Enabled:     plan.Enabled.ValueBool(),
+		Name:                     plan.Name.ValueString(),
+		Integration:              *notificationIntegration,
+		Rooms:                    roomsID,
+		Alarms:                   plan.Alarms.ValueString(),
+		Enabled:                  plan.Enabled.ValueBool(),
+		RepeatNotificationMinute: plan.RepeatNotificationMinute.ValueInt64(),
 	}
 
 	discordParams := client.NotificationDiscordChannel{
@@ -151,6 +153,7 @@ func (s *discordChannelResource) Create(ctx context.Context, req resource.Create
 	plan.Enabled = types.BoolValue(notificationChannel.Enabled)
 	plan.RoomsID, _ = types.ListValueFrom(ctx, types.StringType, notificationChannel.Rooms)
 	plan.Alarms = types.StringValue(notificationChannel.Alarms)
+	plan.RepeatNotificationMinute = types.Int64Value(notificationChannel.RepeatNotificationMinute)
 
 	diags = resp.State.Set(ctx, plan)
 	resp.Diagnostics.Append(diags...)
@@ -194,6 +197,7 @@ func (s *discordChannelResource) Read(ctx context.Context, req resource.ReadRequ
 	state.Enabled = types.BoolValue(notificationChannel.Enabled)
 	state.RoomsID, _ = types.ListValueFrom(ctx, types.StringType, notificationChannel.Rooms)
 	state.Alarms = types.StringValue(notificationChannel.Alarms)
+	state.RepeatNotificationMinute = types.Int64Value(notificationChannel.RepeatNotificationMinute)
 	state.WebhookURL = types.StringValue(notificationSecrets.URL)
 	state.ChannelType = types.StringValue(notificationSecrets.ChannelParams.Selection)
 	if notificationSecrets.ChannelParams.Selection == "forum" {
@@ -228,11 +232,12 @@ func (s *discordChannelResource) Update(ctx context.Context, req resource.Update
 	plan.RoomsID.ElementsAs(ctx, &roomsID, false)
 
 	commonParams := client.NotificationChannel{
-		ID:      plan.ID.ValueString(),
-		Name:    plan.Name.ValueString(),
-		Rooms:   roomsID,
-		Alarms:  plan.Alarms.ValueString(),
-		Enabled: plan.Enabled.ValueBool(),
+		ID:                       plan.ID.ValueString(),
+		Name:                     plan.Name.ValueString(),
+		Rooms:                    roomsID,
+		Alarms:                   plan.Alarms.ValueString(),
+		Enabled:                  plan.Enabled.ValueBool(),
+		RepeatNotificationMinute: plan.RepeatNotificationMinute.ValueInt64(),
 	}
 
 	discordParams := client.NotificationDiscordChannel{
@@ -261,6 +266,7 @@ func (s *discordChannelResource) Update(ctx context.Context, req resource.Update
 	plan.Enabled = types.BoolValue(notificationChannel.Enabled)
 	plan.RoomsID, _ = types.ListValueFrom(ctx, types.StringType, notificationChannel.Rooms)
 	plan.Alarms = types.StringValue(notificationChannel.Alarms)
+	plan.RepeatNotificationMinute = types.Int64Value(notificationChannel.RepeatNotificationMinute)
 
 	diags = resp.State.Set(ctx, plan)
 	resp.Diagnostics.Append(diags...)
diff --git a/internal/provider/notification_discord_channel_resource_test.go b/internal/provider/notification_discord_channel_resource_test.go
diff --git a/internal/provider/notification_pagerduty_channel_resource.go b/internal/provider/notification_pagerduty_channel_resource.go
diff --git a/internal/provider/notification_pagerduty_channel_resource_test.go b/internal/provider/notification_pagerduty_channel_resource_test.go
diff --git a/internal/provider/notification_slack_channel_resource.go b/internal/provider/notification_slack_channel_resource.go
diff --git a/internal/provider/notification_slack_channel_resource_test.go b/internal/provider/notification_slack_channel_resource_test.go
diff --git a/internal/provider/notifications.go b/internal/provider/notifications.go
