Class PrometheusStore

constructor

• new PrometheusStore(options?: PrometheusStoreOptions): PrometheusStore

  Parameters

  • options: PrometheusStoreOptions = {}

  Returns PrometheusStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): PrometheusHttpClient

  Returns the underlying (internal or injected) HTTP client.

  Returns PrometheusHttpClient

instantQuery

• instantQuery(promql: string, time?: string | number): Promise<any>

  Runs a PromQL instant query at a single point in time via GET /api/v1/query. Returns the data payload (result type + result).

  Parameters

  • promql: string
  • Optionaltime: string | number

  Returns Promise<any>

rangeQuery

• rangeQuery(promql: string, options: RangeQueryOptions): Promise<any>

  Runs a PromQL range query over [start, end] at step resolution via GET /api/v1/query_range. Returns the data payload (matrix result).

  Parameters

  • promql: string
  • options: RangeQueryOptions

  Returns Promise<any>

series

• series(match: string | string[]): Promise<any>

  Finds series matching one or more PromQL series selectors via GET /api/v1/series. Returns the array of matching label sets.

  Parameters

  • match: string | string[]

  Returns Promise<any>

labelValues

• labelValues(label: string): Promise<any>

  Lists the distinct values of a label via GET /api/v1/label/<label>/values. Returns the array of values.

  Parameters

  • label: string

  Returns Promise<any>