text stringlengths 0 59.1k |
|---|
For more control, configure observability explicitly with `VoltOpsClient`: |
```typescript |
import { VoltAgent, VoltOpsClient } from "@voltagent/core"; |
import { Agent } from "@voltagent/core"; |
import { openai } from "@ai-sdk/openai"; |
const supportAgent = new Agent({ |
name: "Support Agent", |
model: openai("gpt-4"), |
instructions: "Help users with their questions", |
}); |
new VoltAgent({ |
agents: { |
supportAgent, |
}, |
voltOpsClient: new VoltOpsClient({ |
publicKey: process.env.VOLTAGENT_PUBLIC_KEY!, |
secretKey: process.env.VOLTAGENT_SECRET_KEY!, |
}), |
}); |
``` |
Run one request through your agent, then open [console.voltagent.dev](https://console.voltagent.dev). |
If a trace does not appear, first confirm keys belong to the same project, restart after env changes, and check runtime logs for auth/export errors. |
</StepSection> |
## Advanced Options |
### Add Metadata to Traces |
Attach IDs so filtering and debugging is easier: |
```typescript |
const agent = new Agent({ |
name: "Support Agent", |
model: openai("gpt-4"), |
instructions: "Help users with their questions", |
}); |
await agent.run("Hello", { |
userId: "user-123", |
conversationId: "conv-456", |
}); |
``` |
### Context Fields |
| Field | Description | |
| ---------------- | -------------------------------------- | |
| `userId` | Associates traces with a specific user | |
| `conversationId` | Groups traces by conversation | |
### Advanced Observability Configuration |
Use `createVoltAgentObservability` for service naming and sampling control: |
```typescript |
import { VoltAgent, createVoltAgentObservability } from "@voltagent/core"; |
new VoltAgent({ |
agents: { |
// your agents |
}, |
observability: createVoltAgentObservability({ |
serviceName: "my-app", |
serviceVersion: "1.0.0", |
voltOpsSync: { |
sampling: { |
strategy: "ratio", |
ratio: 0.5, // Sample 50% of traces |
}, |
maxQueueSize: 2048, |
maxExportBatchSize: 512, |
scheduledDelayMillis: 5000, |
exportTimeoutMillis: 30000, |
}, |
}), |
}); |
``` |
Recommended starting point: |
- `strategy: "always"` for local development |
- `strategy: "ratio"` in high-traffic production workloads |
### Configuration Options |
| Option | Type | Default | Description | |
| ---------------------------------- | -------------------------------------------------- | ------------- | -------------------------------------------- | |
| `serviceName` | string | `"voltagent"` | Name shown in VoltOps dashboard | |
| `serviceVersion` | string | - | Version tag for filtering traces | |
| `voltOpsSync.sampling.strategy` | `"always"` \| `"never"` \| `"ratio"` \| `"parent"` | `"always"` | Sampling strategy | |
| `voltOpsSync.sampling.ratio` | number | - | Sample rate (0-1) when strategy is `"ratio"` | |
| `voltOpsSync.maxQueueSize` | number | 2048 | Maximum spans queued before export | |
| `voltOpsSync.maxExportBatchSize` | number | 512 | Maximum spans per export batch | |
| `voltOpsSync.scheduledDelayMillis` | number | 5000 | Delay between exports (ms) | |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.