Publisher Map feature Monitoring added to Email

Author: srishtipmishra

examples/monitoring/alarms/alarms.tf

@@ -49,6 +49,10 @@ variable "alarm_is_enabled" {
   default = false
 }
 
+variable "alarm_message_format" {
+  default = "ONS_OPTIMIZED"
+}
+
 variable "alarm_metric_compartment_id_in_subtree" {
   default = false
 }
@@ -157,6 +161,7 @@ resource "oci_monitoring_alarm" "test_alarm" {
 
   #Optional
   body                             = var.alarm_body
+  message_format                   = var.alarm_message_format
   metric_compartment_id_in_subtree = var.alarm_metric_compartment_id_in_subtree
   pending_duration                 = var.alarm_pending_duration
   repeat_notification_duration     = var.alarm_repeat_notification_duration

oci/monitoring_alarm_data_source.go

@@ -91,6 +91,8 @@ func (s *MonitoringAlarmDataSourceCrud) SetData() error {
 		s.D.Set("is_enabled", *s.Res.IsEnabled)
 	}
 
+	s.D.Set("message_format", s.Res.MessageFormat)
+
 	if s.Res.MetricCompartmentId != nil {
 		s.D.Set("metric_compartment_id", *s.Res.MetricCompartmentId)
 	}

oci/monitoring_alarm_resource.go

@@ -85,6 +85,11 @@ func MonitoringAlarmResource() *schema.Resource {
 				Computed: true,
 				Elem:     schema.TypeString,
 			},
+			"message_format": {
+				Type:     schema.TypeString,
+				Optional: true,
+				Computed: true,
+			},
 			"metric_compartment_id_in_subtree": {
 				Type:     schema.TypeBool,
 				Optional: true,
@@ -273,6 +278,10 @@ func (s *MonitoringAlarmResourceCrud) Create() error {
 		request.IsEnabled = &tmp
 	}
 
+	if messageFormat, ok := s.D.GetOkExists("message_format"); ok {
+		request.MessageFormat = oci_monitoring.CreateAlarmDetailsMessageFormatEnum(messageFormat.(string))
+	}
+
 	if metricCompartmentId, ok := s.D.GetOkExists("metric_compartment_id"); ok {
 		tmp := metricCompartmentId.(string)
 		request.MetricCompartmentId = &tmp
@@ -416,6 +425,10 @@ func (s *MonitoringAlarmResourceCrud) Update() error {
 		request.IsEnabled = &tmp
 	}
 
+	if messageFormat, ok := s.D.GetOkExists("message_format"); ok {
+		request.MessageFormat = oci_monitoring.UpdateAlarmDetailsMessageFormatEnum(messageFormat.(string))
+	}
+
 	if metricCompartmentId, ok := s.D.GetOkExists("metric_compartment_id"); ok {
 		tmp := metricCompartmentId.(string)
 		request.MetricCompartmentId = &tmp
@@ -519,6 +532,8 @@ func (s *MonitoringAlarmResourceCrud) SetData() error {
 		s.D.Set("is_enabled", *s.Res.IsEnabled)
 	}
 
+	s.D.Set("message_format", s.Res.MessageFormat)
+
 	if s.Res.MetricCompartmentId != nil {
 		s.D.Set("metric_compartment_id", *s.Res.MetricCompartmentId)
 	}

oci/monitoring_alarm_test.go

@@ -53,6 +53,7 @@ var (
 		"body":                             Representation{repType: Optional, create: `CPU utilization has reached high values.`, update: `body2`},
 		"defined_tags":                     Representation{repType: Optional, create: `${map("${oci_identity_tag_namespace.tag-namespace1.name}.${oci_identity_tag.tag1.name}", "value")}`, update: `${map("${oci_identity_tag_namespace.tag-namespace1.name}.${oci_identity_tag.tag1.name}", "updatedValue")}`},
 		"freeform_tags":                    Representation{repType: Optional, create: map[string]string{"Department": "Finance"}, update: map[string]string{"Department": "Accounting"}},
+		"message_format":                   Representation{repType: Optional, create: `ONS_OPTIMIZED`, update: `PRETTY_JSON`},
 		"metric_compartment_id_in_subtree": Representation{repType: Optional, create: `false`, update: `true`},
 		"pending_duration":                 Representation{repType: Optional, create: `PT5M`, update: `PT10M`},
 		"repeat_notification_duration":     Representation{repType: Optional, create: `PT2H`, update: `PT10M`},
@@ -132,6 +133,7 @@ func TestMonitoringAlarmResource_basic(t *testing.T) {
 				resource.TestCheckResourceAttr(resourceName, "freeform_tags.%", "1"),
 				resource.TestCheckResourceAttrSet(resourceName, "id"),
 				resource.TestCheckResourceAttr(resourceName, "is_enabled", "false"),
+				resource.TestCheckResourceAttr(resourceName, "message_format", "ONS_OPTIMIZED"),
 				resource.TestCheckResourceAttrSet(resourceName, "metric_compartment_id"),
 				resource.TestCheckResourceAttr(resourceName, "metric_compartment_id_in_subtree", "false"),
 				resource.TestCheckResourceAttr(resourceName, "namespace", "oci_computeagent"),
@@ -177,6 +179,7 @@ func TestMonitoringAlarmResource_basic(t *testing.T) {
 				resource.TestCheckResourceAttr(resourceName, "freeform_tags.%", "1"),
 				resource.TestCheckResourceAttrSet(resourceName, "id"),
 				resource.TestCheckResourceAttr(resourceName, "is_enabled", "false"),
+				resource.TestCheckResourceAttr(resourceName, "message_format", "ONS_OPTIMIZED"),
 				resource.TestCheckResourceAttrSet(resourceName, "metric_compartment_id"),
 				resource.TestCheckResourceAttr(resourceName, "metric_compartment_id_in_subtree", "false"),
 				resource.TestCheckResourceAttr(resourceName, "namespace", "oci_computeagent"),
@@ -217,6 +220,7 @@ func TestMonitoringAlarmResource_basic(t *testing.T) {
 				resource.TestCheckResourceAttr(resourceName, "freeform_tags.%", "1"),
 				resource.TestCheckResourceAttrSet(resourceName, "id"),
 				resource.TestCheckResourceAttr(resourceName, "is_enabled", "true"),
+				resource.TestCheckResourceAttr(resourceName, "message_format", "PRETTY_JSON"),
 				resource.TestCheckResourceAttrSet(resourceName, "metric_compartment_id"),
 				resource.TestCheckResourceAttr(resourceName, "metric_compartment_id_in_subtree", "true"),
 				resource.TestCheckResourceAttr(resourceName, "namespace", "oci_lbaas"),
@@ -291,6 +295,7 @@ func TestMonitoringAlarmResource_basic(t *testing.T) {
 				resource.TestCheckResourceAttr(singularDatasourceName, "freeform_tags.%", "1"),
 				resource.TestCheckResourceAttrSet(singularDatasourceName, "id"),
 				resource.TestCheckResourceAttr(singularDatasourceName, "is_enabled", "true"),
+				resource.TestCheckResourceAttr(singularDatasourceName, "message_format", "PRETTY_JSON"),
 				resource.TestCheckResourceAttr(singularDatasourceName, "metric_compartment_id_in_subtree", "true"),
 				resource.TestCheckResourceAttr(singularDatasourceName, "namespace", "oci_lbaas"),
 				resource.TestCheckResourceAttr(singularDatasourceName, "pending_duration", "PT10M"),

website/docs/d/monitoring_alarm.html.markdown

@@ -13,8 +13,8 @@ This data source provides details about a specific Alarm resource in Oracle Clou
 Gets the specified alarm.
 For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).
 
-This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. 
-Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, 
+This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
+Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
 or transactions, per second (TPS) for a given tenancy.
 
 
@@ -38,31 +38,35 @@ The following arguments are supported:
 
 The following attributes are exported:
 
-* `body` - The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information.  Example: `High CPU usage alert. Follow runbook instructions for resolution.` 
+* `body` - The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices.  Example: `High CPU usage alert. Follow runbook instructions for resolution.` 
 * `compartment_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm. 
 * `defined_tags` - Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}` 
-* `destinations` - A list of destinations to which the notifications for this alarm will be delivered.  Each destination is represented by an [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID.  Supported destination services: Notifications Service. Limit: One destination per supported destination service. 
-* `display_name` - A user-friendly name for the alarm. It does not have to be unique, and it's changeable. Avoid entering confidential information.
+* `destinations` - A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service. 
+* `display_name` - A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
 
 	This name is sent as the title for notifications related to this alarm.
 
 	Example: `High CPU Utilization` 
 * `freeform_tags` - Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}` 
 * `id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm. 
 * `is_enabled` - Whether the alarm is enabled.  Example: `true` 
+* `message_format` - The format to use for notification messages sent from this alarm. The formats are:
+	* `RAW` - Raw JSON blob. Default value.
+	* `PRETTY_JSON`: JSON with new lines and indents.
+	* `ONS_OPTIMIZED`: Simplified, user-friendly layout. Applies only to messages sent through the Notifications service to the following subscription types: Email. 
 * `metric_compartment_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm. 
 * `metric_compartment_id_in_subtree` - When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false.  Example: `true` 
 * `namespace` - The source service or application emitting the metric that is evaluated by the alarm.  Example: `oci_computeagent` 
-* `pending_duration` - The period of time that the condition defined in the alarm must persist before the alarm state  changes from "OK" to "FIRING". For example, a value of 5 minutes means that the  alarm must persist in breaching the condition for five minutes before the alarm updates its  state to "FIRING". 
+* `pending_duration` - The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
 
 	The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M.
 
-	Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to "FIRING". 
+	Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to "FIRING".
 
-	The alarm updates its status to "OK" when the breaching condition has been clear for  the most recent minute. 
+	The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute.
 
 	Example: `PT5M` 
-* `query` - The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of  the Monitoring service interprets results for each returned time series as Boolean values,  where zero represents false and a non-zero value represents true. A true value means that the trigger  rule condition has been met. The query must specify a metric, statistic, interval, and trigger  rule (threshold or absence). Supported values for interval: `1m`-`60m` (also `1h`). You can optionally  specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`.  For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm).  For available dimensions, review the metric definition for the supported service.  See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
+* `query` - The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
 
 	Example of threshold alarm:
 
@@ -85,7 +89,7 @@ The following attributes are exported:
 
 	Example: `PT2H` 
 * `resolution` - The time between calculated aggregation windows for the alarm. Supported value: `1m` 
-* `resource_group` - Resource group specified as a filter for metric data retrieved by the alarm. A resource group is a custom string that can be used as a filter. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Avoid entering confidential information.  Example: `frontend-fleet` 
+* `resource_group` - Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).  Example: `frontend-fleet` 
 * `severity` - The perceived type of response required when the alarm is in the "FIRING" state.  Example: `CRITICAL` 
 * `state` - The current lifecycle state of the alarm.  Example: `DELETED` 
 * `suppression` - The configuration details for suppressing an alarm. 

website/docs/d/monitoring_alarm_history_collection.html.markdown

@@ -13,8 +13,8 @@ This data source provides details about a specific Alarm History Collection reso
 Get the history of the specified alarm.
 For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).
 
-This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. 
-Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, 
+This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
+Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
 or transactions, per second (TPS) for a given tenancy.
 
 
@@ -48,7 +48,7 @@ The following attributes are exported:
 
 * `alarm_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm for which to retrieve history. 
 * `entries` - The set of history entries retrieved for the alarm. 
-	* `summary` - Description for this alarm history entry. Avoid entering confidential information.
+	* `summary` - Description for this alarm history entry.
 
 		Example 1 - alarm state history entry: `The alarm state is FIRING`
 

website/docs/d/monitoring_alarm_statuses.html.markdown

@@ -13,8 +13,8 @@ This data source provides the list of Alarm Statuses in Oracle Cloud Infrastruct
 List the status of each alarm in the specified compartment.
 For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).
 
-This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. 
-Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, 
+This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
+Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
 or transactions, per second (TPS) for a given tenancy.
 
 
@@ -62,5 +62,5 @@ The following attributes are exported:
 		Example: `Planned outage due to change IT-1234.` 
 	* `time_suppress_from` - The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z` 
 	* `time_suppress_until` - The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-02-01T02:02:29.600Z` 
-* `timestamp_triggered` - Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing.  Example: `2019-02-01T01:02:29.600Z` 
+* `timestamp_triggered` - Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Note: A three-minute lag for this value accounts for any late-arriving metrics.  Example: `2019-02-01T01:02:29.600Z`