Skip to content

Commit 8133fc1

Browse files
rcohenmaalexng-canuck
authored andcommitted
updates to monitoring docs
1 parent be53359 commit 8133fc1

7 files changed

+26
-26
lines changed

oci/monitoring_alarm_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ var (
4646
"namespace": Representation{repType: Required, create: `oci_computeagent`, update: `oci_lbaas`},
4747
"query": Representation{repType: Required, create: `CpuUtilization[10m].percentile(0.9) < 85`, update: `AcceptedConnections[10m].count() <= 0`},
4848
"severity": Representation{repType: Required, create: `WARNING`, update: `INFO`},
49-
"body": Representation{repType: Optional, create: `High CPU utilization reached`, update: `body2`},
49+
"body": Representation{repType: Optional, create: `CPU utilization has reached high values.`, update: `body2`},
5050
"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")}`},
5151
"freeform_tags": Representation{repType: Optional, create: map[string]string{"Department": "Finance"}, update: map[string]string{"Department": "Accounting"}},
5252
"metric_compartment_id_in_subtree": Representation{repType: Optional, create: `false`, update: `true`},
@@ -116,7 +116,7 @@ func TestMonitoringAlarmResource_basic(t *testing.T) {
116116
Config: config + compartmentIdVariableStr + AlarmResourceDependencies +
117117
generateResourceFromRepresentationMap("oci_monitoring_alarm", "test_alarm", Optional, Create, alarmRepresentation),
118118
Check: resource.ComposeAggregateTestCheckFunc(
119-
resource.TestCheckResourceAttr(resourceName, "body", "High CPU utilization reached"),
119+
resource.TestCheckResourceAttr(resourceName, "body", "CPU utilization has reached high values."),
120120
resource.TestCheckResourceAttr(resourceName, "compartment_id", compartmentId),
121121
resource.TestCheckResourceAttr(resourceName, "defined_tags.%", "1"),
122122
resource.TestCheckResourceAttr(resourceName, "destinations.#", "1"),

website/docs/d/monitoring_alarm.html.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ The following attributes are exported:
8585
Oracle recommends including tracking information for the event or associated work, such as a ticket number.
8686

8787
Example: `Planned outage due to change IT-1234.`
88-
* `time_suppress_from` - The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2018-02-01T01:02:29.600Z`
89-
* `time_suppress_until` - The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2018-02-01T02:02:29.600Z`
90-
* `time_created` - The date and time the alarm was created. Format defined by RFC3339. Example: `2018-02-01T01:02:29.600Z`
91-
* `time_updated` - The date and time the alarm was last updated. Format defined by RFC3339. Example: `2018-02-03T01:02:29.600Z`
88+
* `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`
89+
* `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`
90+
* `time_created` - The date and time the alarm was created. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z`
91+
* `time_updated` - The date and time the alarm was last updated. Format defined by RFC3339. Example: `2019-02-03T01:02:29.600Z`
9292

website/docs/d/monitoring_alarm_history_collection.html.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ The following arguments are supported:
3232

3333
* `alarm_historytype` - (Optional) The type of history entries to retrieve. State history (STATE_HISTORY) or state transition history (STATE_TRANSITION_HISTORY). If not specified, entries of both types are retrieved. Example: `STATE_HISTORY`
3434
* `alarm_id` - (Required) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.
35-
* `timestamp_greater_than_or_equal_to` - (Optional) A filter to return only alarm history entries with timestamps occurring on or after the specified date and time. Format defined by RFC3339. Example: `2018-01-01T01:00:00.000Z`
36-
* `timestamp_less_than` - (Optional) A filter to return only alarm history entries with timestamps occurring before the specified date and time. Format defined by RFC3339. Example: `2018-01-02T01:00:00.000Z`
35+
* `timestamp_greater_than_or_equal_to` - (Optional) A filter to return only alarm history entries with timestamps occurring on or after the specified date and time. Format defined by RFC3339. Example: `2019-01-01T01:00:00.789Z`
36+
* `timestamp_less_than` - (Optional) A filter to return only alarm history entries with timestamps occurring before the specified date and time. Format defined by RFC3339. Example: `2019-01-02T01:00:00.789Z`
3737

3838

3939
## Attributes Reference
@@ -47,7 +47,7 @@ The following attributes are exported:
4747
Example 1 - alarm state history entry: `The alarm state is FIRING`
4848

4949
Example 2 - alarm state transition history entry: `State transitioned from OK to Firing`
50-
* `timestamp` - Timestamp for this alarm history entry. Format defined by RFC3339. Example: `2018-02-01T01:02:29.600Z`
51-
* `timestamp_triggered` - Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Available for state transition entries only. Note: A three-minute lag for this value accounts for any late-arriving metrics. Example: `2018-02-01T0:59:00.000Z`
50+
* `timestamp` - Timestamp for this alarm history entry. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z`
51+
* `timestamp_triggered` - Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Available for state transition entries only. Note: A three-minute lag for this value accounts for any late-arriving metrics. Example: `2019-02-01T0:59:00.789Z`
5252
* `is_enabled` - Whether the alarm is enabled. Example: `true`
5353

website/docs/d/monitoring_alarm_statuses.html.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The following attributes are exported:
5454
Oracle recommends including tracking information for the event or associated work, such as a ticket number.
5555

5656
Example: `Planned outage due to change IT-1234.`
57-
* `time_suppress_from` - The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2018-02-01T01:02:29.600Z`
58-
* `time_suppress_until` - The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2018-02-01T02:02:29.600Z`
59-
* `timestamp_triggered` - Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Example: `2018-02-01T01:02:29.600Z`
57+
* `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`
58+
* `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`
59+
* `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`
6060

website/docs/d/monitoring_alarms.html.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ The following attributes are exported:
9999
Oracle recommends including tracking information for the event or associated work, such as a ticket number.
100100

101101
Example: `Planned outage due to change IT-1234.`
102-
* `time_suppress_from` - The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2018-02-01T01:02:29.600Z`
103-
* `time_suppress_until` - The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2018-02-01T02:02:29.600Z`
104-
* `time_created` - The date and time the alarm was created. Format defined by RFC3339. Example: `2018-02-01T01:02:29.600Z`
105-
* `time_updated` - The date and time the alarm was last updated. Format defined by RFC3339. Example: `2018-02-03T01:02:29.600Z`
102+
* `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`
103+
* `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`
104+
* `time_created` - The date and time the alarm was created. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z`
105+
* `time_updated` - The date and time the alarm was last updated. Format defined by RFC3339. Example: `2019-02-03T01:02:29.600Z`
106106

website/docs/d/monitoring_metric_data.html.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ The following arguments are supported:
3636

3737
* `compartment_id` - (Required) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.
3838
* `compartment_id_in_subtree` - (Optional) When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId 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, returns resources from only the compartment specified in compartmentId. Default is false.
39-
* `end_time` - (Optional) The end of the time range to use when searching for metric data points. Format is defined by RFC3339. The response excludes metric data points for the endTime. Default value: the timestamp representing when the call was sent. Example: `2018-02-01T02:02:29.600Z`
39+
* `end_time` - (Optional) The end of the time range to use when searching for metric data points. Format is defined by RFC3339. The response excludes metric data points for the endTime. Default value: the timestamp representing when the call was sent. Example: `2019-02-01T02:02:29.600Z`
4040
* `namespace` - (Required) The source service or application to use when searching for metric data points to aggregate. Example: `oci_computeagent`
4141
* `query` - (Required) The Monitoring Query Language (MQL) expression to use when searching for metric data points to aggregate. The query must specify a metric, statistic, and interval. 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). Example: `CpuUtilization[1m].sum()`
4242
* `resolution` - (Optional) The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. For example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency. The resolution must be equal or less than the interval in the query. The default resolution is 1m (one minute). Supported values: `1m`-`60m` (also `1h`). Example: `5m`
43-
* `start_time` - (Optional) The beginning of the time range to use when searching for metric data points. Format is defined by RFC3339. The response includes metric data points for the startTime. Default value: the timestamp 3 hours before the call was sent. Example: `2018-02-01T01:02:29.600Z`
43+
* `start_time` - (Optional) The beginning of the time range to use when searching for metric data points. Format is defined by RFC3339. The response includes metric data points for the startTime. Default value: the timestamp 3 hours before the call was sent. Example: `2019-02-01T01:02:29.600Z`
4444

4545

4646
## Attributes Reference
@@ -54,7 +54,7 @@ The following attributes are exported:
5454
The following attributes are exported:
5555

5656
* `aggregated_datapoints` - The list of timestamp-value pairs returned for the specified request. Metric values are rolled up to the start time specified in the request.
57-
* `timestamp` - The date and time associated with the value of this data point. Format defined by RFC3339. Example: `2018-02-01T01:02:29.600Z`
57+
* `timestamp` - The date and time associated with the value of this data point. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z`
5858
* `value` - Numeric value of the metric. Example: `10.4`
5959
* `compartment_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources from which the aggregated data was returned.
6060
* `dimensions` - Qualifiers provided in the definition of the returned metric. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. Example: `"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"`

website/docs/r/monitoring_alarm.html.markdown

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@ The following arguments are supported:
100100
Oracle recommends including tracking information for the event or associated work, such as a ticket number.
101101

102102
Example: `Planned outage due to change IT-1234.`
103-
* `time_suppress_from` - (Required) (Updatable) The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2018-02-01T01:02:29.600Z`
104-
* `time_suppress_until` - (Required) (Updatable) The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2018-02-01T02:02:29.600Z`
103+
* `time_suppress_from` - (Required) (Updatable) The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z`
104+
* `time_suppress_until` - (Required) (Updatable) The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2019-02-01T02:02:29.600Z`
105105

106106

107107
** IMPORTANT **
@@ -164,10 +164,10 @@ The following attributes are exported:
164164
Oracle recommends including tracking information for the event or associated work, such as a ticket number.
165165

166166
Example: `Planned outage due to change IT-1234.`
167-
* `time_suppress_from` - The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2018-02-01T01:02:29.600Z`
168-
* `time_suppress_until` - The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2018-02-01T02:02:29.600Z`
169-
* `time_created` - The date and time the alarm was created. Format defined by RFC3339. Example: `2018-02-01T01:02:29.600Z`
170-
* `time_updated` - The date and time the alarm was last updated. Format defined by RFC3339. Example: `2018-02-03T01:02:29.600Z`
167+
* `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`
168+
* `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`
169+
* `time_created` - The date and time the alarm was created. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z`
170+
* `time_updated` - The date and time the alarm was last updated. Format defined by RFC3339. Example: `2019-02-03T01:02:29.600Z`
171171

172172
## Import
173173

0 commit comments

Comments
 (0)