@grow-codes/signoz - v0.1.1
    Preparing search index...

    Class SignozClient

    Client for SigNoz: health(), ping(), serverVersion(), the query clients (SignozClient.query, SignozClient.logs, SignozClient.traces), OTLP log clients (SignozClient.logClient) and tracing (SignozClient.initTracing). close() flushes and closes every log client and tracing handle created through it.

    Index
    config: SignozConfig

    The immutable configuration.

    Logging-category query client (search, tail, streams, labels, waitForLog).

    Query API (logs, spans, traces, services, aggregations, log fields).

    • Flushes and closes log clients and tracing handles, then releases connections. Idempotent. Any call on a closed client raises CancelledError ("client is closed").

      Returns Promise<void>

    • Authenticated round trip (GET /api/v1/fields/keys?signal=logs&limit=1 with SIGNOZ-API-KEY). Returns the latency in milliseconds; AuthenticationError on a bad key.

      Parameters

      Returns Promise<number>

    • Server version from GET /api/v1/version (leading v stripped). The official community image reports an empty version → UnsupportedError.

      Parameters

      Returns Promise<string>