Datadog Build Plugins

A set of bundler plugins for:

• esbuild @datadog/esbuild-plugin
• Rollup @datadog/rollup-plugin
• Rspack @datadog/rspack-plugin
• Vite @datadog/vite-plugin
• Webpack @datadog/webpack-plugin

To interact with Datadog directly from your builds.

Note

If you want to upgrade from v1 to v2, please follow our migration guide.

Table of content

• Installation
• Usage
• Configuration
  • auth.apiKey
  • logLevel
  • customPlugins
• Features
  • Error Tracking
  • Telemetry
• Contributing
• License

Installation

• Yarn

yarn add -D @datadog/{{bundler}}-plugin

• NPM

npm install --save-dev @datadog/{{bundler}}-plugin

Usage

In your bundler's configuration file:

const { datadog{{Bundler}}Plugin } = require('@datadog/{{bundler}}-plugin');

export const config = {
    plugins: [
        datadog{{Bundler}}Plugin({
            // Configuration
        }),
    ],
};

Tip

It is best to have the plugin in the first position in order to report every other plugins.

Follow the specific documentation for each bundler:

• esbuild @datadog/esbuild-plugin
• Rollup @datadog/rollup-plugin
• Rspack @datadog/rspack-plugin
• Vite @datadog/vite-plugin
• Webpack @datadog/webpack-plugin

Configuration

Full configuration object

{
    auth?: {
        apiKey?: string;
    };
    customPlugins?: (options: Options, context: GlobalContext, log: Logger) => UnpluginPlugin[];
    logLevel?: 'debug' | 'info' | 'warn' | 'error' | 'none';
    errorTracking?: {
        disabled?: boolean;
        sourcemaps?: {
            bailOnError?: boolean;
            dryRun?: boolean;
            intakeUrl?: string;
            maxConcurrency?: number;
            minifiedPathPrefix: string;
            releaseVersion: string;
            service: string;
        };
    };
    telemetry?: {
        disabled?: boolean;
        enableTracing?: boolean;
        endPoint?: string;
        output?: boolean
            | string
            | {
                destination: string;
                timings?: boolean;
                metrics?: boolean;
            };
        prefix?: string;
        tags?: string[];
        timestamp?: number;
        filters?: ((metric: Metric) => Metric | null)[];
    };
}

auth.apiKey

default null

In order to interact with Datadog, you have to use your own API Key.

logLevel

default: 'warn'

Which level of log do you want to show.

customPlugins

default: []

This is a way for you to inject any Unplugin Plugin you want.

It's particularly useful to use our global, shared context of the main plugin.

Or to prototype some new plugins in the same environment.

{
    customPlugins: (options, context, log) => [{
        name: 'my-custom-plugin',
        buildStart() {
            log.info('Hello world');
        },
    }];
}

Your function will receive three arguments:

• options: The options you passed to the main plugin (including your custom plugins).
• context: The global context shared accross our plugin.
• log: A logger to display messages.

The context is a shared object that is mutated during the build process.

Full context object

type GlobalContext = {
    // Mirror of the user's config.
    auth?: {
        apiKey?: string;
    };
    // More details on the currently running bundler.
    bundler: {
        name: string;
        fullName: string; // Including its variant.
        outDir: string; // Output directory
        // Added in `buildStart`.
        rawConfig?: any;
        variant: string; // Major version of the bundler (webpack 4, webpack 5), empty string otherwise.
    };
    // Added in `writeBundle`.
    build: {
        errors: string[];
        warnings: string[];
        // The list of entries used in the build.
        entries ? : {
            filepath: string;
            inputs: Input[],
            name: string;
            outputs: Output[]
            size: number;
            type: string,
        } [];
        // The list of inputs used in the build.
        inputs ? : {
            filepath: string;
            dependencies: Input[];
            dependents: Input[]
            name: string;
            size: number;
            type: string,
        } [];
        // The list of outputs generated by the build.
        outputs ? : {
            filepath: string;
            name: string;
            size: number;
            type: string,
            // Sourcemaps will use Outputs as their Inputs.
            inputs: (Input | Output)[]
        } [];
        start?: number;
        end?: number;
        duration?: number;
        writeDuration?: number;
    };
    cwd: string;
    // Added in `buildStart`.
    git?: {
        hash: string;
        remote: string;
        trackedFilesMatcher: [TrackedFilesMatcher](/packages/plugins/git/trackedFilesMatcher.ts);
    };
    inject: (item: { type: 'file' | 'code'; value: string; fallback?: @self }) => void;
    start: number;
    version: string;
}

📝 Full documentation ➡️

Features

Error Tracking

Interact with Error Tracking directly from your build system.

📝 Full documentation ➡️

Configuration

datadogWebpackPlugin({
    errorTracking?: {
        disabled?: boolean,
        sourcemaps?: {
            bailOnError?: boolean,
            dryRun?: boolean,
            intakeUrl?: string,
            maxConcurrency?: number,
            minifiedPathPrefix: string,
            releaseVersion: string,
            service: string,
        },
    }
});

Telemetry

Display and send telemetry data as metrics to Datadog.

📝 Full documentation ➡️

Configuration

datadogWebpackPlugin({
    telemetry?: {
        disabled?: boolean,
        enableTracing?: boolean,
        endPoint?: string,
        output?: boolean
            | string
            | {
                destination: string,
                timings?: boolean,
                metrics?: boolean,
            },
        prefix?: string,
        tags?: string[],
        timestamp?: number,
        filters?: ((metric: Metric) => Metric | null)[],
    }
});

Contributing

Check out CONTRIBUTING.md for more information about how to work with the build-plugins ecosystem.

License

MIT

Back to top ⬆️