Class SigNozStore

constructor

• new SigNozStore(options?: SigNozStoreOptions): SigNozStore

  Parameters

  • options: SigNozStoreOptions = {}

  Returns SigNozStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): SigNozHttpClient

  Returns the underlying (internal or injected) HTTP client.

  Returns SigNozHttpClient

push

• push(
      resource: Record<string, string | number | boolean>,
      entries: SigNozLogEntry[],
  ): Promise<any>

  Ingests log records over OTLP/HTTP via POST /v1/logs. The simplified entries are assembled into the OTLP resourceLogs -> scopeLogs -> logRecords envelope, tagged with the shared resource attributes.

  Parameters

  • resource: Record<string, string | number | boolean>
  • entries: SigNozLogEntry[]

  Returns Promise<any>

query

• query(
      builder: Record<string, unknown>,
      options?: SigNozQueryOptions,
  ): Promise<any>

  Runs a query-range request via POST /api/v4/query_range. The builder is SigNoz's composite query payload (compositeQuery / builder queries); start/end/step fill the time window. Returns the parsed response.

  Parameters

  • builder: Record<string, unknown>
  • options: SigNozQueryOptions = {}

  Returns Promise<any>

labels

• labels(): Promise<any>

  Lists the known log field/attribute keys via GET /api/v1/logs/fields.

  Returns Promise<any>

streams

• streams(): Promise<any>

  Lists the observed services via GET /api/v1/services.

  Returns Promise<any>