-
Notifications
You must be signed in to change notification settings - Fork 403
feat(llmobs): auto-tag git commit sha and repository url on spans and… #9446
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
gsvigruha
wants to merge
3
commits into
master
Choose a base branch
from
gergely.svigruha/tracing-collect-git
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| 'use strict' | ||
|
|
||
| const fs = require('node:fs') | ||
| const path = require('node:path') | ||
|
|
||
| const getGitMetadata = require('../git_metadata') | ||
| const { getCommitSHA, getRepositoryUrl, isGitAvailable } = require('../plugins/util/git') | ||
| const { filterSensitiveInfoFromRepository } = require('../plugins/util/url') | ||
|
|
||
| /** | ||
| * @typedef {{ commitSHA: string | undefined, repositoryUrl: string | undefined }} GitMetadata | ||
| * Cache enabled and disabled results independently: a disabled first call must not | ||
| * short-circuit a later enabled initialization in the same process (mirrors git_metadata.js). | ||
| * @type {{ enabled?: GitMetadata, disabled?: GitMetadata }} | ||
| */ | ||
| const cache = {} | ||
|
|
||
| /** | ||
| * Resolve the git commit sha and repository url to tag LLMObs spans and | ||
| * experiments with. Widens coverage beyond the APM file/env resolver: in a | ||
| * typical local dev checkout the `DD_GIT_*` env vars and `git.properties` file | ||
| * aren't present, so we fall back to the `git` CLI for whatever the file/env | ||
| * reads missed. Both sources run at most once and the result is cached for the | ||
| * process lifetime, so the CLI subprocess never touches a hot path. Honors | ||
| * `DD_TRACE_GIT_METADATA_ENABLED`. | ||
| * | ||
| * @param {import('../config/config-types').ConfigProperties} config | ||
| * @returns {GitMetadata} | ||
| */ | ||
| function resolveLLMObsGitMetadata (config) { | ||
| if (!config.DD_TRACE_GIT_METADATA_ENABLED) { | ||
| cache.disabled ??= { commitSHA: undefined, repositoryUrl: undefined } | ||
| return cache.disabled | ||
| } | ||
| if (cache.enabled) return cache.enabled | ||
|
|
||
| let { commitSHA, repositoryUrl } = getGitMetadata(config) | ||
|
|
||
| // Only spawn the CLI when the file/env reads left something missing and we are | ||
| // inside a git checkout with git installed. Gating on the .git folder keeps | ||
| // no-repo production images (git present, no checkout) from spawning | ||
| // `git rev-parse` and emitting per-startup "not a git repository" error logs. | ||
| if (!commitSHA || !repositoryUrl) { | ||
| const gitFolder = config.DD_GIT_FOLDER_PATH ?? path.join(process.cwd(), '.git') | ||
| if (fs.existsSync(gitFolder) && isGitAvailable()) { | ||
| commitSHA ||= getCommitSHA() || undefined | ||
| repositoryUrl ||= filterSensitiveInfoFromRepository(getRepositoryUrl()) || undefined | ||
| } | ||
| } | ||
|
|
||
| cache.enabled = { commitSHA, repositoryUrl } | ||
| return cache.enabled | ||
| } | ||
|
|
||
| module.exports = resolveLLMObsGitMetadata |
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With the default
DD_TRACE_GIT_METADATA_ENABLED=true, realuseLlmObs()tests run from this git checkout will now addgit.commit.shaandgit.repository_urlto every formatted LLMObs span, butpackages/dd-trace/test/llmobs/util.jsstill exact-matches the tag array length and expected entries. Existing SDK/plugin tests that callassertLlmObsSpanEventwithout git tags will fail unless the helper accounts for these auto tags or the tests disable git metadata.Useful? React with 👍 / 👎.