oci-monitoring
Advanced tools
Comparing version 2.88.0 to 2.88.1
@@ -106,3 +106,3 @@ /** | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/ChangeAlarmCompartment.ts.html |here} to see how to use ChangeAlarmCompartment API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/ChangeAlarmCompartment.ts.html |here} to see how to use ChangeAlarmCompartment API. | ||
*/ | ||
@@ -125,3 +125,3 @@ changeAlarmCompartment(changeAlarmCompartmentRequest: requests.ChangeAlarmCompartmentRequest): Promise<responses.ChangeAlarmCompartmentResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/CreateAlarm.ts.html |here} to see how to use CreateAlarm API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/CreateAlarm.ts.html |here} to see how to use CreateAlarm API. | ||
*/ | ||
@@ -143,3 +143,3 @@ createAlarm(createAlarmRequest: requests.CreateAlarmRequest): Promise<responses.CreateAlarmResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/CreateAlarmSuppression.ts.html |here} to see how to use CreateAlarmSuppression API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/CreateAlarmSuppression.ts.html |here} to see how to use CreateAlarmSuppression API. | ||
*/ | ||
@@ -162,3 +162,3 @@ createAlarmSuppression(createAlarmSuppressionRequest: requests.CreateAlarmSuppressionRequest): Promise<responses.CreateAlarmSuppressionResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/DeleteAlarm.ts.html |here} to see how to use DeleteAlarm API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/DeleteAlarm.ts.html |here} to see how to use DeleteAlarm API. | ||
*/ | ||
@@ -180,3 +180,3 @@ deleteAlarm(deleteAlarmRequest: requests.DeleteAlarmRequest): Promise<responses.DeleteAlarmResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/DeleteAlarmSuppression.ts.html |here} to see how to use DeleteAlarmSuppression API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/DeleteAlarmSuppression.ts.html |here} to see how to use DeleteAlarmSuppression API. | ||
*/ | ||
@@ -199,3 +199,3 @@ deleteAlarmSuppression(deleteAlarmSuppressionRequest: requests.DeleteAlarmSuppressionRequest): Promise<responses.DeleteAlarmSuppressionResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/GetAlarm.ts.html |here} to see how to use GetAlarm API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/GetAlarm.ts.html |here} to see how to use GetAlarm API. | ||
*/ | ||
@@ -218,3 +218,3 @@ getAlarm(getAlarmRequest: requests.GetAlarmRequest): Promise<responses.GetAlarmResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/GetAlarmHistory.ts.html |here} to see how to use GetAlarmHistory API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/GetAlarmHistory.ts.html |here} to see how to use GetAlarmHistory API. | ||
*/ | ||
@@ -236,3 +236,3 @@ getAlarmHistory(getAlarmHistoryRequest: requests.GetAlarmHistoryRequest): Promise<responses.GetAlarmHistoryResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/GetAlarmSuppression.ts.html |here} to see how to use GetAlarmSuppression API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/GetAlarmSuppression.ts.html |here} to see how to use GetAlarmSuppression API. | ||
*/ | ||
@@ -255,3 +255,3 @@ getAlarmSuppression(getAlarmSuppressionRequest: requests.GetAlarmSuppressionRequest): Promise<responses.GetAlarmSuppressionResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/ListAlarmSuppressions.ts.html |here} to see how to use ListAlarmSuppressions API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/ListAlarmSuppressions.ts.html |here} to see how to use ListAlarmSuppressions API. | ||
*/ | ||
@@ -274,3 +274,3 @@ listAlarmSuppressions(listAlarmSuppressionsRequest: requests.ListAlarmSuppressionsRequest): Promise<responses.ListAlarmSuppressionsResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/ListAlarms.ts.html |here} to see how to use ListAlarms API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/ListAlarms.ts.html |here} to see how to use ListAlarms API. | ||
*/ | ||
@@ -328,3 +328,3 @@ listAlarms(listAlarmsRequest: requests.ListAlarmsRequest): Promise<responses.ListAlarmsResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/ListAlarmsStatus.ts.html |here} to see how to use ListAlarmsStatus API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/ListAlarmsStatus.ts.html |here} to see how to use ListAlarmsStatus API. | ||
*/ | ||
@@ -379,3 +379,3 @@ listAlarmsStatus(listAlarmsStatusRequest: requests.ListAlarmsStatusRequest): Promise<responses.ListAlarmsStatusResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/ListMetrics.ts.html |here} to see how to use ListMetrics API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/ListMetrics.ts.html |here} to see how to use ListMetrics API. | ||
*/ | ||
@@ -450,3 +450,3 @@ listMetrics(listMetricsRequest: requests.ListMetricsRequest): Promise<responses.ListMetricsResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/PostMetricData.ts.html |here} to see how to use PostMetricData API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/PostMetricData.ts.html |here} to see how to use PostMetricData API. | ||
*/ | ||
@@ -469,3 +469,3 @@ postMetricData(postMetricDataRequest: requests.PostMetricDataRequest): Promise<responses.PostMetricDataResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/RemoveAlarmSuppression.ts.html |here} to see how to use RemoveAlarmSuppression API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/RemoveAlarmSuppression.ts.html |here} to see how to use RemoveAlarmSuppression API. | ||
*/ | ||
@@ -490,3 +490,3 @@ removeAlarmSuppression(removeAlarmSuppressionRequest: requests.RemoveAlarmSuppressionRequest): Promise<responses.RemoveAlarmSuppressionResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/RetrieveDimensionStates.ts.html |here} to see how to use RetrieveDimensionStates API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/RetrieveDimensionStates.ts.html |here} to see how to use RetrieveDimensionStates API. | ||
*/ | ||
@@ -508,3 +508,3 @@ retrieveDimensionStates(retrieveDimensionStatesRequest: requests.RetrieveDimensionStatesRequest): Promise<responses.RetrieveDimensionStatesResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/SummarizeAlarmSuppressionHistory.ts.html |here} to see how to use SummarizeAlarmSuppressionHistory API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/SummarizeAlarmSuppressionHistory.ts.html |here} to see how to use SummarizeAlarmSuppressionHistory API. | ||
*/ | ||
@@ -527,3 +527,3 @@ summarizeAlarmSuppressionHistory(summarizeAlarmSuppressionHistoryRequest: requests.SummarizeAlarmSuppressionHistoryRequest): Promise<responses.SummarizeAlarmSuppressionHistoryResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/SummarizeMetricsData.ts.html |here} to see how to use SummarizeMetricsData API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/SummarizeMetricsData.ts.html |here} to see how to use SummarizeMetricsData API. | ||
*/ | ||
@@ -546,3 +546,3 @@ summarizeMetricsData(summarizeMetricsDataRequest: requests.SummarizeMetricsDataRequest): Promise<responses.SummarizeMetricsDataResponse>; | ||
* @throws OciError when an error occurs | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/UpdateAlarm.ts.html |here} to see how to use UpdateAlarm API. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/UpdateAlarm.ts.html |here} to see how to use UpdateAlarm API. | ||
*/ | ||
@@ -549,0 +549,0 @@ updateAlarm(updateAlarmRequest: requests.UpdateAlarmRequest): Promise<responses.UpdateAlarmResponse>; |
@@ -23,2 +23,12 @@ /** | ||
/** | ||
* Customizable alarm summary ({@code alarmSummary} [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). | ||
* Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). | ||
* The alarm summary appears within the body of the alarm message and in responses to | ||
* {@link #listAlarmsStatus(ListAlarmsStatusRequest) listAlarmsStatus} | ||
* {@link #getAlarmHistory(GetAlarmHistoryRequest) getAlarmHistory} and | ||
* {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}. | ||
* | ||
*/ | ||
"alarmSummary": string; | ||
/** | ||
* Indicator of the metric stream associated with the alarm state entry. Includes one or more dimension key-value pairs. | ||
@@ -39,4 +49,3 @@ * | ||
* Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. | ||
* A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. | ||
* Minimum number of characters: 3. Default value is {@code BASE}. For information about alarm overrides, see {@link #alarmOverride(AlarmOverrideRequest) alarmOverride}. | ||
* Default value is {@code BASE}. For information about alarm overrides, see {@link #alarmOverride(AlarmOverrideRequest) alarmOverride}. | ||
* | ||
@@ -43,0 +52,0 @@ */ |
@@ -24,2 +24,12 @@ /** | ||
/** | ||
* Customizable alarm summary ({@code alarmSummary} [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). | ||
* Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). | ||
* The alarm summary appears within the body of the alarm message and in responses to | ||
* {@link #listAlarmsStatus(ListAlarmsStatusRequest) listAlarmsStatus} | ||
* {@link #getAlarmHistory(GetAlarmHistoryRequest) getAlarmHistory} and | ||
* {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}. | ||
* | ||
*/ | ||
"alarmSummary": string; | ||
/** | ||
* Description for this alarm history entry. | ||
@@ -26,0 +36,0 @@ * <p> |
@@ -53,3 +53,5 @@ /** | ||
/** | ||
* The human-readable content of the delivered alarm notification. Oracle recommends providing guidance | ||
* The human-readable content of the delivered alarm notification. | ||
* Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). | ||
* Oracle recommends providing guidance | ||
* to operators for resolving the alarm condition. Consider adding links to standard runbook | ||
@@ -74,3 +76,6 @@ * practices. Avoid entering confidential information. | ||
* interval values are supported for smaller time ranges. You can optionally | ||
* specify dimensions and grouping functions. Supported grouping functions: {@code grouping()}, {@code groupBy()}. | ||
* specify dimensions and grouping functions. | ||
* Also, you can customize the | ||
* [absence detection period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). | ||
* Supported grouping functions: {@code grouping()}, {@code groupBy()}. | ||
* For information about writing MQL expressions, see | ||
@@ -98,3 +103,10 @@ * [Editing the MQL Expression for a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). | ||
----- | ||
* Example of absence alarm with custom absence detection period of 20 hours: | ||
* <p> | ||
----- | ||
* | ||
* CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.absent(20h) | ||
* | ||
* ----- | ||
* | ||
*/ | ||
@@ -101,0 +113,0 @@ "query"?: string; |
@@ -55,4 +55,3 @@ /** | ||
* Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. | ||
* A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. | ||
* Minimum number of characters: 3. Default value is {@code BASE}. For information about alarm overrides, see {@link #alarmOverride(AlarmOverrideRequest) alarmOverride}. | ||
* Default value is {@code BASE}. For information about alarm overrides, see {@link #alarmOverride(AlarmOverrideRequest) alarmOverride}. | ||
* | ||
@@ -70,2 +69,12 @@ */ | ||
/** | ||
* Customizable alarm summary ({@code alarmSummary} [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). | ||
* Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). | ||
* The alarm summary appears within the body of the alarm message and in responses to | ||
* {@link #listAlarmsStatus(ListAlarmsStatusRequest) listAlarmsStatus} | ||
* {@link #getAlarmHistory(GetAlarmHistoryRequest) getAlarmHistory} and | ||
* {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}. | ||
* | ||
*/ | ||
"alarmSummary": string; | ||
/** | ||
* The status of this alarm. | ||
@@ -72,0 +81,0 @@ * Status is collective, across all metric streams in the alarm. |
@@ -169,4 +169,3 @@ /** | ||
* Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. | ||
* A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. | ||
* Minimum number of characters: 3. Default value is {@code BASE}. For information about alarm overrides, see {@link #alarmOverride(AlarmOverrideRequest) alarmOverride}. | ||
* Default value is {@code BASE}. For information about alarm overrides, see {@link #alarmOverride(AlarmOverrideRequest) alarmOverride}. | ||
* | ||
@@ -181,2 +180,36 @@ */ | ||
"notificationVersion"?: string; | ||
/** | ||
* Customizable notification title ({@code title} [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). | ||
* Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). | ||
* The notification title appears as the subject line in a formatted email message and as the title in a Slack message. | ||
* | ||
*/ | ||
"notificationTitle"?: string; | ||
/** | ||
* Customizable slack period to wait for metric ingestion before evaluating the alarm. | ||
* Specify a string in ISO 8601 format ({@code PT10M} for ten minutes or {@code PT1H} | ||
* for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. | ||
* For more information about the slack period, see | ||
* [About the Internal Reset Period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset). | ||
* | ||
*/ | ||
"evaluationSlackDuration"?: string; | ||
/** | ||
* Customizable alarm summary ({@code alarmSummary} [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). | ||
* Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). | ||
* The alarm summary appears within the body of the alarm message and in responses to | ||
* {@link #listAlarmsStatus(ListAlarmsStatusRequest) listAlarmsStatus} | ||
* {@link #getAlarmHistory(GetAlarmHistoryRequest) getAlarmHistory} and | ||
* {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}. | ||
* | ||
*/ | ||
"alarmSummary"?: string; | ||
/** | ||
* Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. 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 ($). | ||
* <p> | ||
Example: {@code frontend-fleet} | ||
* | ||
*/ | ||
"resourceGroup"?: string; | ||
} | ||
@@ -183,0 +216,0 @@ export declare namespace AlarmSummary { |
@@ -92,3 +92,6 @@ /** | ||
* interval values are supported for smaller time ranges. You can optionally | ||
* specify dimensions and grouping functions. Supported grouping functions: {@code grouping()}, {@code groupBy()}. | ||
* specify dimensions and grouping functions. | ||
* Also, you can customize the | ||
* [absence detection period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). | ||
* Supported grouping functions: {@code grouping()}, {@code groupBy()}. | ||
* For information about writing MQL expressions, see | ||
@@ -116,3 +119,10 @@ * [Editing the MQL Expression for a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). | ||
----- | ||
* Example of absence alarm with custom absence detection period of 20 hours: | ||
* <p> | ||
----- | ||
* | ||
* CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.absent(20h) | ||
* | ||
* ----- | ||
* | ||
*/ | ||
@@ -152,3 +162,5 @@ "query": string; | ||
/** | ||
* The human-readable content of the delivered alarm notification. Oracle recommends providing guidance | ||
* The human-readable content of the delivered alarm notification. | ||
* Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). | ||
* Oracle recommends providing guidance | ||
* to operators for resolving the alarm condition. Consider adding links to standard runbook | ||
@@ -236,4 +248,3 @@ * practices. Avoid entering confidential information. | ||
* Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. | ||
* A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. | ||
* Minimum number of characters: 3. Default value is {@code BASE}. For information about alarm overrides, see {@link #alarmOverride(AlarmOverrideRequest) alarmOverride}. | ||
* Default value is {@code BASE}. For information about alarm overrides, see {@link #alarmOverride(AlarmOverrideRequest) alarmOverride}. | ||
* | ||
@@ -249,2 +260,28 @@ */ | ||
/** | ||
* Customizable notification title ({@code title} [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). | ||
* Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). | ||
* The notification title appears as the subject line in a formatted email message and as the title in a Slack message. | ||
* | ||
*/ | ||
"notificationTitle"?: string; | ||
/** | ||
* Customizable slack period to wait for metric ingestion before evaluating the alarm. | ||
* Specify a string in ISO 8601 format ({@code PT10M} for ten minutes or {@code PT1H} | ||
* for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. | ||
* For more information about the slack period, see | ||
* [About the Internal Reset Period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset). | ||
* | ||
*/ | ||
"evaluationSlackDuration"?: string; | ||
/** | ||
* Customizable alarm summary ({@code alarmSummary} [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). | ||
* Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). | ||
* The alarm summary appears within the body of the alarm message and in responses to | ||
* {@link #listAlarmsStatus(ListAlarmsStatusRequest) listAlarmsStatus} | ||
* {@link #getAlarmHistory(GetAlarmHistoryRequest) getAlarmHistory} and | ||
* {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}. | ||
* | ||
*/ | ||
"alarmSummary"?: string; | ||
/** | ||
* The current lifecycle state of the alarm. | ||
@@ -251,0 +288,0 @@ * <p> |
@@ -78,3 +78,6 @@ /** | ||
* interval values are supported for smaller time ranges. You can optionally | ||
* specify dimensions and grouping functions. Supported grouping functions: {@code grouping()}, {@code groupBy()}. | ||
* specify dimensions and grouping functions. | ||
* Also, you can customize the | ||
* [absence detection period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). | ||
* Supported grouping functions: {@code grouping()}, {@code groupBy()}. | ||
* For information about writing MQL expressions, see | ||
@@ -102,3 +105,10 @@ * [Editing the MQL Expression for a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). | ||
----- | ||
* Example of absence alarm with custom absence detection period of 20 hours: | ||
* <p> | ||
----- | ||
* | ||
* CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.absent(20h) | ||
* | ||
* ----- | ||
* | ||
*/ | ||
@@ -138,3 +148,5 @@ "query": string; | ||
/** | ||
* The human-readable content of the delivered alarm notification. Oracle recommends providing guidance | ||
* The human-readable content of the delivered alarm notification. | ||
* Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). | ||
* Oracle recommends providing guidance | ||
* to operators for resolving the alarm condition. Consider adding links to standard runbook | ||
@@ -223,4 +235,3 @@ * practices. Avoid entering confidential information. | ||
* Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. | ||
* A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. | ||
* Minimum number of characters: 3. Default value is {@code BASE}. For information about alarm overrides, see {@link #alarmOverride(AlarmOverrideRequest) alarmOverride}. | ||
* Default value is {@code BASE}. For information about alarm overrides, see {@link #alarmOverride(AlarmOverrideRequest) alarmOverride}. | ||
* | ||
@@ -235,2 +246,28 @@ */ | ||
"notificationVersion"?: string; | ||
/** | ||
* Customizable notification title ({@code title} [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). | ||
* Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). | ||
* The notification title appears as the subject line in a formatted email message and as the title in a Slack message. | ||
* | ||
*/ | ||
"notificationTitle"?: string; | ||
/** | ||
* Customizable slack period to wait for metric ingestion before evaluating the alarm. | ||
* Specify a string in ISO 8601 format ({@code PT10M} for ten minutes or {@code PT1H} | ||
* for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. | ||
* For more information about the slack period, see | ||
* [About the Internal Reset Period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset). | ||
* | ||
*/ | ||
"evaluationSlackDuration"?: string; | ||
/** | ||
* Customizable alarm summary ({@code alarmSummary} [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). | ||
* Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). | ||
* The alarm summary appears within the body of the alarm message and in responses to | ||
* {@link #listAlarmsStatus(ListAlarmsStatusRequest) listAlarmsStatus} | ||
* {@link #getAlarmHistory(GetAlarmHistoryRequest) getAlarmHistory} and | ||
* {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}. | ||
* | ||
*/ | ||
"alarmSummary"?: string; | ||
} | ||
@@ -237,0 +274,0 @@ export declare namespace CreateAlarmDetails { |
@@ -78,3 +78,6 @@ /** | ||
* interval values are supported for smaller time ranges. You can optionally | ||
* specify dimensions and grouping functions. Supported grouping functions: {@code grouping()}, {@code groupBy()}. | ||
* specify dimensions and grouping functions. | ||
* Also, you can customize the | ||
* [absence detection period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). | ||
* Supported grouping functions: {@code grouping()}, {@code groupBy()}. | ||
* For information about writing MQL expressions, see | ||
@@ -102,3 +105,10 @@ * [Editing the MQL Expression for a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). | ||
----- | ||
* Example of absence alarm with custom absence detection period of 20 hours: | ||
* <p> | ||
----- | ||
* | ||
* CpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.absent(20h) | ||
* | ||
* ----- | ||
* | ||
*/ | ||
@@ -138,3 +148,5 @@ "query"?: string; | ||
/** | ||
* The human-readable content of the delivered alarm notification. Oracle recommends providing guidance | ||
* The human-readable content of the delivered alarm notification. | ||
* Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). | ||
* Oracle recommends providing guidance | ||
* to operators for resolving the alarm condition. Consider adding links to standard runbook | ||
@@ -222,4 +234,3 @@ * practices. Avoid entering confidential information. | ||
* Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. | ||
* A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. | ||
* Minimum number of characters: 3. Default value is {@code BASE}. For information about alarm overrides, see {@link #alarmOverride(AlarmOverrideRequest) alarmOverride}. | ||
* Default value is {@code BASE}. For information about alarm overrides, see {@link #alarmOverride(AlarmOverrideRequest) alarmOverride}. | ||
* | ||
@@ -234,2 +245,28 @@ */ | ||
"notificationVersion"?: string; | ||
/** | ||
* Customizable notification title ({@code title} [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). | ||
* Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). | ||
* The notification title appears as the subject line in a formatted email message and as the title in a Slack message. | ||
* | ||
*/ | ||
"notificationTitle"?: string; | ||
/** | ||
* Customizable slack period to wait for metric ingestion before evaluating the alarm. | ||
* Specify a string in ISO 8601 format ({@code PT10M} for ten minutes or {@code PT1H} | ||
* for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. | ||
* For more information about the slack period, see | ||
* [About the Internal Reset Period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset). | ||
* | ||
*/ | ||
"evaluationSlackDuration"?: string; | ||
/** | ||
* Customizable alarm summary ({@code alarmSummary} [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). | ||
* Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). | ||
* The alarm summary appears within the body of the alarm message and in responses to | ||
* {@link #listAlarmsStatus(ListAlarmsStatusRequest) listAlarmsStatus} | ||
* {@link #getAlarmHistory(GetAlarmHistoryRequest) getAlarmHistory} and | ||
* {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}. | ||
* | ||
*/ | ||
"alarmSummary"?: string; | ||
} | ||
@@ -236,0 +273,0 @@ export declare namespace UpdateAlarmDetails { |
@@ -16,3 +16,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/ChangeAlarmCompartment.ts.html |here} to see how to use ChangeAlarmCompartmentRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/ChangeAlarmCompartment.ts.html |here} to see how to use ChangeAlarmCompartmentRequest. | ||
*/ | ||
@@ -19,0 +19,0 @@ export interface ChangeAlarmCompartmentRequest extends common.BaseRequest { |
@@ -16,3 +16,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/CreateAlarm.ts.html |here} to see how to use CreateAlarmRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/CreateAlarm.ts.html |here} to see how to use CreateAlarmRequest. | ||
*/ | ||
@@ -19,0 +19,0 @@ export interface CreateAlarmRequest extends common.BaseRequest { |
@@ -16,3 +16,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/CreateAlarmSuppression.ts.html |here} to see how to use CreateAlarmSuppressionRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/CreateAlarmSuppression.ts.html |here} to see how to use CreateAlarmSuppressionRequest. | ||
*/ | ||
@@ -19,0 +19,0 @@ export interface CreateAlarmSuppressionRequest extends common.BaseRequest { |
@@ -15,3 +15,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/DeleteAlarm.ts.html |here} to see how to use DeleteAlarmRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/DeleteAlarm.ts.html |here} to see how to use DeleteAlarmRequest. | ||
*/ | ||
@@ -18,0 +18,0 @@ export interface DeleteAlarmRequest extends common.BaseRequest { |
@@ -15,3 +15,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/DeleteAlarmSuppression.ts.html |here} to see how to use DeleteAlarmSuppressionRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/DeleteAlarmSuppression.ts.html |here} to see how to use DeleteAlarmSuppressionRequest. | ||
*/ | ||
@@ -18,0 +18,0 @@ export interface DeleteAlarmSuppressionRequest extends common.BaseRequest { |
@@ -15,3 +15,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/GetAlarmHistory.ts.html |here} to see how to use GetAlarmHistoryRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/GetAlarmHistory.ts.html |here} to see how to use GetAlarmHistoryRequest. | ||
*/ | ||
@@ -18,0 +18,0 @@ export interface GetAlarmHistoryRequest extends common.BaseRequest { |
@@ -15,3 +15,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/GetAlarm.ts.html |here} to see how to use GetAlarmRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/GetAlarm.ts.html |here} to see how to use GetAlarmRequest. | ||
*/ | ||
@@ -18,0 +18,0 @@ export interface GetAlarmRequest extends common.BaseRequest { |
@@ -15,3 +15,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/GetAlarmSuppression.ts.html |here} to see how to use GetAlarmSuppressionRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/GetAlarmSuppression.ts.html |here} to see how to use GetAlarmSuppressionRequest. | ||
*/ | ||
@@ -18,0 +18,0 @@ export interface GetAlarmSuppressionRequest extends common.BaseRequest { |
@@ -15,3 +15,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/ListAlarmSuppressions.ts.html |here} to see how to use ListAlarmSuppressionsRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/ListAlarmSuppressions.ts.html |here} to see how to use ListAlarmSuppressionsRequest. | ||
*/ | ||
@@ -18,0 +18,0 @@ export interface ListAlarmSuppressionsRequest extends common.BaseRequest { |
@@ -15,3 +15,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/ListAlarms.ts.html |here} to see how to use ListAlarmsRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/ListAlarms.ts.html |here} to see how to use ListAlarmsRequest. | ||
*/ | ||
@@ -18,0 +18,0 @@ export interface ListAlarmsRequest extends common.BaseRequest { |
@@ -15,3 +15,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/ListAlarmsStatus.ts.html |here} to see how to use ListAlarmsStatusRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/ListAlarmsStatus.ts.html |here} to see how to use ListAlarmsStatusRequest. | ||
*/ | ||
@@ -18,0 +18,0 @@ export interface ListAlarmsStatusRequest extends common.BaseRequest { |
@@ -16,3 +16,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/ListMetrics.ts.html |here} to see how to use ListMetricsRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/ListMetrics.ts.html |here} to see how to use ListMetricsRequest. | ||
*/ | ||
@@ -19,0 +19,0 @@ export interface ListMetricsRequest extends common.BaseRequest { |
@@ -16,3 +16,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/PostMetricData.ts.html |here} to see how to use PostMetricDataRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/PostMetricData.ts.html |here} to see how to use PostMetricDataRequest. | ||
*/ | ||
@@ -19,0 +19,0 @@ export interface PostMetricDataRequest extends common.BaseRequest { |
@@ -15,3 +15,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/RemoveAlarmSuppression.ts.html |here} to see how to use RemoveAlarmSuppressionRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/RemoveAlarmSuppression.ts.html |here} to see how to use RemoveAlarmSuppressionRequest. | ||
*/ | ||
@@ -18,0 +18,0 @@ export interface RemoveAlarmSuppressionRequest extends common.BaseRequest { |
@@ -16,3 +16,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/RetrieveDimensionStates.ts.html |here} to see how to use RetrieveDimensionStatesRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/RetrieveDimensionStates.ts.html |here} to see how to use RetrieveDimensionStatesRequest. | ||
*/ | ||
@@ -19,0 +19,0 @@ export interface RetrieveDimensionStatesRequest extends common.BaseRequest { |
@@ -16,3 +16,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/SummarizeAlarmSuppressionHistory.ts.html |here} to see how to use SummarizeAlarmSuppressionHistoryRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/SummarizeAlarmSuppressionHistory.ts.html |here} to see how to use SummarizeAlarmSuppressionHistoryRequest. | ||
*/ | ||
@@ -19,0 +19,0 @@ export interface SummarizeAlarmSuppressionHistoryRequest extends common.BaseRequest { |
@@ -16,3 +16,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/SummarizeMetricsData.ts.html |here} to see how to use SummarizeMetricsDataRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/SummarizeMetricsData.ts.html |here} to see how to use SummarizeMetricsDataRequest. | ||
*/ | ||
@@ -19,0 +19,0 @@ export interface SummarizeMetricsDataRequest extends common.BaseRequest { |
@@ -16,3 +16,3 @@ /** | ||
/** | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.0/monitoring/UpdateAlarm.ts.html |here} to see how to use UpdateAlarmRequest. | ||
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.88.1/monitoring/UpdateAlarm.ts.html |here} to see how to use UpdateAlarmRequest. | ||
*/ | ||
@@ -19,0 +19,0 @@ export interface UpdateAlarmRequest extends common.BaseRequest { |
{ | ||
"name": "oci-monitoring", | ||
"version": "2.88.0", | ||
"version": "2.88.1", | ||
"description": "OCI NodeJS client for Monitoring", | ||
@@ -18,4 +18,4 @@ "repository": { | ||
"dependencies": { | ||
"oci-common": "2.88.0", | ||
"oci-workrequests": "2.88.0" | ||
"oci-common": "2.88.1", | ||
"oci-workrequests": "2.88.1" | ||
}, | ||
@@ -22,0 +22,0 @@ "publishConfig": { |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
563717
9447
+ Addedoci-common@2.88.1(transitive)
+ Addedoci-workrequests@2.88.1(transitive)
- Removedoci-common@2.88.0(transitive)
- Removedoci-workrequests@2.88.0(transitive)
Updatedoci-common@2.88.1
Updatedoci-workrequests@2.88.1