Class LokiStore

constructor

• new LokiStore(options?: LokiStoreOptions): LokiStore

  Parameters

  • options: LokiStoreOptions = {}

  Returns LokiStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): LokiHttpClient

  Returns the underlying (internal or injected) HTTP client.

  Returns LokiHttpClient

push

• push(labels: Record<string, string>, entries: LokiEntry[]): Promise<any>

  Pushes a batch of log entries for one stream (identified by its label set) via POST /loki/api/v1/push. Each entry is serialized as [<ts-ns>, <line>] (plus optional structured metadata) in Loki's push payload shape.

  Parameters

  • labels: Record<string, string>
  • entries: LokiEntry[]

  Returns Promise<any>

query

• query(logql: string, options?: LokiQueryOptions): Promise<any>

  Runs a LogQL query over a time window via GET /loki/api/v1/query_range. Returns the data payload ({ resultType, result }).

  Parameters

  • logql: string
  • options: LokiQueryOptions = {}

  Returns Promise<any>

labels

• labels(): Promise<any>

  Lists the known label names via GET /loki/api/v1/labels.

  Returns Promise<any>

streams

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

  Lists the label sets (streams) matching an optional selector via GET /loki/api/v1/series.

  Parameters

  • Optionalmatch: string | string[]

  Returns Promise<any>

labelValues

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

  Lists the distinct values of a label via GET /loki/api/v1/label/<name>/values.

  Parameters

  • label: string

  Returns Promise<any>