> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agnost.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# DSPy

> Capture traces from DSPy modules and optimizers

## Choose a setup method

| Method              | Use it when                                                                    |
| ------------------- | ------------------------------------------------------------------------------ |
| **Agnost AI skill** | You want your coding agent to inspect the app, make the change, and verify it. |
| **Agnost AI SDK**   | You want explicit control over the interaction boundaries and fields.          |
| **OpenTelemetry**   | The framework already emits useful spans or you operate an OTel pipeline.      |

Start with one method for a call path. Combining SDK tracking with framework
OpenTelemetry on the same call can create duplicate interactions.

## Recommended: Agnost AI skill

<Note>
  **Recommended.** Choose this path when you want your coding agent to inspect the
  project, select a supported transport, make the smallest instrumentation change,
  send a test event, and verify that it reached Agnost AI.
</Note>

Install the skill once in your coding-agent environment:

```bash theme={null}
npx skills add AgnostAI/skills --skill agnost-ai
```

Run the framework-specific prompt below from the application root. Review the
resulting diff before deploying it.

```text theme={null}
Use the agnost-ai skill to add Agnost AI analytics to this DSPy application.
Org ID: your-org-id
Instrument the real DSPy module call and verify one fresh interaction.
```

## Manual setup: Agnost AI SDK

```bash theme={null}
pip install agnost
```

```python theme={null}
import agnost

agnost.init("your-org-id")
interaction = agnost.begin(user_id="u-42", agent_name="dspy-qa", input=question)
try:
    result = qa(question=question)
    interaction.end(output=result.answer)
except Exception as exc:
    interaction.end(output=str(exc), success=False)
    raise
finally:
    agnost.shutdown()
```

## Manual setup: OpenTelemetry

### Install

```bash theme={null}
pip install dspy-ai openinference-instrumentation-dspy \
            opentelemetry-sdk opentelemetry-exporter-otlp-proto-http
```

### Setup

```python theme={null}
import os, dspy
from openinference.instrumentation.dspy import DSPyInstrumentor
from openinference.instrumentation import using_attributes
from opentelemetry import trace
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor
from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter

os.environ["OTEL_EXPORTER_OTLP_ENDPOINT"] = "https://otel.agnost.ai"
os.environ["OTEL_EXPORTER_OTLP_HEADERS"] = "X-Agnost-Org-ID=<your-org-id>"

provider = TracerProvider()
provider.add_span_processor(BatchSpanProcessor(OTLPSpanExporter()))
trace.set_tracer_provider(provider)
DSPyInstrumentor().instrument(tracer_provider=provider)

dspy.settings.configure(lm=dspy.LM("openai/gpt-4o-mini"))
qa = dspy.Predict("question -> answer")

with using_attributes(session_id="sess-123", user_id="u-42"):
    qa(question="What is OTel?")
```

Module/program/optimizer spans nest properly and carry `dspy.module`, `dspy.signature`, plus standard OpenInference `input.value` / `output.value`. Pair with a provider instrumentation (e.g. `OpenAIInstrumentor`) for the deepest trace tree.

### Alternative: MLflow

If you already use MLflow, `mlflow.dspy.autolog()` works too: Agnost AI reads `mlflow.spanInputs` / `mlflow.spanOutputs`.

### Verify

Run one DSPy module call, then open **Events** in Agnost AI. Confirm `dspy.module` and input/output attributes are present.

### Troubleshooting

* Instrument DSPy before calling modules.
* Pair DSPy instrumentation with provider instrumentation if you need LLM-level spans.
* Confirm `OTEL_EXPORTER_OTLP_HEADERS` contains `X-Agnost-Org-ID=<your-org-id>`.

### References

* [Enable OpenTelemetry export](https://dspy.ai/tutorials/observability/)
* [Add custom metadata](https://mlflow.org/docs/latest/genai/tracing/app-instrumentation/manual-tracing/)

## Next steps

* [Conversations](/using-conversations): review the complete DSPy interaction.
* [Events](/using-events): inspect module and model activity.
* [Intents](/using-intents): organize production conversations by what users wanted.