Stackdriver Monitoring V3 Client - Class MonitoringQueryLanguageCondition (1.6.0)

Reference documentation and code samples for the Stackdriver Monitoring V3 Client class MonitoringQueryLanguageCondition.

A condition type that allows alert policies to be defined using Monitoring Query Language.

Generated from protobuf message google.monitoring.v3.AlertPolicy.Condition.MonitoringQueryLanguageCondition

Namespace

Google \ Cloud \ Monitoring \ V3 \ AlertPolicy \ Condition

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ query string

Monitoring Query Language query that outputs a boolean stream.

↳ duration Google\Protobuf\Duration

The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.

↳ trigger Google\Cloud\Monitoring\V3\AlertPolicy\Condition\Trigger

The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified.

↳ evaluation_missing_data int

A condition control that determines how metric-threshold conditions are evaluated when data stops arriving.

getQuery

Monitoring Query Language query that outputs a boolean stream.

Returns
TypeDescription
string

setQuery

Monitoring Query Language query that outputs a boolean stream.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDuration

The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasDuration

clearDuration

setDuration

The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getTrigger

The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified.

Returns
TypeDescription
Google\Cloud\Monitoring\V3\AlertPolicy\Condition\Trigger|null

hasTrigger

clearTrigger

setTrigger

The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified.

Parameter
NameDescription
var Google\Cloud\Monitoring\V3\AlertPolicy\Condition\Trigger
Returns
TypeDescription
$this

getEvaluationMissingData

A condition control that determines how metric-threshold conditions are evaluated when data stops arriving.

Returns
TypeDescription
int

setEvaluationMissingData

A condition control that determines how metric-threshold conditions are evaluated when data stops arriving.

Parameter
NameDescription
var int
Returns
TypeDescription
$this