Class VictoriaMetricsStore

constructor

• new VictoriaMetricsStore(
      options?: VictoriaMetricsStoreOptions,
  ): VictoriaMetricsStore

  Parameters

  • options: VictoriaMetricsStoreOptions = {}

  Returns VictoriaMetricsStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): VictoriaMetricsHttpClient

  Returns the underlying (internal or injected) HTTP client.

  Returns VictoriaMetricsHttpClient

instantQuery

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

  Runs a PromQL/MetricsQL instant query via GET /api/v1/query (identical to the Prometheus endpoint). Returns the data payload.

  Parameters

  • promql: string
  • Optionaltime: string | number

  Returns Promise<any>

rangeQuery

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

  Runs a PromQL/MetricsQL range query via GET /api/v1/query_range (identical to the Prometheus endpoint). Returns the data payload.

  Parameters

  • promql: string
  • options: RangeQueryOptions

  Returns Promise<any>

importPrometheus

• importPrometheus(lines: string | string[]): Promise<any>

  Imports raw data in Prometheus text-exposition format via POST /api/v1/import/prometheus. Accepts a single newline-delimited string or an array of lines (joined with newlines).

  Parameters

  • lines: string | string[]

  Returns Promise<any>

write

• write(
      metric: string,
      value: number,
      timestamp?: number,
      labels?: Record<string, string>,
  ): Promise<any>

  Writes a single sample by building one Prometheus-exposition line (metric{labels} value [timestamp_ms]) and importing it via importPrometheus.

  Parameters

  • metric: string
  • value: number
  • Optionaltimestamp: number
  • Optionallabels: Record<string, string>

  Returns Promise<any>