com.oracle.bmc.monitoring.model

Class AlarmOverride.Builder

java.lang.Object

com.oracle.bmc.monitoring.model.AlarmOverride.Builder

Enclosing class:

AlarmOverride

public static class AlarmOverride.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AlarmOverride.Builder	body(String body) The human-readable content of the delivered alarm notification.
AlarmOverride	build()
AlarmOverride.Builder	copy(AlarmOverride model)
AlarmOverride.Builder	pendingDuration(String pendingDuration) The period of time that the condition defined in the alarm must persist before the alarm state changes from “OK” to “FIRING”.
AlarmOverride.Builder	query(String query) The Monitoring Query Language (MQL) expression to evaluate for the alarm.
AlarmOverride.Builder	ruleName(String ruleName) A user-friendly description for this alarm override.
AlarmOverride.Builder	severity(Alarm.Severity severity) The perceived severity of the alarm with regard to the affected system.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

pendingDuration

public AlarmOverride.Builder pendingDuration(String pendingDuration)

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".

The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute.

Example: PT5M

Parameters:

pendingDuration - the value to set

Returns:

this builder

severity

public AlarmOverride.Builder severity(Alarm.Severity severity)

The perceived severity of the alarm with regard to the affected system.

Example: CRITICAL

Parameters:

severity - the value to set

Returns:

this builder

body

public AlarmOverride.Builder body(String body)

The human-readable content of the delivered alarm notification. Optionally include dynamic variables. 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.

Parameters:

body - the value to set

Returns:

this builder

ruleName

public AlarmOverride.Builder ruleName(String ruleName)

A user-friendly description for this alarm override. Must be unique across all ruleName values for the alarm.

Parameters:

ruleName - the value to set

Returns:

this builder

query

public AlarmOverride.Builder query(String 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. Also, you can customize the absence detection period. Supported grouping functions: grouping(), groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.

Example of threshold alarm:

-----

CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85

-----

Example of absence alarm:

-----

CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()

----- Example of absence alarm with custom absence detection period of 20 hours:

-----

CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h)

-----

Parameters:

query - the value to set

Returns:

this builder

build

public AlarmOverride build()

copy

public AlarmOverride.Builder copy(AlarmOverride model)