EnterpriseCrmEventbusProtoTaskAlertConfig

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

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

interface EnterpriseCrmEventbusProtoTaskAlertConfig {

aggregationPeriod?: string;

alertDisabled?: boolean;

alertName?: string;

clientId?: string;

durationThresholdMs?: bigint;

errorEnumList?: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList;

metricType?:

| "METRIC_TYPE_UNSPECIFIED"

| "TASK_ERROR_RATE"

| "TASK_WARNING_RATE"

| "TASK_RATE"

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

The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).

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 in within the scope of the containing workflow.

clientId?: string

[src]

Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.

durationThresholdMs?: bigint

[src]

Should be specified only for TASK_AVERAGE_DURATION and TASK_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]

Only count final task attempts, not retries.

playbookUrl?: string

[src]

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