LLM obs Java SDK #30524
Merged
LLM obs Java SDK #30524
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Documentation Team ReviewThe documentation team has approved this pull request. Thank you for your contribution! |
Preview links (active after the
|
|
added DOCS-11546 to review |
gary-huang
approved these changes
Jul 21, 2025
domalessi
reviewed
Jul 21, 2025
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| Datadog's LLM Observability SDK for enhances the observability of your LLM applications. The SDK supports Python versions 3.7 and newer. | ||
| Datadog's LLM Observability SDK for enhances the observability of your LLM applications. |
There was a problem hiding this comment.
I think there's a missing word here after "for"? Or maybe "for" can be removed?
| @@ -49,6 +52,14 @@ For usage examples you can run from a Jupyter notebook, see the [LLM Observabili | |||
|
|
|||
| [1]: https://app.datadoghq.com/organization-settings/api-keys | |||
| {{% /tab %}} | |||
|
|
|||
| {{% tab "Java" %}} | |||
| - You have downloaded the latest [`dd-trace-java` JAR][1]. The LLM Observability SDK is supported in `dd-trace-java` v1.51.0+. | |||
There was a problem hiding this comment.
Very much a nit, but noting that this tense is inconsistent with the other tabs, which follow the form "Blahdiblah is installed" vs "You have installed".
|
|
||
| `DD_SITE` | ||
| : required - _string_ | ||
| <br />The Datadog site to submit your LLM data. Your site is {{< region-param key="dd_site" code="true" >}}. |
There was a problem hiding this comment.
Not sure if this is the best rework but trying to avoid the dangling preposition of "The Datadog site to submit your LLM data to" and the awkwardness of "The Datadog site to which to submit your LLM data."
Suggested change
| <br />The Datadog site to submit your LLM data. Your site is {{< region-param key="dd_site" code="true" >}}. | |
| <br />Destination Datadog site for LLM data submission. Your site is {{< region-param key="dd_site" code="true" >}}. |
|
|
||
| `DD_SITE` or `dd.site` | ||
| : required - _string_ | ||
| <br />The Datadog site to submit your LLM data. Your site is {{< region-param key="dd_site" code="true" >}}. |
There was a problem hiding this comment.
Suggested change
| <br />The Datadog site to submit your LLM data. Your site is {{< region-param key="dd_site" code="true" >}}. | |
| <br />Destination Datadog site for LLM data. Your site is {{< region-param key="dd_site" code="true" >}}. |
|
|
||
| ### Starting a span | ||
|
|
||
| There are several different methods to start a span, based on the kind of span that you are starting. See the [Span Kinds documentation][1] for a list of supported span kinds. |
There was a problem hiding this comment.
Suggested change
| There are several different methods to start a span, based on the kind of span that you are starting. See the [Span Kinds documentation][1] for a list of supported span kinds. | |
| There are several methods to start a span, based on the kind of span that you are starting. See the [Span Kinds documentation][1] for a list of supported span kinds. |
Comment on lines
1423
to
1428
| : required - `CharSequence` | ||
| <br /> The name of the metric | ||
|
|
||
| `value` | ||
| : required - `int`, `long`, or `double` | ||
| <br /> The value of the metric |
There was a problem hiding this comment.
Suggested change
| : required - `CharSequence` | |
| <br /> The name of the metric | |
| `value` | |
| : required - `int`, `long`, or `double` | |
| <br /> The value of the metric | |
| : required - `CharSequence` | |
| <br /> The name of the metric. | |
| `value` | |
| : required - `int`, `long`, or `double` | |
| <br /> The value of the metric. |
Comment on lines
1474
to
1478
| <br /> The key of the tag | ||
|
|
||
| `value` | ||
| : required - `int`, `long`, `double`, `boolean`, or `String` | ||
| <br /> The value of the tag |
There was a problem hiding this comment.
Suggested change
| <br /> The key of the tag | |
| `value` | |
| : required - `int`, `long`, `double`, `boolean`, or `String` | |
| <br /> The value of the tag | |
| <br /> The key of the tag. | |
| `value` | |
| : required - `int`, `long`, `double`, `boolean`, or `String` | |
| <br /> The value of the tag. |
|
|
||
| `errorMessage` | ||
| : required - `String` | ||
| <br /> The message of the error |
There was a problem hiding this comment.
Suggested change
| <br /> The message of the error | |
| <br /> The message of the error. |
|
|
||
| `error` | ||
| : required - `boolean` | ||
| <br /> `true` if the span errored |
There was a problem hiding this comment.
Suggested change
| <br /> `true` if the span errored | |
| <br /> `true` if the span errored. |
|
|
||
| `tags` | ||
| : optional - `Map<String, Object>` | ||
| <br />A dictionary of string key-value pairs that users can add as tags regarding the evaluation. For more information about tags, see [Getting Started with Tags][3]. |
There was a problem hiding this comment.
Suggested change
| <br />A dictionary of string key-value pairs that users can add as tags regarding the evaluation. For more information about tags, see [Getting Started with Tags][3]. | |
| <br />A dictionary of string key-value pairs used to tag the evaluation. For more information about tags, see [Getting Started with Tags][1]. |
domalessi
approved these changes
Jul 22, 2025
Co-authored-by: domalessi <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
Additional notes