Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions admins/advanced_configs/tracing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
title: "Tracing"
description: "Send LLM call traces to observability platforms to monitor and evaluate your Onyx deployment"
icon: "chart-line"
---

Tracing forwards every LLM call Onyx makes to an external observability platform so you can monitor latency,
token usage, and cost, and evaluate response quality. Onyx supports [Braintrust](https://www.braintrust.dev)
and [Langfuse](https://langfuse.com).

<Note>
Tracing is available on **self-hosted** deployments. It is not configurable on Onyx Cloud.
</Note>

## Connect a provider

<Steps>
<Step title="Navigate to the Tracing dashboard">
Click your user profile icon, select **Admin Panel**,
and open the **Tracing** tab under the **Usage** section of the sidebar.
</Step>

<Step title="Connect Braintrust and/or Langfuse">

Check warning on line 23 in admins/advanced_configs/tracing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (danswer) - vale-spellcheck

admins/advanced_configs/tracing.mdx#L23

Did you really mean 'Braintrust'?

Check warning on line 23 in admins/advanced_configs/tracing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (danswer) - vale-spellcheck

admins/advanced_configs/tracing.mdx#L23

Did you really mean 'Langfuse'?
You can connect either or both providers — traces are sent to every connected provider.

<Tabs tabs={["Braintrust", "Langfuse"]}>
<Tab title="Braintrust">
Create an API key in the [Braintrust dashboard](https://www.braintrust.dev/app) under **Settings → API Keys**.

In Onyx, click **Connect** on the Braintrust card and fill in:

- **API Key** — your Braintrust API key.
- **Project Name** *(optional)* — the Braintrust project traces are logged to. Defaults
to `Onyx`.
- **API URL** *(optional)* — only needed for self-hosted Braintrust or non-default
regions. Defaults to `https://api.braintrust.dev`.
</Tab>

<Tab title="Langfuse">
Create a key pair in your [Langfuse](https://cloud.langfuse.com) project settings under **Setup → API Keys**.

In Onyx, click **Connect** on the Langfuse card and fill in:

- **Secret Key** — your Langfuse secret key (`sk-...`).
- **Public Key** — your Langfuse public key (`pk-...`).
- **API Base URL** *(optional)* — defaults to the EU region
(`https://cloud.langfuse.com`). Set this for the US region, another region, or a self-hosted Langfuse instance.
</Tab>
</Tabs>

Onyx validates the credentials before saving. Once connected,
the card shows **Connected** and traces begin flowing within about 30 seconds — no restart required.
</Step>
</Steps>

## Disconnect a provider

Open the provider card, click the disconnect button, and confirm.
Onyx stops sending new traces to that provider immediately. Traces already delivered are unaffected.

## Configuring with environment variables

Configuring tracing from the Admin Panel is the recommended approach,
but Onyx also honors environment variables for backwards compatibility.
A provider configured through the UI takes precedence over its environment variables.

| Provider | Variable | Description |
| --- | --- | --- |
| Braintrust | `BRAINTRUST_API_KEY` | API key. Enables Braintrust tracing when set. |

Check warning on line 69 in admins/advanced_configs/tracing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (danswer) - vale-spellcheck

admins/advanced_configs/tracing.mdx#L69

Did you really mean 'Braintrust'?

Check warning on line 69 in admins/advanced_configs/tracing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (danswer) - vale-spellcheck

admins/advanced_configs/tracing.mdx#L69

Did you really mean 'Braintrust'?
| Braintrust | `BRAINTRUST_PROJECT` | Project name traces are logged to. Defaults to `Onyx`. |

Check warning on line 70 in admins/advanced_configs/tracing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (danswer) - vale-spellcheck

admins/advanced_configs/tracing.mdx#L70

Did you really mean 'Braintrust'?
| Braintrust | `BRAINTRUST_API_URL` | Custom API URL for self-hosted / non-default regions. |
| Langfuse | `LANGFUSE_SECRET_KEY` | Secret key. Required (with the public key) to enable Langfuse. |

Check warning on line 72 in admins/advanced_configs/tracing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (danswer) - vale-spellcheck

admins/advanced_configs/tracing.mdx#L72

Did you really mean 'Langfuse'?

Check warning on line 72 in admins/advanced_configs/tracing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (danswer) - vale-spellcheck

admins/advanced_configs/tracing.mdx#L72

Did you really mean 'Langfuse'?
| Langfuse | `LANGFUSE_PUBLIC_KEY` | Public key. Required (with the secret key) to enable Langfuse. |

Check warning on line 73 in admins/advanced_configs/tracing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (danswer) - vale-spellcheck

admins/advanced_configs/tracing.mdx#L73

Did you really mean 'Langfuse'?

Check warning on line 73 in admins/advanced_configs/tracing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (danswer) - vale-spellcheck

admins/advanced_configs/tracing.mdx#L73

Did you really mean 'Langfuse'?
| Langfuse | `LANGFUSE_HOST` | Base URL for a non-default region or self-hosted Langfuse. |

Check warning on line 74 in admins/advanced_configs/tracing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (danswer) - vale-spellcheck

admins/advanced_configs/tracing.mdx#L74

Did you really mean 'Langfuse'?

<Note>
Providers configured through environment variables appear in the Tracing dashboard as configured via environment.
You can adopt them into UI-managed configuration by connecting the provider from the Admin Panel.
</Note>
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,7 @@
"admins/advanced_configs/white_labeling",
"admins/advanced_configs/llm_access_controls",
"admins/advanced_configs/hook_extensions",
"admins/advanced_configs/tracing",
"admins/getting_started/slack_bot_setup",
"admins/miscellaneous/discord_bot"
]
Expand Down