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

# observability

> Observability diagnostics and trace verification CLI

# praisonai obs

Observability diagnostics and management commands.

## Usage

```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
# Via praisonai wrapper
praisonai obs [COMMAND] [OPTIONS]

# Standalone (no wrapper needed)
python -m praisonai_tools.observability.cli [COMMAND] [OPTIONS]
```

## Commands

### doctor

Run observability health checks.

```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
praisonai obs doctor
praisonai obs doctor --json
```

| Option   | Description    |
| -------- | -------------- |
| `--json` | Output as JSON |

**Output:**

| Check                | Description                           |
| -------------------- | ------------------------------------- |
| Enabled              | Whether observability is initialized  |
| Active Provider      | Currently configured provider         |
| Connection           | Provider connectivity status          |
| Available Providers  | Providers with installed dependencies |
| Registered Providers | All known provider plugins            |

### verify

Verify traces are recorded in the observability backend using the provider's SDK.

```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
praisonai obs verify --provider langsmith --project "My First App"
praisonai obs verify --provider langsmith --project "My First App" --json
```

| Option       | Default     | Description                    |
| ------------ | ----------- | ------------------------------ |
| `--provider` | `langsmith` | Provider to verify             |
| `--project`  | `default`   | Project name to check          |
| `--limit`    | `5`         | Number of recent runs to check |
| `--json`     |             | Output as JSON                 |

Required environment variables:

```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
export LANGSMITH_API_KEY=lsv2_xxx
export LANGSMITH_ENDPOINT=https://api.smith.langchain.com  # or eu endpoint
```

**Output:**

The verify command checks each run for PraisonAI branding metadata (`praisonai.version`, `praisonai.framework`) and shows inputs/outputs status.

## Examples

### Quick Health Check

```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
python -m praisonai_tools.observability.cli doctor --json
```

```json theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
{
  "enabled": true,
  "provider": "langsmith",
  "connection_status": true,
  "connection_message": "LangSmith API key configured"
}
```

### Verify LangSmith Traces

```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
export LANGSMITH_API_KEY=lsv2_xxx
python -m praisonai_tools.observability.cli verify --project "My First App"
```

### Programmatic Usage

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
from praisonai_tools.observability import obs

obs.init(provider="langsmith")
results = obs.doctor()
print(results)
```

## What Gets Checked

* Provider initialization status
* API key configuration
* Backend connectivity
* Trace branding (`praisonai.version`, `praisonai.framework`)
* Input/output data capture
* Agent and workflow span recording

## Related

* [Observability Overview](/observability/overview) - All providers
* [LangSmith](/observability/langsmith) - LangSmith setup
* [Langfuse](/observability/langfuse) - Langfuse setup