EnterpriseCrmEventbusProtoWorkflowAlertConfig

import type { EnterpriseCrmEventbusProtoWorkflowAlertConfig } from "https://googleapis.deno.dev/v1/integrations:v1.ts";

Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.

interface EnterpriseCrmEventbusProtoWorkflowAlertConfig {

aggregationPeriod?: string;

alertDisabled?: boolean;

alertName?: string;

clientId?: string;

durationThresholdMs?: bigint;

errorEnumList?: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList;

metricType?:

| "METRIC_TYPE_UNSPECIFIED"

| "EVENT_ERROR_RATE"

| "EVENT_WARNING_RATE"

| "TASK_ERROR_RATE"

| "TASK_WARNING_RATE"

| "TASK_RATE"

| "EVENT_RATE"

| "EVENT_AVERAGE_DURATION"

| "EVENT_PERCENTILE_DURATION"

| "TASK_AVERAGE_DURATION"

| "TASK_PERCENTILE_DURATION";

numAggregationPeriods?: number;

onlyFinalAttempt?: boolean;

playbookUrl?: string;

thresholdType?: "UNSPECIFIED_THRESHOLD_TYPE" | "EXPECTED_MIN" | "EXPECTED_MAX";

thresholdValue?: EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue;

warningEnumList?: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList;

}

§Properties

aggregationPeriod?: string

[src]

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

alertDisabled?: boolean

[src]

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

alertName?: string

[src]

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.

clientId?: string

[src]

Client associated with this alert configuration.

durationThresholdMs?: bigint

[src]

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.

errorEnumList?: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList

[src]

[src]

numAggregationPeriods?: number

[src]

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

onlyFinalAttempt?: boolean

[src]

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

playbookUrl?: string

[src]

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

thresholdType?: "UNSPECIFIED_THRESHOLD_TYPE" | "EXPECTED_MIN" | "EXPECTED_MAX"

[src]

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?: EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue

[src]

The metric value, above or below which the alert should be triggered.

warningEnumList?: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList

[src]