feat(logs): alert_definitins, policy order and dashboard fix (IBM-Cloud#6526)

* Support order and enable in ibm_logs_policy

* fix(policy) address review comment

* support alertsdef resource and datasource

* fix(alerts): alerts resource and datasource

* fix(alerts): alerts resource and datasource

* update alert definitions docs

* fix logs policy docs

* fix alerts testcases

Author: kavya498

examples/ibm-logs/README.md

@@ -113,14 +113,19 @@ resource "ibm_logs_outgoing_webhook" "logs_outgoing_webhook_instance" {
     region_id = "eu-es"
     source_id = "crn:v1:staging:public:logs:eu-gb:a/223af6f4260f42ebe23e95fcddd33cb7:63a3e4be-cb73-4f52-898e-8e93484a70a5::"
     source_name = "IBM Cloud Event Notifications"
+    endpoint_type = "private"
   }
 }
 
 // Provision logs_policy resource instance
 resource "ibm_logs_policy" "logs_policy_instance" {
+  before {
+    id = "9fab83da-98cb-4f18-a7ba-b6f0435c9673"
+  }
   name = var.logs_policy_name
   description = var.logs_policy_description
   priority = var.logs_policy_priority
+  enabled = var.logs_policy_enabled
   application_rule {
     rule_type_id = "includes"
     name = "Rule Name"
@@ -224,6 +229,9 @@ resource "ibm_logs_dashboard" "logs_dashboard_instance" {
           updated_at = "2021-01-01T00:00:00.000Z"
         }
       }
+      options {
+        internal = {  }
+      }
     }
   }
   variables {
@@ -242,9 +250,14 @@ resource "ibm_logs_dashboard" "logs_dashboard_instance" {
           all = {  }
         }
         values_order_direction = "desc"
+        selection_options {
+          selection_type = "single"
+        }
       }
     }
     display_name = "Service Name"
+    description = "description"
+    display_type = "nothing"
   }
   filters {
     source {
@@ -364,6 +377,42 @@ resource "ibm_logs_view_folder" "logs_view_folder_instance" {
   name = var.logs_view_folder_name
 }
 
+// Provision logs_data_access_rule resource instance
+resource "ibm_logs_data_access_rule" "logs_data_access_rule_instance" {
+  display_name = var.logs_data_access_rule_display_name
+  description = var.logs_data_access_rule_description
+  filters {
+    entity_type = "logs"
+    expression = "true"
+  }
+  default_expression = var.logs_data_access_rule_default_expression
+}
+
+// Provision logs_enrichment resource instance
+resource "ibm_logs_enrichment" "logs_enrichment_instance" {
+  field_name = var.logs_enrichment_field_name
+  enrichment_type {
+    geo_ip = {  }
+  }
+}
+
+// Provision logs_data_usage_metrics resource instance
+resource "ibm_logs_data_usage_metrics" "logs_data_usage_metrics_instance" {
+  enabled = var.logs_data_usage_metrics_enabled
+}
+
+// Provision logs_stream resource instance
+resource "ibm_logs_stream" "logs_stream_instance" {
+  name = var.logs_stream_name
+  is_active = var.logs_stream_is_active
+  dpxl_expression = var.logs_stream_dpxl_expression
+  compression_type = var.logs_stream_compression_type
+  ibm_event_streams {
+    brokers = "kafka01.example.com:9093"
+    topic = "live.screen"
+  }
+}
+
 // Data source is not linked to a resource instance
 // Uncomment if an existing data source instance exists
 /*
@@ -444,6 +493,14 @@ data "ibm_logs_dashboard" "logs_dashboard_instance" {
 }
 */
 
+// Data source is not linked to a resource instance
+// Uncomment if an existing data source instance exists
+/*
+// Create logs_dashboard_folder data source
+data "ibm_logs_dashboard_folder" "logs_dashboard_folder_instance" {
+}
+*/
+
 // Data source is not linked to a resource instance
 // Uncomment if an existing data source instance exists
 /*
@@ -452,6 +509,14 @@ data "ibm_logs_dashboard_folders" "logs_dashboard_folders_instance" {
 }
 */
 
+// Data source is not linked to a resource instance
+// Uncomment if an existing data source instance exists
+/*
+// Create logs_dashboards data source
+data "ibm_logs_dashboards" "logs_dashboards_instance" {
+}
+*/
+
 // Data source is not linked to a resource instance
 // Uncomment if an existing data source instance exists
 /*
@@ -502,3 +567,80 @@ data "ibm_logs_view_folder" "logs_view_folder_instance" {
 data "ibm_logs_view_folders" "logs_view_folders_instance" {
 }
 */
+
+// Data source is not linked to a resource instance
+// Uncomment if an existing data source instance exists
+/*
+// Create logs_data_access_rule data source
+data "ibm_logs_data_access_rule" "logs_data_access_rule_instance" {
+  logs_data_access_rule_id = var.data_logs_data_access_rule_logs_data_access_rule_id
+}
+*/
+
+// Data source is not linked to a resource instance
+// Uncomment if an existing data source instance exists
+/*
+// Create logs_data_access_rules data source
+data "ibm_logs_data_access_rules" "logs_data_access_rules_instance" {
+  logs_data_access_rules_id = var.logs_data_access_rules_logs_data_access_rules_id
+}
+*/
+
+// Data source is not linked to a resource instance
+// Uncomment if an existing data source instance exists
+/*
+// Create logs_enrichment data source
+data "ibm_logs_enrichment" "logs_enrichment_instance" {
+}
+*/
+
+// Data source is not linked to a resource instance
+// Uncomment if an existing data source instance exists
+/*
+// Create logs_enrichments data source
+data "ibm_logs_enrichments" "logs_enrichments_instance" {
+}
+*/
+
+// Data source is not linked to a resource instance
+// Uncomment if an existing data source instance exists
+/*
+// Create logs_data_usage_metrics data source
+data "ibm_logs_data_usage_metrics" "logs_data_usage_metrics_instance" {
+  range = var.data_logs_data_usage_metrics_range
+  query = var.data_logs_data_usage_metrics_query
+}
+*/
+
+// Data source is not linked to a resource instance
+// Uncomment if an existing data source instance exists
+/*
+// Create logs_stream data source
+data "ibm_logs_stream" "logs_stream_instance" {
+}
+*/
+
+// Data source is not linked to a resource instance
+// Uncomment if an existing data source instance exists
+/*
+// Create logs_streams data source
+data "ibm_logs_streams" "logs_streams_instance" {
+}
+*/
+
+// Data source is not linked to a resource instance
+// Uncomment if an existing data source instance exists
+/*
+// Create logs_alert_definition data source
+data "ibm_logs_alert_definition" "logs_alert_definition_instance" {
+  logs_alert_definition_id = var.data_logs_alert_definition_logs_alert_definition_id
+}
+*/
+
+// Data source is not linked to a resource instance
+// Uncomment if an existing data source instance exists
+/*
+// Create logs_alert_definitions data source
+data "ibm_logs_alert_definitions" "logs_alert_definitions_instance" {
+}
+*/

examples/ibm-logs/main.tf

@@ -52,3 +52,27 @@ output "ibm_logs_view_folder" {
   value       = ibm_logs_view_folder.logs_view_folder_instance
   description = "logs_view_folder resource instance"
 }
+// This output allows logs_data_access_rule data to be referenced by other resources and the terraform CLI
+// Modify this output if only certain data should be exposed
+output "ibm_logs_data_access_rule" {
+  value       = ibm_logs_data_access_rule.logs_data_access_rule_instance
+  description = "logs_data_access_rule resource instance"
+}
+// This output allows logs_enrichment data to be referenced by other resources and the terraform CLI
+// Modify this output if only certain data should be exposed
+output "ibm_logs_enrichment" {
+  value       = ibm_logs_enrichment.logs_enrichment_instance
+  description = "logs_enrichment resource instance"
+}
+// This output allows logs_data_usage_metrics data to be referenced by other resources and the terraform CLI
+// Modify this output if only certain data should be exposed
+output "ibm_logs_data_usage_metrics" {
+  value       = ibm_logs_data_usage_metrics.logs_data_usage_metrics_instance
+  description = "logs_data_usage_metrics resource instance"
+}
+// This output allows logs_stream data to be referenced by other resources and the terraform CLI
+// Modify this output if only certain data should be exposed
+output "ibm_logs_stream" {
+  value       = ibm_logs_stream.logs_stream_instance
+  description = "logs_stream resource instance"
+}

examples/ibm-logs/outputs.tf

@@ -90,6 +90,11 @@ variable "logs_policy_priority" {
   type        = string
   default     = "type_high"
 }
+variable "logs_policy_enabled" {
+  description = "Flag to enable or disable a policy. This flag is supported only while updating a policy, since the policies are always enabled during creation."
+  type        = bool
+  default     = true
+}
 
 // Resource arguments for logs_dashboard
 variable "logs_dashboard_href" {
@@ -161,6 +166,58 @@ variable "logs_view_folder_name" {
   default     = "My Folder"
 }
 
+// Resource arguments for logs_data_access_rule
+variable "logs_data_access_rule_display_name" {
+  description = "Data Access Rule Display Name."
+  type        = string
+  default     = "Test Data Access Rule"
+}
+variable "logs_data_access_rule_description" {
+  description = "Optional Data Access Rule Description."
+  type        = string
+  default     = "Data Access Rule intended for testing"
+}
+variable "logs_data_access_rule_default_expression" {
+  description = "Default expression to use when no filter matches the query."
+  type        = string
+  default     = "<v1>true"
+}
+
+// Resource arguments for logs_enrichment
+variable "logs_enrichment_field_name" {
+  description = "The enrichment field name."
+  type        = string
+  default     = "ip"
+}
+
+// Resource arguments for logs_data_usage_metrics
+variable "logs_data_usage_metrics_enabled" {
+  description = "The \"enabled\" parameter for metrics export."
+  type        = bool
+  default     = true
+}
+
+// Resource arguments for logs_stream
+variable "logs_stream_name" {
+  description = "The name of the Event stream."
+  type        = string
+  default     = "Live Screen"
+}
+variable "logs_stream_is_active" {
+  description = "Whether the Event stream is active."
+  type        = bool
+  default     = true
+}
+variable "logs_stream_dpxl_expression" {
+  description = "The DPXL expression of the Event stream."
+  type        = string
+  default     = "<v1>contains(kubernetes.labels.CX_AZ, 'eu-west-1')"
+}
+variable "logs_stream_compression_type" {
+  description = "The compression type of the stream."
+  type        = string
+  default     = "gzip"
+}
 // Data source arguments for logs_alert
 variable "data_logs_alert_logs_alert_id" {
   description = "Alert ID."
@@ -218,6 +275,8 @@ variable "data_logs_dashboard_dashboard_id" {
 }
 
 
+
+
 // Data source arguments for logs_e2m
 variable "data_logs_e2m_logs_e2m_id" {
   description = "ID of e2m to be deleted."
@@ -241,3 +300,33 @@ variable "data_logs_view_folder_logs_view_folder_id" {
   default     = 3dc02998-0b50-4ea8-b68a-4779d716fa1f
 }
 
+
+// Data source arguments for logs_data_access_rule
+variable "data_logs_data_access_rule_logs_data_access_rule_id" {
+  description = "Array of data access rule IDs."
+  type        = list()
+  default     = ["4f966911-4bda-407e-b069-477394effa59"]
+}
+
+// Data source arguments for logs_data_access_rules
+variable "logs_data_access_rules_logs_data_access_rules_id" {
+  description = "Array of data access rule IDs."
+  type        = list()
+  default     = ["4f966911-4bda-407e-b069-477394effa59"]
+}
+
+
+
+// Data source arguments for logs_data_usage_metrics
+variable "data_logs_data_usage_metrics_range" {
+  description = "Range of days to get the data usage for, by default it will use current month."
+  type        = string
+  default     = "last_week"
+}
+variable "data_logs_data_usage_metrics_query" {
+  description = "Query to filter daily or detailed the data usage, by default it will use daily one."
+  type        = string
+  default     = "daily"
+}
+
+

examples/ibm-logs/variables.tf

@@ -24,7 +24,7 @@ require (
 	github.com/IBM/ibm-hpcs-tke-sdk v0.0.0-20250305134146-e023c2e84762
 	github.com/IBM/ibm-hpcs-uko-sdk v0.0.20-beta
 	github.com/IBM/keyprotect-go-client v0.15.1
-	github.com/IBM/logs-go-sdk v0.4.0
+	github.com/IBM/logs-go-sdk v0.5.0
 	github.com/IBM/logs-router-go-sdk v1.0.8
 	github.com/IBM/mqcloud-go-sdk v0.4.0
 	github.com/IBM/networking-go-sdk v0.51.12

go.mod

@@ -140,8 +140,8 @@ github.com/IBM/ibm-hpcs-uko-sdk v0.0.20-beta/go.mod h1:MLVNHMYoKsvovJZ4v1gQCpIYt
 github.com/IBM/keyprotect-go-client v0.5.1/go.mod h1:5TwDM/4FRJq1ZOlwQL1xFahLWQ3TveR88VmL1u3njyI=
 github.com/IBM/keyprotect-go-client v0.15.1 h1:m4qzqF5zOumRxKZ8s7vtK7A/UV/D278L8xpRG+WgT0s=
 github.com/IBM/keyprotect-go-client v0.15.1/go.mod h1:asXtHwL/4uCHA221Vd/7SkXEi2pcRHDzPyyksc1DthE=
-github.com/IBM/logs-go-sdk v0.4.0 h1:CyUjm19EUtcJjf4mxsj6Rc7gkZDT8JEY5rLUIz8Eoag=
-github.com/IBM/logs-go-sdk v0.4.0/go.mod h1:yv/GCXC4/p+MZEeXl4xjZAOMvDAVRwu61WyHZFKFXQM=
+github.com/IBM/logs-go-sdk v0.5.0 h1:p7z106PQFB7e+zPcmqsZ5mx3SRaidEtxGTTqsl5Ksyo=
+github.com/IBM/logs-go-sdk v0.5.0/go.mod h1:yv/GCXC4/p+MZEeXl4xjZAOMvDAVRwu61WyHZFKFXQM=
 github.com/IBM/logs-router-go-sdk v1.0.8 h1:MU1TdYNdVbvVTUXeqeYPItu6BoiSV/NMN49ySqE7WIY=
 github.com/IBM/logs-router-go-sdk v1.0.8/go.mod h1:tCN2vFgu5xG0ob9iJcxi5M4bJ6mWmu3nhmRPnvlwev0=
 github.com/IBM/mqcloud-go-sdk v0.4.0 h1:BuZNXA6iYEg5OEPr13CMGrhH0ew4rH/4L56b1nFtA10=

go.sum

@@ -1114,6 +1114,8 @@ func Provider() *schema.Provider {
 			"ibm_logs_data_access_rules":  logs.AddLogsInstanceFields(logs.DataSourceIbmLogsDataAccessRules()),
 			"ibm_logs_stream":             logs.AddLogsInstanceFields(logs.DataSourceIbmLogsStream()),
 			"ibm_logs_streams":            logs.AddLogsInstanceFields(logs.DataSourceIbmLogsStreams()),
+			"ibm_logs_alert_definition":   logs.AddLogsInstanceFields(logs.DataSourceIbmLogsAlertDefinition()),
+			"ibm_logs_alert_definitions":  logs.AddLogsInstanceFields(logs.DataSourceIbmLogsAlertDefinitions()),
 
 			// Logs Router Service
 			"ibm_logs_router_tenants": logsrouting.DataSourceIBMLogsRouterTenants(),
@@ -1786,6 +1788,7 @@ func Provider() *schema.Provider {
 			"ibm_logs_enrichment":         logs.AddLogsInstanceFields(logs.ResourceIbmLogsEnrichment()),
 			"ibm_logs_data_access_rule":   logs.AddLogsInstanceFields(logs.ResourceIbmLogsDataAccessRule()),
 			"ibm_logs_stream":             logs.AddLogsInstanceFields(logs.ResourceIbmLogsStream()),
+			"ibm_logs_alert_definition":   logs.AddLogsInstanceFields(logs.ResourceIbmLogsAlertDefinition()),
 
 			// Logs Router Service
 			"ibm_logs_router_tenant": logsrouting.ResourceIBMLogsRouterTenant(),
@@ -2294,6 +2297,7 @@ func Validator() validate.ValidatorDict {
 				"ibm_logs_enrichment":       logs.ResourceIbmLogsEnrichmentValidator(),
 				"ibm_logs_data_access_rule": logs.ResourceIbmLogsDataAccessRuleValidator(),
 				"ibm_logs_stream":           logs.ResourceIbmLogsStreamValidator(),
+				"ibm_logs_alert_definition": logs.ResourceIbmLogsAlertDefinitionValidator(),
 
 				// Added for Logs Router Service
 				"ibm_logs_router_tenant": logsrouting.ResourceIBMLogsRouterTenantValidator(),