WorkflowAlertConfig

Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.

JSON representation
{
  "alertName": string,
  "metricType": enum (MetricType),
  "thresholdType": enum (ThresholdType),
  "thresholdValue": {
    object (ThresholdValue)
  },
  "durationThresholdMs": string,
  "aggregationPeriod": string,
  "numAggregationPeriods": integer,
  "alertDisabled": boolean,
  "clientId": string,
  "onlyFinalAttempt": boolean,
  "playbookUrl": string,

  // Union field error_or_warning_enum_list can be only one of the following:
  "errorEnumList": {
    object (ErrorEnumList)
  },
  "warningEnumList": {
    object (ErrorEnumList)
  }
  // End of list of possible types for union field error_or_warning_enum_list.
}
Fields
alertName

string

A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.

metricType

enum (MetricType)

thresholdType

enum (ThresholdType)

The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.

thresholdValue

object (ThresholdValue)

The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.

durationThresholdMs

string (int64 format)

Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.

aggregationPeriod

string

For an EXPECTED_MIN threshold, this aggregationPeriod must be lesser than 24 hours.

numAggregationPeriods

integer

For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.

alertDisabled

boolean

Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.

clientId

string

Client associated with this alert configuration.

onlyFinalAttempt

boolean

For either events or tasks, depending on the type of alert, count only final attempts, not retries.

playbookUrl

string

Link to a playbook for resolving the issue that triggered this alert.

Union field error_or_warning_enum_list. The Error or Warning enums for which this alert applies. Warnings use the same values as the Error enum. error_or_warning_enum_list can be only one of the following:
errorEnumList

object (ErrorEnumList)

warningEnumList

object (ErrorEnumList)