alerts.performance.ThresholdAlertPayload interface

性能阈值提醒的内部载荷对象。载荷封装在对象内。

签名

export interface ThresholdAlertPayload 

属性

属性 类型 说明
appVersion 字符串 触发此提醒的应用版本;如果提醒是针对网络请求(因为系统是针对所有应用版本的数据检查提醒)或 Web 应用(对于应用无版本),则可以省略该版本
conditionPercentile 数字 提醒条件的百分位数,如果百分位不适用于提醒条件并被省略,则可以为 0;范围:[1, 100]
eventName 字符串 收到此提醒的跟踪记录或网络请求的名称(例如 my_custom_trace、firebase.com/api/123)
eventType 字符串 此提醒针对的资源类型(即跟踪记录、网络请求、屏幕渲染等)
investigateUri 字符串 用于调查此警报的 Fireconsole 链接
metricType 字符串 此提醒所针对的指标类型(即成功率、响应时间、时长等)
numSamples 数字 针对此提醒条件检查的事件数量
thresholdUnit 字符串 提醒阈值的单位(例如“百分比”“秒”)
thresholdValue 数字 不带单位的提醒条件的阈值(例如“75”“2.1”)
violationUnit 字符串 违规值的单位(例如“百分比”、“秒”)
violationValue 数字 违反提醒条件的值(例如“76.5”“3”)

alert.performance.ThresholdAlertPayload.appVersion

触发此提醒的应用版本。如果提醒是针对网络请求(因为系统是针对所有应用版本的数据检查提醒)或 Web 应用(对于应用无版本),则可以省略

签名

appVersion?: string;

Alerts.performance.ThresholdAlertPayload.conditionPercentile

提醒条件的百分位数,如果百分位不适用于提醒条件并被省略,则可以为 0;范围:[1, 100]

签名

conditionPercentile?: number;

alerts.performance.ThresholdAlertPayload.eventName

收到此提醒的跟踪记录或网络请求的名称(例如 my_custom_trace、firebase.com/api/123)

签名

eventName: string;

alert.performance.ThresholdAlertPayload.eventType

此提醒针对的资源类型(即跟踪记录、网络请求、屏幕渲染等)

签名

eventType: string;

Alerts.performance.ThresholdAlertPayload.investigateUri

用于调查此警报的 Fireconsole 链接

签名

investigateUri: string;

alert.performance.ThresholdAlertPayload.metricType

此提醒所针对的指标类型(即成功率、响应时间、时长等)

签名

metricType: string;

alert.performance.ThresholdAlertPayload.numSamples

针对此提醒条件检查的事件数量

签名

numSamples: number;

alert.performance.ThresholdAlertPayload.thresholdUnit

提醒阈值的单位(例如“百分比”“秒”)

签名

thresholdUnit: string;

alerts.performance.ThresholdAlertPayload.thresholdValue

不带单位的提醒条件的阈值(例如“75”“2.1”)

签名

thresholdValue: number;

Alerts.performance.ThresholdAlertPayload.violationUnit

违规值的单位(例如“百分比”、“秒”)

签名

violationUnit: string;

alerts.performance.ThresholdAlertPayload.violationValue

违反提醒条件的值(例如“76.5”“3”)

签名

violationValue: number;