Skip to content

Configuration

OpenObserveConfig holds every setting of a client. It is immutable after construction, validated when it is built (invalid values raise a CONFIG error) and its string/debug form redacts every credential (password, token).

OpenObserve settings

Setting Default Environment variables (first match wins)
url — base URL of OpenObserve http://127.0.0.1:5080 GROW_OPENOBSERVE_URL, OPENOBSERVE_URL
org — organization identifier default GROW_OPENOBSERVE_ORG, OPENOBSERVE_ORG
user — Basic-auth e-mail: a user, the root user or a service account none GROW_OPENOBSERVE_USER, OPENOBSERVE_USER
password — password of user (secret) none GROW_OPENOBSERVE_PASSWORD, OPENOBSERVE_PASSWORD
token — service-account token of user, or a pre-encoded Basic … header (secret) none GROW_OPENOBSERVE_TOKEN, OPENOBSERVE_TOKEN
stream — default log stream (logClient, logQuery, ingestOtlp) default GROW_OPENOBSERVE_STREAM, OPENOBSERVE_STREAM
tracesStream — default traces stream (client.traces, initTracing) default GROW_OPENOBSERVE_TRACES_STREAM, OPENOBSERVE_TRACES_STREAM

Validation rules (identical in every language, CONFIG otherwise):

  • password and token are mutually exclusive; with either one, user is required — except for a token that starts with Basic, which is a complete header value and is sent as is.
  • user without password or token is an error; blank credentials are an error.
  • org must be a non-empty identifier without /, ?, # or spaces; stream and tracesStream must not be blank. Both stream names are normalized (lower case, non [a-z0-9_] → _).
  • From the environment, an explicit password drops a token found in the environment and vice versa, so overriding the credential kind never trips the "password and token" rule.

OpenObserve does not accept Bearer tokens; every request carries Authorization: Basic ….

Common settings

Setting Default Environment variable
url — endpoint base URL http://127.0.0.1:5080 GROW_OPENOBSERVE_URL
connectTimeout — connection setup 10 s GROW_OPENOBSERVE_CONNECT_TIMEOUT
requestTimeout — per attempt (headers + body) 30 s GROW_OPENOBSERVE_REQUEST_TIMEOUT
totalTimeout — whole call incl. retries and backoff 120 s GROW_OPENOBSERVE_TOTAL_TIMEOUT
retry — retry policy (below) 3 retries GROW_OPENOBSERVE_MAX_RETRIES
tls.caCertPath / tls.caCertPem — extra CA none GROW_OPENOBSERVE_CA_CERT (path)
tls.clientCertPath + tls.clientKeyPath — mutual TLS none GROW_OPENOBSERVE_CLIENT_CERT, GROW_OPENOBSERVE_CLIENT_KEY
tls.insecureSkipVerify — tests only, logs a warning once false GROW_OPENOBSERVE_INSECURE_SKIP_VERIFY
proxy — proxy URL none (environment proxies are ignored) GROW_OPENOBSERVE_PROXY
headers — extra request headers {} —
userAgentSuffix — appended to the User-Agent none —
hooks — request/response callbacks (Hooks) none —
logger — diagnostic logger (Hooks) silent —

Every request sends User-Agent: grow-codes-openobserve/<version> (<language>).

From the environment

fromEnv resolves each setting with this precedence:

  1. the value passed in code (overrides),
  2. GROW_OPENOBSERVE_<NAME>,
  3. the vendor variables OPENOBSERVE_<NAME> (table above),
  4. the default.

Parsing rules:

  • Durations accept integer milliseconds (1500) or Go-style units: 500ms, 10s, 2m, 1h, combinations such as 1m30s.
  • Booleans accept true/false, 1/0, yes/no, on/off (any case).
  • An empty variable counts as unset.
  • A present but invalid value raises a CONFIG error that names the variable, never its value.
import { OpenObserveClient, OpenObserveConfig } from "@grow-codes/openobserve";

// Environment only
const client = OpenObserveClient.fromEnv();

// Environment with explicit overrides (explicit values win)
const config = OpenObserveConfig.fromEnv({ requestTimeoutMs: 5_000 });

// Everything in code
const explicit = new OpenObserveConfig({
  url: "https://openobserve.example.com",
  org: "default",
  user: "ci@example.com",
  token: process.env.MY_TOKEN, // or password: ...
  stream: "app",
  tracesStream: "app_traces",
  connectTimeoutMs: 5_000,
  requestTimeoutMs: 15_000,
  totalTimeoutMs: 60_000,
  retry: { maxRetries: 5, initialBackoffMs: 200 },
  tls: { caCertPath: "/etc/ssl/internal-ca.pem" },
  proxy: "http://proxy.internal:3128",
  headers: { "x-team": "payments" },
  userAgentSuffix: "my-app/1.4",
});
const custom = new OpenObserveClient(explicit);
console.log(String(explicit)); // token shown as [REDACTED]
use std::time::Duration;
use grow_openobserve::{OpenObserveClient, OpenObserveConfig, RetryPolicy};

// Environment only
let client = OpenObserveClient::from_env()?;

// Environment with explicit overrides (explicit values win)
let config = OpenObserveConfig::builder()
    .request_timeout(Duration::from_secs(5))
    .build_from_env()?;

// Everything in code
let explicit = OpenObserveConfig::builder()
    .url("https://openobserve.example.com")
    .org("default")
    .user("ci@example.com")
    .token(std::env::var("MY_TOKEN").unwrap_or_default())
    .stream("app")
    .traces_stream("app_traces")
    .connect_timeout(Duration::from_secs(5))
    .request_timeout(Duration::from_secs(15))
    .total_timeout(Duration::from_secs(60))
    .retry(RetryPolicy::default().with_max_retries(5))
    .ca_cert_path("/etc/ssl/internal-ca.pem")
    .proxy("http://proxy.internal:3128")
    .header("x-team", "payments")
    .user_agent_suffix("my-app/1.4")
    .build()?;
let custom = OpenObserveClient::new(explicit)?;
println!("{:?}", custom.config()); // token shown as [REDACTED]
// Environment only
client, err := openobserve.NewClientFromEnv()

// Everything in code: zero values mean "use the default"
cfg := openobserve.Config{
    CommonConfig: openobserve.CommonConfig{
        URL:             "https://openobserve.example.com",
        ConnectTimeout:  5 * time.Second,
        RequestTimeout:  15 * time.Second,
        TotalTimeout:    time.Minute,
        Retry:           &openobserve.RetryPolicy{MaxRetries: 5, InitialBackoff: 200 * time.Millisecond},
        TLS:             openobserve.TLSConfig{CACertPath: "/etc/ssl/internal-ca.pem"},
        Proxy:           "http://proxy.internal:3128",
        Headers:         map[string]string{"x-team": "payments"},
        UserAgentSuffix: "my-app/1.4",
    },
    Org:          "default",
    User:         "ci@example.com",
    Token:        openobserve.NewSecret(os.Getenv("MY_TOKEN")), // or Password
    Stream:       "app",
    TracesStream: "app_traces",
}
if err := cfg.Validate(); err != nil {
    log.Fatal(err) // errors.Is(err, openobserve.ErrConfig)
}
custom, err := openobserve.NewClient(cfg)

// Environment with explicit overrides (explicit values win; nil env = process environment)
merged, err := openobserve.ConfigFromEnvWith(openobserve.Config{
    CommonConfig: openobserve.CommonConfig{RequestTimeout: 5 * time.Second},
}, nil)
fmt.Println(merged) // token shown as [REDACTED]
import os
from grow_openobserve import RetryPolicy, TlsConfig, OpenObserveClient, OpenObserveConfig

# Environment only
client = OpenObserveClient.from_env()

# Environment with explicit overrides (explicit values win)
config = OpenObserveConfig.from_env(request_timeout=5.0)

# Everything in code: durations are float seconds (datetime.timedelta also works)
explicit = OpenObserveConfig(
    url="https://openobserve.example.com",
    org="default",
    user="ci@example.com",
    token=os.environ.get("MY_TOKEN"),  # or password=...
    stream="app",
    traces_stream="app_traces",
    connect_timeout=5.0,
    request_timeout=15.0,
    total_timeout=60.0,
    retry=RetryPolicy(max_retries=5, initial_backoff=0.2),
    tls=TlsConfig(ca_cert_path="/etc/ssl/internal-ca.pem"),
    proxy="http://proxy.internal:3128",
    headers={"x-team": "payments"},
    user_agent_suffix="my-app/1.4",
)
custom = OpenObserveClient(explicit)
print(repr(explicit))  # token shown as [REDACTED]
import java.time.Duration;
import codes.grow.packages.openobserve.OpenObserveClient;
import codes.grow.packages.openobserve.OpenObserveConfig;
import codes.grow.packages.openobserve.core.RetryPolicy;

// Environment only
OpenObserveClient client = OpenObserveClient.fromEnv();

// Everything in code
OpenObserveConfig config = OpenObserveConfig.builder()
    .url("https://openobserve.example.com")
    .org("default")
    .user("ci@example.com")
    .token(System.getenv("MY_TOKEN")) // or .password(...)
    .stream("app")
    .tracesStream("app_traces")
    .connectTimeout(Duration.ofSeconds(5))
    .requestTimeout(Duration.ofSeconds(15))
    .totalTimeout(Duration.ofMinutes(1))
    .retry(RetryPolicy.builder().maxRetries(5).initialBackoff(Duration.ofMillis(200)).build())
    .proxy("http://proxy.internal:3128")
    .header("x-team", "payments")
    .userAgentSuffix("my-app/1.4")
    .build();
OpenObserveClient custom = OpenObserveClient.create(config);
System.out.println(config); // token shown as [REDACTED]

Retry policy

Field Default Meaning
maxRetries 3 retries after the first attempt (so up to 4 attempts)
initialBackoff 100 ms backoff cap of the first retry
maxBackoff 10 s cap of every backoff
multiplier 2 growth of the cap per retry
maxRetryAfter 60 s longest server-requested Retry-After the client waits for

Backoff for retry n (0-based) is full jitter: a random wait between 0 and min(maxBackoff, initialBackoff × multiplier^n).

Requests are retried on HTTP 429, 408, 502, 503, 504 and on network errors. Idempotent requests (GET HEAD OPTIONS PUT DELETE, or marked idempotent) are also retried on HTTP 500. Other requests (for example POST) are retried only on 429 and on connection errors that happened before the request was sent, never after an uncertain send.

On 429 and 503 the client honours Retry-After (seconds or HTTP date) and waits max(retryAfter, backoff). When that wait exceeds maxRetryAfter or the remaining totalTimeout, it stops at once with RATE_LIMITED/UNAVAILABLE and sets retryAfter on the error. Set maxRetries to 0 to turn retries off.

Timeouts and cancellation

  • connectTimeout bounds connection setup, requestTimeout each attempt, totalTimeout the whole call including backoff sleeps. An exhausted timeout raises TIMEOUT.
  • Cancellation is honoured during requests and backoff sleeps and raises CANCELLED: TypeScript { signal } (AbortSignal), Rust dropping the future, Go ctx, Python cancel= (CancelToken) or task cancellation, Java …Async futures (cancel(true)).

TLS and proxies

  • Add a private CA with tls.caCertPath (or the PEM text in tls.caCertPem).
  • Mutual TLS needs tls.clientCertPath and tls.clientKeyPath together.
  • tls.insecureSkipVerify disables certificate checks. Use it for local tests only; the client logs a warning once.
  • HTTP_PROXY/HTTPS_PROXY are ignored so that credentials never leave through an unexpected proxy. Set proxy (or GROW_OPENOBSERVE_PROXY) to use one.