Quick Start

Run it yourself
with Docker Compose

The OpenTrace API README keeps setup short:
docker compose up -d --build.

OpenTrace is designed to be self-hosted because many of its best use cases live inside internal systems: operational scripts, private workers, data imports, quality checks, and dashboards that do not need to leave your environment. A quick local deployment should make it easy to prove whether the model fits.

Start the stack

From the API project, run docker compose up -d --build. That command builds and starts the service in the background. Once it is running, pick one operational process and add a few HTTP calls that describe its state.

Instrument one flow first

Do not begin by instrumenting everything. Choose one script or worker that creates real uncertainty today. Add a note at startup, progress updates inside the main loop, metrics for important counts, and a milestone at completion. If the dashboard answers the questions your team normally asks, expand from there.

What success looks like

A useful first OpenTrace setup makes an operational process legible. You should be able to see whether it is active, how far it has moved, what it last reported, and whether anything unusual happened. That is enough to reduce status checks, shorten handoffs, and make background work less mysterious.