Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

JSON events

With --json, share and use print one JSON object per line on stdout. Every object has an "event" name and a "v": 1 schema version. The vocabulary is additive: new events and new fields may appear, so match on names and ignore unknown members. Log text goes to stderr and never mixes into the stream.

Lifecycle

eventemitted bymeaning
share_readyshareThe share is up and registered. Fields: url, routing_key, identity_file, tun_name (with --os-routing, else null), record_dir, upgrade_enabled.
tunnel_readyuseThe tunnel interface is up and pumping. Fields: mode ("vpn" or "attached"), tun_name, record_dir, upgrade_enabled; in vpn mode also tun_addr, tun_addr6 (null with --no-ipv6), mtu, mtu_policy ("auto" or "fixed"), routes, dns, dns_method (null when the resolver was left alone).
stoppingbothShutdown has begun (Ctrl+C, SIGTERM, or console close).
session_endedshareThe client session ended. Field: reason.

Paths and transports

eventemitted bymeaning
relay_session_establishedbothThe relay-path session is up. Field: peer.
path_activatedbothA transport can now carry tunnel traffic. Fields: carrier (quic, tcp_tls, nz), path (relay, direct_advertised, direct_punched), local, peer. Fires for the initial path and again after an acknowledged switch to a punched path, so automation never infers the active transport from log prose.
direct_upgrade_succeededbothA direct path replaced the relay path. Fields: local, peer.
direct_upgrade_failedbothOne direct-path attempt failed; the session stays on its current path and retries. Fields: code (a stable reason code), reason (human text).
reconnectinguseThe transport died; the client is redialing.
reconnecteduseThe redial succeeded.

MTU

eventemitted bymeaning
path_mtuuseThe path’s measured packet budget, reported after path discovery settles and again after a direct upgrade. Field: mtu.
tun_mtuuseThe tunnel interface MTU was changed to match (VPN mode with the default --mtu policy). Field: mtu.

Housekeeping

eventemitted bymeaning
conn_log_degradedshareThe connection log hit trouble (disk, overload) and marked a gap. Field: detail.