Guidelines

Important: Follow all guidelines listed here when following hyperlinks to other steps.

1. Only add Datadog Agent Observability and Datadog tracer-related code. Unless for the purposes of manual instrumentation, do not modify unrelated code.
2. If being run in a monorepo or project with multiple services or instrumentation targets, confirm with the user which service or sub-project should be instrumented with Agent Observability.
3. Install the latest Datadog SDKs. If it is already installed, check with the user if it is ok to update the dependency.

Pre-requisites

1. A Datadog API key is required to send Agent Observability data to Datadog. Without an API key, the user will not receive Agent Observability data, so this is a hard requirement. If the user has not provided one already and does not wish to provide one, continue instrumenting their application, making sure in an explicit call-out at the end that they must set it, and point them to where it can be set.
2. Determine the programming language and framework being used in the application to instrument. This is important for correctly instrumenting the application.

Environment variables

All environment variables should be set either before the main application process starts up, or as the first lines of the application entrypoint.

These environment variables should not be inlined. Rather, they should be read from the process directly.

• For local development, set them in an appropriate .env, or similar, file for the application and the language it is written in, making sure those are populated when the Agent Observability SDK is initiated (see the language-specific guides for each)
• For non-local development, also let the user know which environment variables they will need to set

API Key

This is critical. Set the API key with the following environment variable.

DD_API_KEY=<provided-dd-api-key>

Enable Agent Observability

This is critical. Set the following environment variables to properly enable Agent Observability.

DD_LLMOBS_ENABLED=true
DD_LLMOBS_AGENTLESS_ENABLED=true

Agent Observability application name

This is strongly suggested. If the user provided an application name (or DD_LLMOBS_ML_APP) as part of the initial prompt, use that value. Otherwise, use a logical name based on the folder, repository, or project name.

DD_LLMOBS_ML_APP=<provided-or-inferred-application-name>

Datadog site

This is optional. Set the Datadog site, corresponding to the datacenter associated with the user’s API key. If not provided (possibly via DD_SITE), inform the user that the site of datadoghq.com will be used. If a value is provided, set it as an environment variable.

DD_SITE=<provided-dd-site>

Instrument the application

Follow the instructions for the detected language:

Viewing traces

Let the user know that they can hit their application and see data in Datadog.

Mandatory: provide a permalink where the user can view the data associated with this application. This will take the form of

https://app.{dd_site}/llm/applications?query=@ml_app:{application_name}

Fill in the provided values:

1. dd_site - if the value was provided for Datadog site, use that value. Otherwise, use datadoghq.com.
2. application_name - use either the provided or inferred value from the Agent Observability application name section.