Skip to content

Commit 0e45a98

Browse files
authored
llmobs: misc instrumentation doc improvements (#30684)
* llmobs: misc instrumentation doc improvements * remove banner
1 parent 2942cbc commit 0e45a98

File tree

7 files changed

+11
-14
lines changed

7 files changed

+11
-14
lines changed

config/_default/menus/main.en.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4653,7 +4653,7 @@ menu:
46534653
parent: llm_obs_instrumentation
46544654
identifier: llm_obs_instrumentation_custom
46554655
weight: 202
4656-
- name: API
4656+
- name: HTTP API
46574657
url: llm_observability/instrumentation/api
46584658
parent: llm_obs_instrumentation
46594659
identifier: llm_obs_instrumentation_api

content/en/llm_observability/instrumentation/_index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ You can visualize the interactions and performance data of your LLM applications
1313

1414
{{< img src="llm_observability/traces.png" alt="An LLM Observability trace displaying each span of a request" style="width:100%;" >}}
1515

16+
17+
## Further Reading
18+
19+
{{< partial name="whats-next/whats-next.html" >}}
20+
21+
1622
[1]: /llm_observability/auto_instrumentation
1723
[2]: /llm_observability/setup/api
18-
[3]: https://app.datadoghq.com/llm/traces
24+
[3]: https://app.datadoghq.com/llm/traces

content/en/llm_observability/instrumentation/api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: API Reference
2+
title: HTTP API Reference
33
aliases:
44
- /tracing/llm_observability/api
55
- /llm_observability/api
@@ -8,7 +8,7 @@ aliases:
88

99
## Overview
1010

11-
The LLM Observability API provides an interface for developers to send LLM-related traces and spans to Datadog. If your application is written in Python or Node.js, you can use the [LLM Observability SDKs][1].
11+
The LLM Observability HTTP API provides an interface for developers to send LLM-related traces and spans to Datadog. If your application is written in Python or Node.js, you can use the [LLM Observability SDKs][1].
1212

1313
The API accepts spans with timestamps no more than 24 hours old, allowing limited backfill of delayed data.
1414

content/en/llm_observability/instrumentation/auto_instrumentation.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ further_reading:
1111
text: 'Learn about the LLM Observability SDK for Python'
1212
---
1313

14-
<div class="alert alert-info">Datadog offers a variety of artificial intelligence (AI) and machine learning (ML) capabilities. The <a href="/integrations/#cat-aiml">AI/ML integrations on the Integrations page and the Datadog Marketplace</a> are platform-wide Datadog functionalities. <br><br> For example, APM offers a native integration with OpenAI for monitoring your OpenAI usage, while Infrastructure Monitoring offers an integration with NVIDIA DCGM Exporter for monitoring compute-intensive AI workloads. These integrations are different from the LLM Observability offering.</div>
1514

1615
{{< tabs >}}
1716
{{% tab "Python" %}}

content/en/llm_observability/instrumentation/custom_instrumentation.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ This page explains how to use the Datadog LLM Observability SDK's custom instrum
2525

2626
## Instrument an LLM application
2727

28-
<div class="alert alert-info">These instructions use the <a href="/llm_observability/setup/sdk">LLM Observability SDK for Python</a>. If your application is running in a serverless environment, follow the <a href="/llm_observability/setup/sdk/#aws-lambda-setup">serverless setup instructions</a>. </br></br> If your application is not written in Python, you can complete the steps below with API requests instead of SDK function calls.</div>
29-
3028
To instrument an LLM application:
3129

3230
1. [Install the LLM Observability SDK for Python][5].

content/en/llm_observability/instrumentation/sdk.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2283,6 +2283,3 @@ tracer.use('http', false) // disable the http integration
22832283
[11]: /tracing/trace_collection/compatibility/python/#integrations
22842284
[12]: /tracing/trace_collection/compatibility/python/#library-compatibility
22852285
[13]: /llm_observability/instrumentation/auto_instrumentation/
2286-
[14]: /serverless/aws_lambda/installation/python/?tab=custom#installation
2287-
[15]: /llm_observability/quickstart?tab=python#trace-an-llm-application-in-aws-lambda
2288-
[16]: https://app.datadoghq.com/llm/settings/evaluations

content/en/llm_observability/quickstart.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,12 @@ title: Quickstart
33
aliases:
44
- /tracing/llm_observability/quickstart
55
further_reading:
6-
- link: '/llm_observability'
7-
tag: 'Documentation'
8-
text: 'Learn about LLM Observability'
96
- link: '/llm_observability/evaluations'
107
tag: 'Evaluations'
118
text: 'Configure Evaluations on your application'
129
- link: '/llm_observability/instrumentation/custom_instrumentation'
1310
tag: 'Custom Instrumentation'
14-
text: 'Custom instrumentation'
11+
text: 'Instrument your application with custom spans'
1512
---
1613

1714
This page demonstrates using Datadog's LLM Observability SDK to instrument a Python or Node.js LLM application.

0 commit comments

Comments
 (0)