IAlertDescription
Alert description.
export interface IAlertDescription
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (Optional) Attribute of the alert (if sliced by attribute). | ||
string | Condition of the alert (in human readable form). | ||
(Optional) Current values that triggered the alert (if sliced by attribute). | |||
string | (Optional) Error message of the alert. | ||
string | (Optional) Threshold set to trigger the alert - formatted. | ||
number | (Optional) Lower threshold of the alert. | ||
string | Title of the metric. | ||
(Optional) Result of the execution that evaluated the alert. | |||
number | (Optional) Threshold set to trigger the alert. | ||
number | (Optional) Total values count that can trigger the alert. | ||
string | (Optional) Trace ID of the alert. | ||
number | (Optional) Count of values that triggered the alert. | ||
number | (Optional) Upper threshold of the alert. |
Property details
IAlertDescription.attributeproperty
Attribute of the alert (if sliced by attribute).
attribute?: string;
IAlertDescription.conditionproperty
Condition of the alert (in human readable form).
condition: string;
IAlertDescription.currentValuesproperty
Current values that triggered the alert (if sliced by attribute).
currentValues?: IAlertEvaluationRow[];
IAlertDescription.errorMessageproperty
Error message of the alert.
errorMessage?: string;
IAlertDescription.formattedThresholdproperty
Threshold set to trigger the alert - formatted.
formattedThreshold?: string;
IAlertDescription.lowerThresholdproperty
Lower threshold of the alert.
lowerThreshold?: number;
IAlertDescription.metricproperty
Title of the metric.
metric: string;
IAlertDescription.statusproperty
Result of the execution that evaluated the alert.
status?: AlertDescriptionStatus;
IAlertDescription.thresholdproperty
Threshold set to trigger the alert.
threshold?: number;
IAlertDescription.totalValueCountproperty
Total values count that can trigger the alert.
totalValueCount?: number;
IAlertDescription.traceIdproperty
Trace ID of the alert.
traceId?: string;
IAlertDescription.triggeredCountproperty
Count of values that triggered the alert.
triggeredCount?: number;
IAlertDescription.upperThresholdproperty
Upper threshold of the alert.
upperThreshold?: number;