Datadog Source Code Integration

If you are running your app in containers, Datadog can extract source code information directly from your images’ Docker labels. During build time, follow the Open Containers standard to add the git commit SHA and repository URL as Docker labels:

docker build . \
  -t my-application \
  --label org.opencontainers.image.revision=$(git rev-parse HEAD) \
  --label org.opencontainers.image.source=git-provider.example/me/my-repo

If you use Kubernetes, tag your deployed pod with a pod annotation using Datadog’s Tag Autodiscovery:

ad.datadoghq.com/tags: '{"git.commit.sha": "<FULL_GIT_COMMIT_SHA>", "git.repository_url": "git-provider.example/me/my-repo"}'

The git.commit.sha and git.repository_url are tagged in your telemetry.

Datadog can extract source code information directly from your serverless application according to your Serverless Monitoring for AWS Lambda setup.

To tag your traces, spans, and profiles with git.commit.sha and git.repository_url, configure the tracer with the DD_TAGS environment variable:

export DD_TAGS="git.commit.sha:<FULL_GIT_COMMIT_SHA>,git.repository_url:git-provider.example/me/my-repo"
./my-application start

Go embeds version control information in binaries starting in version 1.18.

Ensure your service meets all the following requirements:

• You are using a version of Go >= 1.18.
• You are using a version of the Datadog Go Tracer >= 1.48.0.
• Your application was built as a module using go.mod, and the module path is your code repository’s URL.

If you are a GitHub SaaS user, install Datadog’s GitHub integration on the GitHub integration tile to link your telemetry with your source code. When specifying permissions on the integration tile, enable Datadog read permissions to Contents.

By setting up the GitHub integration, you can see inline code snippets in Error Tracking. For more information, see Inline Source Code.

To link telemetry to your source code, Datadog collects metadata for every commit SHA from your Git repository with the datadog-ci git-metadata upload command.

When you run datadog-ci git-metadata upload within a Git repository, Datadog receives the repository URL, the commit SHA of the current branch, and a list of tracked file paths.

Validation

To ensure the data is being collected, run datadog-ci git-metadata upload in your CI pipeline.

You can expect to see the following output:

Reporting commit 007f7f466e035b052415134600ea899693e7bb34 from repository git@github.com:my-org/my-repository.git.
180 tracked file paths will be reported.
✅  Handled in 0.077 seconds.

You can directly access a trace in its source repository on GitHub in Error Tracking.

1. Navigate to APM > Error Tracking.
2. Click on an issue. The Issue Details panel appears on the right.
3. Under Latest Event, click the View button on the right of a frame or select View file, View Git blame, or View commit to be redirected to your source code management tool.

You can directly access a trace in its source repository on GitHub in the Continuous Profiler.

1. Navigate to APM > Profile Search.
2. Click on a profile and hover your cursor over a method in the flamegraph. A kebab icon with the More actions label appears on the right.
3. Click More actions > View in repo to open the trace in its source code repository.