Skip to content

Commit 419c51a

Browse files
committed
fix comments
Signed-off-by: Renaud Bourassa <[email protected]>
1 parent 60d01ff commit 419c51a

File tree

6 files changed

+21
-26
lines changed

6 files changed

+21
-26
lines changed

docs/source/extend/telemetry-exporters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Examples of existing telemetry exporters include:
7878
- **Patronus**: Exports traces to Patronus via OTLP
7979
- **Galileo**: Exports traces to Galileo via OTLP
8080
- **RagaAI Catalyst**: Exports traces to RagaAI Catalyst
81-
- **DBNL**: Exports traces to DBNL via OLTP
81+
- **DBNL**: Exports traces to DBNL via OTLP
8282

8383
## Quick Start: Your First Telemetry Exporter
8484

@@ -270,6 +270,7 @@ Before creating a custom exporter, check if your observability service is alread
270270

271271
| Service | Type | Installation | Configuration |
272272
|---------|------|-------------|---------------|
273+
| **DBNL** | `dbnl` | `pip install "nvidia-nat[opentelemetry]"` | API url + API token + project id |
273274
| **File** | `file` | `pip install nvidia-nat` | local file or directory |
274275
| **Langfuse** | `langfuse` | `pip install "nvidia-nat[opentelemetry]"` | endpoint + API keys |
275276
| **LangSmith** | `langsmith` | `pip install "nvidia-nat[opentelemetry]"` | endpoint + API key |
@@ -279,7 +280,6 @@ Before creating a custom exporter, check if your observability service is alread
279280
| **Phoenix** | `phoenix` | `pip install "nvidia-nat[phoenix]"` | endpoint |
280281
| **RagaAI/Catalyst** | `catalyst` | `pip install "nvidia-nat[ragaai]"` | API key + project |
281282
| **Weave** | `weave` | `pip install "nvidia-nat[weave]"` | project name |
282-
| **DBNL** | `dbnl` | `pip install "nvidia-nat[opentelemetry]"` | endpoint + API key + project id |
283283

284284
### Simple Configuration Example
285285

docs/source/workflows/observe/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ Each exporter has its own detailed configuration guide with complete setup instr
133133
- **[Catalyst](https://catalyst.raga.ai/)** - See [Observing with Catalyst](./observe-workflow-with-catalyst.md)
134134
- **Custom Exporters** - See [Adding Telemetry Exporters](../../extend/telemetry-exporters.md) for creating custom integrations
135135
- **[NVIDIA Data Flywheel Blueprint](https://build.nvidia.com/nvidia/build-an-enterprise-data-flywheel)** - See [Observing with Data Flywheel](./observe-workflow-with-data-flywheel.md)
136+
- **[DBNL](https://distributional.com/)** - See [Observing with DBNL](./observe-workflow-with-dbnl.md)
136137
- **[Dynatrace](https://dynatrace.com/)** - See [Observing with Dynatrace](./observe-workflow-with-dynatrace.md)
137138
- **File Export** - Built-in file-based tracing for local development and debugging
138139
- **[Galileo](https://galileo.ai/)** - See [Observing with Galileo](./observe-workflow-with-galileo.md)
@@ -142,7 +143,6 @@ Each exporter has its own detailed configuration guide with complete setup instr
142143
- **[Patronus](https://www.patronus.ai/)** - AI evaluation and monitoring platform
143144
- **[Phoenix](https://phoenix.arize.com/)** - See [Observing with Phoenix](./observe-workflow-with-phoenix.md)
144145
- **[W&B Weave](https://wandb.ai/site/weave/)** - See [Observing with W&B Weave](./observe-workflow-with-weave.md)
145-
- **[DBNL](https://distributional.com/)** - See [Observing with DBNL](./observe-workflow-with-dbnl.md)
146146

147147
For complete configuration examples and setup instructions, refer to the individual guides linked above or check the `examples/observability/` directory.
148148

@@ -152,6 +152,7 @@ For complete configuration examples and setup instructions, refer to the individ
152152
|----------|-----------|
153153
| Catalyst | Logging, Tracing |
154154
| Data Flywheel | Logging, Tracing |
155+
| DBNL | Logging, Tracing |
155156
| Dynatrace | Logging, Tracing |
156157
| Galileo | Logging, Tracing |
157158
| Langfuse | Logging, Tracing |
@@ -160,7 +161,6 @@ For complete configuration examples and setup instructions, refer to the individ
160161
| Patronus | Logging, Tracing |
161162
| Phoenix | Logging, Tracing |
162163
| W&B Weave | Logging, Tracing, W&B Weave Redaction, Evaluation Metrics |
163-
| DBNL | Logging, Tracing |
164164

165165
### NeMo Agent Toolkit Observability Components
166166

@@ -204,10 +204,10 @@ For complete information about developing and integrating custom telemetry expor
204204
205205
Observing with Catalyst <./observe-workflow-with-catalyst.md>
206206
Observing with Data Flywheel <./observe-workflow-with-data-flywheel.md>
207+
Observing with DBNL <./observe-workflow-with-dbnl.md>
207208
Observing with Dynatrace <./observe-workflow-with-dynatrace.md>
208209
Observing with Galileo <./observe-workflow-with-galileo.md>
209210
Observing with OTEL Collector <./observe-workflow-with-otel-collector.md>
210211
Observing with Phoenix <./observe-workflow-with-phoenix.md>
211212
Observing with W&B Weave <./observe-workflow-with-weave.md>
212-
Observing with DBNL <./observe-workflow-with-dbnl.md>
213213
```

docs/source/workflows/observe/observe-workflow-with-dbnl.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ This guide provides a step-by-step process to enable observability in a NeMo Age
2424

2525
## Step 1: Install DBNL
2626

27-
Visit [https://docs.dbnl.com/](https://docs.dbnl.com/) to install DBNL.
27+
Visit [https://docs.dbnl.com/get-started/quickstart](https://docs.dbnl.com/get-started/quickstart) to install DBNL.
2828

2929
## Step 2: Create a Project
3030

3131
Create a new Trace Ingestion project in DBNL. To create a new project in DBNL:
3232

33-
1. Navigate to your DBNL deployment (e.g. http://localhost:8080/)
33+
1. Navigate to your DBNL deployment (e.g. <http://localhost:8080/>)
3434
2. Go to Projects > + New Project
35-
3. Add a name for your project
35+
3. Name your project `nat-calculator`
3636
4. Add a LLM connection to your project
3737
5. Select Trace Ingestion as the project Data Source
3838
6. Click on Generate API Token and note down the generated **API Token**
@@ -67,8 +67,7 @@ general:
6767
tracing:
6868
otelcollector:
6969
_type: dbnl
70-
# The endpoint where you have deployed DBNL
71-
endpoint: ${DBNL_API_URL}/otel/v1/traces
70+
api_url: ${DBNL_API_URL}
7271
api_token: ${DBNL_API_TOKEN}
7372
project_id: ${DBNL_PROJECT_ID}
7473
```
@@ -95,6 +94,6 @@ As the workflow runs, telemetry data will start showing up in DBNL.
9594
Analyze the traces in DBNL. To analyze traces in DBNL:
9695

9796
1. Navigate to your DBNL deployment (e.g. http://localhost:8080/)
98-
2. Go to Projects > <your_project_name>
97+
2. Go to Projects > nat-calculator
9998

10099
For additional help, see the [DBNL docs](https://docs.dbnl.com/).

examples/observability/simple_calculator_observability/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,11 +253,11 @@ Transmit traces to Galileo for workflow observability.
253253

254254
### Analyze Traces with DBNL
255255

256-
[DBNL](https://www.distributional.com/) helps you undestand your agent by analyzing your traces.
256+
[DBNL](https://www.distributional.com/) helps you understand your agent by analyzing your traces.
257257

258258
1. Install DBNL:
259259

260-
Visit [https://docs.dbnl.com/](https://docs.dbnl.com/) to install DBNL.
260+
Visit [https://docs.dbnl.com/get-started/quickstart](https://docs.dbnl.com/get-started/quickstart) to install DBNL.
261261

262262
2. Create a trace ingestion project:
263263

examples/observability/simple_calculator_observability/configs/config-dbnl.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ general:
2727
tracing:
2828
dbnl:
2929
_type: dbnl
30-
# endpoint: ${DBNL_API_URL}/otel/v1/traces
31-
# api_token: ${DBNL_API_TOKEN}
32-
# project_id: ${DBNL_PROJECT_ID}
30+
api_url: ${DBNL_API_URL}
31+
api_token: ${DBNL_API_TOKEN}
32+
project_id: ${DBNL_PROJECT_ID}
3333

3434
functions:
3535
calculator_multiply:

packages/nvidia_nat_opentelemetry/src/nat/plugins/opentelemetry/register.py

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -198,9 +198,9 @@ async def galileo_telemetry_exporter(config: GalileoTelemetryExporter, builder:
198198
class DBNLTelemetryExporter(BatchConfigMixin, TelemetryExporterBaseConfig, name="dbnl"):
199199
"""A telemetry exporter to transmit traces to DBNL."""
200200

201-
endpoint: str = Field(description="The DBNL OTEL traces endpoint.", default="")
202-
api_token: str = Field(description="The DBNL API token.", default="")
203-
project_id: str = Field(description="The DBNL project id.", default="")
201+
api_url: str = Field(description="The DBNL API url.", default="http://localhost:8080/api")
202+
api_token: str = Field(description="The DBNL API token.")
203+
project_id: str = Field(description="The DBNL project id.")
204204

205205

206206
@register_telemetry_exporter(config_type=DBNLTelemetryExporter)
@@ -209,18 +209,14 @@ async def dbnl_telemetry_exporter(config: DBNLTelemetryExporter, builder: Builde
209209

210210
from nat.plugins.opentelemetry import OTLPSpanAdapterExporter
211211

212-
api_token = config.api_token or os.environ.get("DBNL_API_TOKEN")
213-
project_id = config.project_id or os.environ.get("DBNL_PROJECT_ID")
212+
api_token = config.api_token
213+
project_id = config.project_id
214214
headers = {
215215
"Authorization": f"Bearer {api_token}",
216216
"x-dbnl-project-id": project_id,
217217
}
218218

219-
endpoint = config.endpoint
220-
if not endpoint:
221-
api_url = os.environ.get("DBNL_API_URL") or "http://localhost:8080/api"
222-
endpoint = api_url.rstrip("/") + "/otel/v1/traces"
223-
print(endpoint)
219+
endpoint = config.api_url.rstrip("/") + "/otel/v1/traces"
224220

225221
yield OTLPSpanAdapterExporter(
226222
endpoint=endpoint,

0 commit comments

Comments
 (0)