MLflow Tracing Instrumentation Guide
Language-Specific Guides
Based on the user's project, load the appropriate guide:
- Python projects: Read
references/python.md - TypeScript/JavaScript projects: Read
references/typescript.md
If unclear, check for package.json (TypeScript) or requirements.txt/pyproject.toml (Python) in the project.
Databricks: verify auth and use Unity Catalog trace storage by default
When the target is Databricks, read references/databricks.md before editing code and configure a UnityCatalog trace location. Calling only mlflow.set_tracking_uri("databricks") and mlflow.set_experiment(...) without a trace location uses legacy workspace experiment storage; that does not satisfy a request to send traces to Databricks.
Inspect existing project or environment configuration for candidate destinations, the optional table prefix, and SQL warehouse. Before binding an experiment or provisioning UC resources, follow the schema-selection workflow in references/databricks.md: ask the user to choose an existing schema or create a new one unless they have already explicitly chosen the destination. Never select an arbitrary accessible schema. Ask for any missing required values before implementing tracing. Do not silently fall back to legacy workspace trace storage. Use legacy storage only when the user explicitly requests it.
Verify auth and the target workspace before the first run. An expired token, or a default profile pointed at the wrong workspace, drops traces silently at export with no error raised.
databricks current-user me --profile <name> # fails if auth is expired, without printing a token
python -c "import mlflow; print(mlflow.get_tracking_uri())" # confirm databricks or databricks://<name>
If auth is expired, run databricks auth login --profile <name>. Never print or persist the output of databricks auth token in an agent transcript.
What to Trace
Trace these operations (high debugging/observability value):
| Operation Type | Examples | Why Trace |
|---|---|---|
| Root operations | Main entry points, top-level pipelines, workflow steps | End-to-end latency, input/output logging |
| LLM calls | Chat completions, embeddings | Token usage, latency, prompt/response inspection |
| Retrieval | Vector DB queries, document fetches, search | Relevance debugging, retrieval quality |
| Tool/function calls | API calls, database queries, web search | External dependency monitoring, error tracking |
| Agent decisions | Routing, planning, tool selection | Understand agent reasoning and choices |
| External services | HTTP APIs, file I/O, message queues | Dependency failures, timeout tracking |
Skip tracing these (too granular, adds noise):
- Simple data transformations (dict/list manipulation)
- String formatting, parsing, validation
- Configuration loading, environment setup
- Logging or metric emission
- Pure utility functions (math, sorting, filtering)
Rule of thumb: Trace operations that are important for debugging and identifying issues in your application.
Verification
After instrumenting the code, always verify that tracing is working.
Planning to evaluate your agent? Tracing must be working before you run
agent-evaluation. Complete verification below first.
- Run the instrumented code — execute the application or agent so that at least one traced operation fires
- Confirm traces are logged — use
mlflow.search_traces()orMlflowClient().search_traces()to check that traces appear in the experiment. If the trace is not found, trymlflow.flush_trace_async_logging()to flush the background queue.
import mlflow
mlflow.flush_trace_async_logging()
traces = mlflow.search_traces(locations=["<experiment_id>"])
print(f"Found {len(traces)} trace(s)")
assert len(traces) > 0, "No traces were logged — check tracking URI and experiment settings"
- Verify spans were captured — confirm the trace contains the expected spans, not just an empty shell:
trace = traces.iloc[0]
spans = mlflow.get_trace(trace.trace_id).data.spans
print(f"Trace has {len(spans)} span(s)")
for span in spans:
print(f" - {span.name} ({span.span_type})")
- Report the result — tell the user how many traces and spans were found and confirm tracing is working. On Databricks, include a clickable link to a verified trace from the run using the URL guidance in
references/databricks.md; an experiment link alone does not open the trace.
If no traces appear
Check these in order:
- Verification ran before traces were exported — trace logging is asynchronous by default, so an in-process
search_traces()right after the run can return zero before the background queue flushes (up to a few seconds later). Callmlflow.flush_trace_async_logging()before searching, as shown above. - Tracking URI not set — is
mlflow.set_tracking_uri(...)called before the agent run? Without this, traces go to a local./mlrunsdirectory instead of the configured server. - Autolog warnings — did
mlflow.autolog()or framework-specificmlflow.<framework>.autolog()raise any warnings during setup? Check stderr for patching failures. - Wrong experiment ID — verify the experiment ID passed to
search_traces()matches the experiment active when the code ran (mlflow.get_experiment_by_name(...)to confirm). - Network/auth issues — can the process reach the tracking server? Check for connection errors or 401/403 responses in logs.
For automated validation, use agent-evaluation/scripts/validate_tracing_runtime.py.
Feedback Collection
Log user feedback on traces for evaluation, debugging, and fine-tuning. Essential for identifying quality issues in production.
See references/feedback-collection.md for:
- Recording user ratings and comments with
mlflow.log_feedback() - Capturing trace IDs to return to clients
- LLM-as-judge automated evaluation
Reference Documentation
Production Deployment
See references/production.md for:
- Environment variable configuration
- Async logging for low-latency applications
- Sampling configuration (MLFLOW_TRACE_SAMPLING_RATIO)
- Lightweight SDK (
mlflow-tracing) - Docker/Kubernetes deployment
Advanced Patterns
See references/advanced-patterns.md for:
- Async function tracing
- Multi-threading with context propagation
- PII redaction with span processors
Distributed Tracing
See references/distributed-tracing.md for:
- Propagating trace context across services
- Client/server header APIs
Databricks (Unity Catalog storage)
See references/databricks.md for the required Databricks default: storing traces in Unity Catalog Delta tables by binding an experiment to a UnityCatalog trace location (catalog, schema, table prefix).
Next: debug from the traces you just captured
Tracing is now in place. When you move on to debug or improve the agent's behavior, read the spans first. Do not fall back to reading source code and output files alone. The trace shows what each step actually received, produced, and decided, which is the evidence source that pins down where behavior went wrong.
Load the fix-agent-issue skill for this. It grounds the diagnosis in the trace, what the agent did, what it should have done, and why, before any code change, and codifies the fix as a regression test so it sticks. Reach for it as soon as you start asking why the agent produced a given output, not only when someone explicitly reports a bug.