Configuration¶
ZipkinConfig 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. Stock Zipkin has no authentication: there is no token; when a
gateway sits in front of Zipkin, put its credentials in headers (values are redacted). The
Zipkin-specific field endpoint (span ingest URL) is listed on the Functions page.
Common settings¶
| Setting | Default | Environment variable |
|---|---|---|
url — server base URL |
http://127.0.0.1:9411 |
GROW_ZIPKIN_URL, ZIPKIN_URL, base of OTEL_EXPORTER_ZIPKIN_ENDPOINT |
endpoint — span ingest URL |
<url>/api/v2/spans |
GROW_ZIPKIN_ENDPOINT, OTEL_EXPORTER_ZIPKIN_ENDPOINT |
connectTimeout — connection setup |
10 s | GROW_ZIPKIN_CONNECT_TIMEOUT |
requestTimeout — per attempt (headers + body) |
30 s | GROW_ZIPKIN_REQUEST_TIMEOUT |
totalTimeout — whole call incl. retries and backoff |
120 s | GROW_ZIPKIN_TOTAL_TIMEOUT |
retry — retry policy (below) |
3 retries | GROW_ZIPKIN_MAX_RETRIES |
tls.caCertPath / tls.caCertPem — extra CA |
none | GROW_ZIPKIN_CA_CERT (path) |
tls.clientCertPath + tls.clientKeyPath — mutual TLS |
none | GROW_ZIPKIN_CLIENT_CERT, GROW_ZIPKIN_CLIENT_KEY |
tls.insecureSkipVerify — tests only, logs a warning once |
false |
GROW_ZIPKIN_INSECURE_SKIP_VERIFY |
proxy — proxy URL |
none (environment proxies are ignored) | GROW_ZIPKIN_PROXY |
headers — extra request headers (gateway credentials; values redacted) |
{} |
— |
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-zipkin/<version> (<language>).
From the environment¶
fromEnv resolves each setting with this precedence:
- the value passed in code (overrides),
GROW_ZIPKIN_<NAME>,- the vendor variables of Zipkin (see Functions), in their documented order,
- the default.
Parsing rules:
- Durations accept integer milliseconds (
1500) or Go-style units:500ms,10s,2m,1h, combinations such as1m30s. - 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
CONFIGerror that names the variable, never its value.
import { ZipkinClient, ZipkinConfig } from "@grow-codes/zipkin";
// Environment only
const client = ZipkinClient.fromEnv();
// Environment with explicit overrides (explicit values win)
const config = ZipkinConfig.fromEnv({ requestTimeoutMs: 5_000 });
// Everything in code
const explicit = new ZipkinConfig({
url: "https://zipkin.example.com",
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: { authorization: `Bearer ${process.env.GATEWAY_TOKEN}` },
userAgentSuffix: "my-app/1.4",
});
const custom = new ZipkinClient(explicit);
console.log(String(explicit)); // header values shown as [REDACTED]
use std::time::Duration;
use grow_zipkin::{ZipkinClient, ZipkinConfig, RetryPolicy};
// Environment only
let client = ZipkinClient::from_env()?;
// Environment with explicit overrides (explicit values win)
let config = ZipkinConfig::builder()
.request_timeout(Duration::from_secs(5))
.build_from_env()?;
// Everything in code
let explicit = ZipkinConfig::builder()
.url("https://zipkin.example.com")
.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("authorization", format!("Bearer {}", std::env::var("GATEWAY_TOKEN").unwrap_or_default()))
.user_agent_suffix("my-app/1.4")
.build()?;
let custom = ZipkinClient::new(explicit)?;
println!("{:?}", custom.config()); // header values shown as [REDACTED]
// Environment only
client, err := zipkin.NewClientFromEnv()
// Everything in code: zero values mean "use the default"
cfg := zipkin.Config{
CommonConfig: zipkin.CommonConfig{
URL: "https://zipkin.example.com",
ConnectTimeout: 5 * time.Second,
RequestTimeout: 15 * time.Second,
TotalTimeout: time.Minute,
Retry: &zipkin.RetryPolicy{MaxRetries: 5, InitialBackoff: 200 * time.Millisecond},
TLS: zipkin.TLSConfig{CACertPath: "/etc/ssl/internal-ca.pem"},
Proxy: "http://proxy.internal:3128",
Headers: map[string]string{"Authorization": "Bearer " + os.Getenv("GATEWAY_TOKEN")},
UserAgentSuffix: "my-app/1.4",
},
}
if err := cfg.Validate(); err != nil {
log.Fatal(err) // errors.Is(err, zipkin.ErrConfig)
}
custom, err := zipkin.NewClient(cfg)
// Environment with explicit overrides (explicit values win; nil env = process environment)
merged, err := zipkin.ConfigFromEnvWith(zipkin.Config{
CommonConfig: zipkin.CommonConfig{RequestTimeout: 5 * time.Second},
}, nil)
fmt.Println(merged) // header values shown as [REDACTED]
import os
from grow_zipkin import RetryPolicy, TlsConfig, ZipkinClient, ZipkinConfig
# Environment only
client = ZipkinClient.from_env()
# Environment with explicit overrides (explicit values win)
config = ZipkinConfig.from_env(request_timeout=5.0)
# Everything in code: durations are float seconds (datetime.timedelta also works)
explicit = ZipkinConfig(
url="https://zipkin.example.com",
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={"Authorization": f"Bearer {os.environ['GATEWAY_TOKEN']}"},
user_agent_suffix="my-app/1.4",
)
custom = ZipkinClient(explicit)
print(repr(explicit)) # header values shown as [REDACTED]
import java.time.Duration;
import codes.grow.packages.zipkin.ZipkinClient;
import codes.grow.packages.zipkin.ZipkinConfig;
import codes.grow.packages.zipkin.core.RetryPolicy;
// Environment only
ZipkinClient client = ZipkinClient.fromEnv();
// Everything in code
ZipkinConfig config = ZipkinConfig.builder()
.url("https://zipkin.example.com")
.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("Authorization", "Bearer " + System.getenv("GATEWAY_TOKEN"))
.userAgentSuffix("my-app/1.4")
.build();
ZipkinClient custom = ZipkinClient.create(config);
System.out.println(config); // header values 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¶
connectTimeoutbounds connection setup,requestTimeouteach attempt,totalTimeoutthe whole call including backoff sleeps. An exhausted timeout raisesTIMEOUT.- Cancellation is honoured during requests and backoff sleeps and raises
CANCELLED: TypeScript{ signal }(AbortSignal), Rust dropping the future, Goctx, Pythoncancel=(CancelToken) or task cancellation, Java…Asyncfutures (cancel(true)).
TLS and proxies¶
- Add a private CA with
tls.caCertPath(or the PEM text intls.caCertPem). - Mutual TLS needs
tls.clientCertPathandtls.clientKeyPathtogether. tls.insecureSkipVerifydisables certificate checks. Use it for local tests only; the client logs a warning once.HTTP_PROXY/HTTPS_PROXYare ignored so that credentials never leave through an unexpected proxy. Setproxy(orGROW_ZIPKIN_PROXY) to use one.