Class AlertMetricsResource

Alert metric catalog/query helpers — /v2/alertRules/metrics.

Index

Constructors

Methods

catalog models participantCount query

Constructors

constructor

new AlertMetricsResource(http: HttpClient): AlertMetricsResource
Parameters
- http: HttpClient
Returns AlertMetricsResource

Methods

catalog

catalog(params?: { domain?: AlertDomain }): Promise<unknown>
Metric options grouped by category, for building alert queries.
Parameters
- params: { domain?: AlertDomain } = {}
Returns Promise<unknown>

models

models(metric: string): Promise<unknown>
Model options for an agent-domain metric.
Parameters
- metric: string
Returns Promise<unknown>

participantCount

participantCount(
metric: string,
): Promise<{ participantCount: number; [key: string]: unknown }>
Distinct participant count for a metric over the recent window.
Parameters
- metric: string
Returns Promise<{ participantCount: number; [key: string]: unknown }>

query

query(params: { metric: string; window?: string }): Promise<unknown>
Time-series query for a metric (raw metrics response).
Parameters
- params: { metric: string; window?: string }
Returns Promise<unknown>