If you’re bundling your application from a Git directory, you can use plugins to inject Git metadata into the runtime bundle.
Bundling with esbuild
Use the dd-trace/esbuild plugin to automatically inject DD_GIT_REPOSITORY_URL and DD_GIT_COMMIT_SHA in your runtime bundle. See the plugin documentation.
Install dd-trace v5.68.0 or later for automatic Git tag injection.
const esbuild = require('esbuild');
+ const ddPlugin = require('dd-trace/esbuild');
esbuild.build({
entryPoints: ['index.js'],
bundle: true,
platform: 'node',
target: ['node20'],
format: 'cjs',
outfile: 'dist/bundle.js',
packages: 'external',
external: ['dd-trace', 'express']
+ plugins: [ddPlugin],
}).catch((e) => {
console.error(e);
process.exit(1);
});
Bundling with Rollup
Use rollup-plugin-inject-process-env to inject DD_GIT_REPOSITORY_URL and DD_GIT_COMMIT_SHA in your runtime bundle. Run the bundle step inside a Git repository so the script can read .git/ information.
+ const injectProcessEnv = require('rollup-plugin-inject-process-env');
+ const { DD_GIT_REPOSITORY_URL, DD_GIT_COMMIT_SHA } = getGitInfo();
module.exports = {
input: 'index.js',
output: {
file: 'dist/bundle.js',
format: 'cjs'
},
external: [
'express',
'dd-trace'
],
plugins: [
nodeResolve(),
commonjs()
+ injectProcessEnv({
+ DD_GIT_REPOSITORY_URL,
+ DD_GIT_COMMIT_SHA
+ })
]
};
The getGitInfo() function executes git commands to return DD_GIT_REPOSITORY_URL and DD_GIT_COMMIT_SHA variables. It needs to be executed in the git repository.
const { execSync } = require('child_process');
function getGitInfo() {
try {
const commitSha = execSync('git rev-parse HEAD', { encoding: 'utf8' }).trim();
const repositoryUrl = execSync('git config --get remote.origin.url', { encoding: 'utf8' }).trim();
console.log('Build-time Git metadata:', {
commitSha,
repositoryUrl,
});
return {
DD_GIT_REPOSITORY_URL: repositoryUrl,
DD_GIT_COMMIT_SHA: commitSha,
};
} catch (error) {
console.warn('Could not get Git metadata at build time:', error.message);
return {
DD_GIT_REPOSITORY_URL: '',
DD_GIT_COMMIT_SHA: '',
};
}
}
Bundling with webpack
Use the BannerPlugin to inject DD_GIT_REPOSITORY_URL and DD_GIT_COMMIT_SHA in your runtime bundle. Run the bundle step inside a Git repository so the script can read .git/ information.
+ const webpack = require('webpack');
+ const { DD_GIT_REPOSITORY_URL, DD_GIT_COMMIT_SHA } = getGitInfo();
module.exports = {
target: 'node',
entry: './index.js',
mode: 'production',
output: {
path: path.resolve(__dirname, 'dist'),
filename: 'bundle.js',
libraryTarget: 'commonjs2'
},
externals: [
'express',
'dd-trace'
],
plugins: [
+ new webpack.BannerPlugin({
+ raw: true,
+ entryOnly: true,
+ banner:
+ `process.env.DD_GIT_REPOSITORY_URL=${JSON.stringify(DD_GIT_REPOSITORY_URL)};` +
+ `process.env.DD_GIT_COMMIT_SHA=${JSON.stringify(DD_GIT_COMMIT_SHA)};`,
+ }),
]
};
The getGitInfo() function executes git commands to return DD_GIT_REPOSITORY_URL and DD_GIT_COMMIT_SHA variables. It needs to be executed in the git repository.
const { execSync } = require('child_process');
function getGitInfo() {
try {
const commitSha = execSync('git rev-parse HEAD', { encoding: 'utf8' }).trim();
const repositoryUrl = execSync('git config --get remote.origin.url', { encoding: 'utf8' }).trim();
console.log('Build-time Git metadata:', {
commitSha,
repositoryUrl,
});
return {
DD_GIT_REPOSITORY_URL: repositoryUrl,
DD_GIT_COMMIT_SHA: commitSha,
};
} catch (error) {
console.warn('Could not get Git metadata at build time:', error.message);
return {
DD_GIT_REPOSITORY_URL: '',
DD_GIT_COMMIT_SHA: '',
};
}
}
