Skip to content

Client

SignozClient is the entry point. Create one per process (or per set of credentials), share it between threads/tasks and close it on shutdown. Service functions hang off the client (see Functions).

Function Returns Notes
constructor / create / new client validates the config (CONFIG error)
fromEnv() client config from GROW_SIGNOZ_* and vendor variables
health() HealthStatus { healthy, status, details } unauthenticated; never throws for an unhealthy or unreachable service, only for CANCELLED and CONFIG
ping() latency authenticated round trip to the query API; AUTHENTICATION on a bad key, CONFIG without apiKey
serverVersion() version string UNSUPPORTED when the service exposes none
close() — idempotent; flushes batch processors and stops watchers/renewers

status is ok, degraded, unhealthy, unreachable (network error) or the vendor's word.

Create, use and close

import { SignozClient, SignozConfig } from "@grow-codes/signoz";

const client = new SignozClient(
  new SignozConfig({ url: "http://127.0.0.1:8080", apiKey: process.env.SIGNOZ_API_KEY }),
);
const health = await client.health();          // { healthy, status, details }
const latencyMs = await client.ping();         // number (ms)
const version = await client.serverVersion();  // string
await client.close();                          // safe to call twice

// Cancellation and per-call deadline: every I/O method accepts { signal }
const status = await client.health({ signal: AbortSignal.timeout(2_000) });
use grow_signoz::{SignozClient, SignozConfig};

let config = SignozConfig::builder()
    .url("http://127.0.0.1:8080")
    .api_key(std::env::var("SIGNOZ_API_KEY").unwrap_or_default())
    .build()?;
let client = SignozClient::new(config)?;
let health = client.health().await?;          // HealthStatus
let latency = client.ping().await?;           // Duration
let version = client.server_version().await?; // String
client.close().await;                         // safe to call twice

// Cancellation: drop the future, e.g. with a deadline
let status = tokio::time::timeout(std::time::Duration::from_secs(2), client.health()).await;

Without an async runtime, enable the blocking feature:

let client = grow_signoz::blocking::SignozClient::from_env()?;
let health = client.health()?;
client, err := signoz.NewClient(signoz.Config{
    CommonConfig: signoz.CommonConfig{URL: "http://127.0.0.1:8080"},
    APIKey:       signoz.NewSecret(os.Getenv("SIGNOZ_API_KEY")),
})
if err != nil {
    return err
}
defer client.Close() // safe to call twice

health, err := client.Health(ctx)         // HealthStatus
latency, err := client.Ping(ctx)          // time.Duration
version, err := client.ServerVersion(ctx) // string

// Cancellation and deadlines come from ctx
ctx2, cancel := context.WithTimeout(ctx, 2*time.Second)
defer cancel()
health, err = client.Health(ctx2)
import os

from grow_signoz import CancelToken, SignozClient, SignozConfig

config = SignozConfig(url="http://127.0.0.1:8080", api_key=os.environ.get("SIGNOZ_API_KEY"))
with SignozClient(config) as client:
    health = client.health()           # HealthStatus
    latency_ms = client.ping()         # float (ms)
    version = client.server_version()  # str

    # Cancel from another thread
    token = CancelToken()
    health = client.health(cancel=token)
# close() ran; calling it again is safe

AsyncSignozClient has the same methods as coroutines (await client.health(), await client.aclose(), async with), and honours task cancellation.

SignozConfig config = SignozConfig.builder()
    .url("http://127.0.0.1:8080")
    .apiKey(System.getenv("SIGNOZ_API_KEY"))
    .build();
try (SignozClient client = SignozClient.create(config)) {
  HealthStatus health = client.health();
  Duration latency = client.ping();
  String version = client.serverVersion();

  // Async variants return CompletableFuture; cancel(true) cancels the request
  CompletableFuture<HealthStatus> pending = client.healthAsync();
  pending.orTimeout(2, TimeUnit.SECONDS).join();
} // close() is idempotent

Lifecycle rules

  • The client is safe for concurrent use. Reuse it: it keeps a connection pool.
  • close() flushes queued work (for example log batches) within the configured deadline and is safe to call more than once. Any call on a closed client fails with CANCELLED ("<operation>: client is closed").
  • Each language also offers its idiomatic scope: TypeScript try/finally, Rust close().await (plus best-effort Drop), Go defer client.Close(), Python with/async with, Java try-with-resources.