Skip to content

API at a glance

Every public piece, by what it is for, with the line that imports it. Signatures and docstrings in full: the generated reference under Reference in the navigation.

Track

Import
Tracker from etrack.logic.api import Tracker opens runs: tracker.track(thread, config, run_id=None) → Track a run
EventChannel from etrack.logic.channel import EventChannel validates, publishes and logs every frame; emit(event), log.info("run.event", …)
FoldProcessor reached as run.fold spans and facts of your own code: span(...), instant(...) → Own spans
run from etrack.logic.handle import run the run in progress, from code it calls: span(...), declare(input, output), annotate(**attributes), fact(value) → The run from inside
LanggraphSourceAdapter from etrack.providers.adapters.source.langgraph import LanggraphSourceAdapter reads LangGraph runs → LangGraph

Carry and deliver

Import
AnyioAdapter from etrack.providers.adapters.bus.anyio import AnyioAdapter the bus: subscribe(sink, select=None, *, redact=None, delivery=…), dropped, failed → Send events
LiveAdapter from etrack.providers.adapters.sink.live import LiveAdapter the live buffer: watch(thread, after), threads(), offset(thread)
OtlpDriver from etrack.providers.drivers.sink.otlp import OtlpDriver OpenTelemetry spans and logs: flush(), processor() → OpenTelemetry
HttpDriver from etrack.providers.drivers.sink.http import HttpDriver any HTTP endpoint, batched and retried, guaranteed with an outbox; the base of a custom driver: flush(), report(), sent, failed, missing → Custom drivers
SqliteAdapter from etrack.providers.adapters.outbox.sqlite import SqliteAdapter the outbox in a SQLite file: of(key), requeue(key), report() → Guaranteed delivery
PrometheusAdapter from etrack.providers.adapters.sink.prometheus import PrometheusAdapter run metrics: app to scrape, registry → Prometheus and Grafana
AuthSigner from etrack.infra.auth import AuthSigner one Auth signed onto requests: ready(), headers(), session() → Authentication

Watch

Import
Viewer from etrack.logic.viewer import Viewer the live canvas: Viewer(watch, topology, labels={}), .app, .topology → Watch it live
GranianAdapter from etrack.providers.adapters.server.granian import GranianAdapter serves an ASGI app in your loop: .url → Web apps
LanggraphTopologyAdapter from etrack.providers.adapters.topology.langgraph import LanggraphTopologyAdapter read(graph or Graph.to_json()) → Topology → Graphs & labels
LayoutProcessor from etrack.processors.layout import LayoutProcessor place(topology): rank, lane, loops

The record and its values

Import
RunEvent from etrack.models.event import RunEvent one frame of a run → The record
EventKind, EventPhase, Part from etrack.models.event import EventKind, EventPhase, Part what a span is, where it is in its life, what a delta carries
Usage, ModelRef, Failure, RunScope from etrack.models.event import Usage, ModelRef, Failure, RunScope typed sections of a frame; a run's ids
Outcome, Redact, Pricer from etrack.models.event import Outcome, Redact, Pricer how a run ended; a mask; your prices
EventView, LogView, RunView from etrack.models.event import EventView, LogView, RunView narrow a frame to the fields a client reads; a run as its root closes it
Fact from etrack.models.fact import Fact the base of a typed business event → The run from inside
Refusal from etrack.ports.sink import Refusal why an endpoint did not take an item
Entry, EntryState from etrack.ports.outbox import Entry, EntryState an item in an outbox and where it stands
Delivery, DeliveryReport from etrack.ports.bus import Delivery · from etrack.providers.drivers.sink.http import DeliveryReport what a subscription is promised; where a driver's items stand
Edge from etrack.ports.source import Edge a span as you report it to run.fold.instant
Topology, TopologyNode, TopologyEdge from etrack.ports.topology import Topology, TopologyNode, TopologyEdge a declared graph
LiveFrame, LiveSummary from etrack.ports.sink import LiveFrame, LiveSummary a watched frame with its offset; a kept thread

Contracts — to write your own

Import Meet it to write
SinkPort from etrack.ports.sink import SinkPort a sink → Custom sinks
WatchPort from etrack.ports.sink import WatchPort a live store the viewer can read
SourcePort, FoldPort, LocatePort from etrack.ports.source import SourcePort, FoldPort, LocatePort a source for another framework; one that tells where the caller stands
OutboxPort from etrack.ports.outbox import OutboxPort a store for guaranteed delivery (a job table of your own)
SignerPort from etrack.ports.sink import SignerPort an identity that signs a driver's requests
TopologyPort from etrack.ports.topology import TopologyPort a graph reader for another framework
ServerPort from etrack.ports.server import ServerPort another embedded server
Provider, ProviderSpec from etrack.ports.provider import Provider, ProviderSpec the lifecycle every provider shares: async with, health(), spec

Settings and errors

Import
OtlpTarget, Encoding from etrack.infra.config.providers import OtlpTarget, Encoding
OtlpConfig, HttpConfig, AnyioConfig, LiveConfig, GranianConfig, PrometheusConfig from etrack.infra.config.providers import … — each provider's keyword arguments
BearerAuth and the other auths from etrack.infra.config.auth import NoAuth, HeadersAuth, BearerAuth, BasicAuth, GoogleAuth
CoreError and its family from etrack.infra.errors import CoreError, ChannelError, FactError, BusError, SinkError, SourceError, ServerError, LayoutError

Every variable each setting reads → Settings.