telemetry

Telemetry Plugin

Display and send telemetry data as metrics to Datadog.

Yarn's build-plugin output.

Table of content

• Configuration
  • disabled
  • enableTracing
  • endPoint
  • output
  • prefix
  • tags
  • timestamp
  • filters
• Metrics
• Dashboard

Configuration

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)[];
}

disabled

default: false

Plugin will be disabled and won't track anything.

enableTracing

default: false

If true, it will add tracing data to the metrics.

But it is way more time consuming on the build.

And only supports Webpack and Esbuild (for now).

endPoint

default: "app.datadoghq.com"

To which endpoint will the metrics be sent.

output

default: true

If true, you'll get the creation of both json files:

• metrics.json: an array of all the metrics that would be sent to Datadog.
• timings.json: timing data for modules, loaders and plugins.

If a path, it will save the files at this location.

You can also pass an object of the form:

{
    destination: 'path/to/destination',
    timings: true,
    metrics: false,
}

To only output a specific file.

prefix

default: ""

Add a prefix to all the metrics sent.

tags

default: []

An array of tags to apply to all metrics.

timestamp

default: Date.now()

Which timestamp to use when submitting your metrics.

filters

default: [ filterTreeMetrics, filterSourcemapsAndNodeModules, filterMetricsOnThreshold ]

You can add as many filters as you want. They are just functions getting the metric as an argument.

Metric {
    metric: string; // Name of the metric.
    type: 'count' | 'size' | 'duration';
    value: number;
    tags: string[];
}

The filter should return the metric (with modifications if necessary) to include it, or return null to remove it.

It is a good way to filter out what you don't want to send.
We're adding a few default filters in order to reduce the noise.
When adding your own filters, it will remove these default filters.
You can still use them if you wish.

For example if you want to clean the assets' names, you can add this filter:

import { datadogWebpackPlugin, helpers } from '@datadog/webpack-plugin';

const defaultFilters = helpers.telemetry.filters;

datadogWebpackPlugin({
    auth: {
        apiKey: '<my-api-key>',
    },
    telemetry: {
        filters: [
            // Keep the default filters.
            ...defaultFilters,
            // Add a new filter to clean asset names.
            (metric) => {
                metric.tags = metric.tags.map((t) => {
                    if (/^assetName:/.test(t)) {
                        const newAssetName = t
                            .split('/')
                            // Only keep the name of the file.
                            .pop()
                            // Remove the hash from the name.
                            .replace(/(\.|-)[0-9a-f]{6,32}/, '');
                        return `assetName:${newAssetName}`;
                    }
                    return t;
                });
                return metric;
            },
        ],
    },
});

Metrics

Caution

Please note that this plugin can generate a lot of metrics, you can greatly reduce their number by tweaking the datadog.filters.

Here's the list of the metrics that are computed by default:

Metric	Tags	Type	Description
${prefix}.assets.count	[]	count	Number of assets.
${prefix}.assets.size	[assetName:${name}, assetType:${type}, entryName:${name}]	bytes	Size of an asset file.
${prefix}.assets.modules.count	[assetName:${name}, assetType:${type}, entryName:${name}]	count	Number of modules in a chunk.
${prefix}.compilation.duration	[]	milliseconds	Duration of the build.
${prefix}.entries.assets.count	[entryName:${name}]	count	Number of assets from an entry.
${prefix}.entries.count	[]	count	Number of entries.
${prefix}.entries.modules.count	[entryName:${name}]	count	Number of modules from an entry.
${prefix}.entries.size	[entryName:${name}]	bytes	Total size of an entry (and all its assets).
${prefix}.errors.count	[]	count	Number of errors generated by the build.
${prefix}.modules.count	[]	count	Number of modules.
${prefix}.modules.dependencies	[moduleName:${name}, moduleType:${type}, assetName:${name}, entryName:${name}]	count	Number of dependencies a module has.
${prefix}.modules.dependents	[moduleName:${name}, moduleType:${type}, assetName:${name}, entryName:${name}]	count	Number of dependents a module has.
${prefix}.modules.size	[moduleName:${name}, moduleType:${type}, assetName:${name}, entryName:${name}]	bytes	Size of a module.
${prefix}.plugins.meta.duration	[pluginName:datadogwebpackplugin]	milliseconds	Duration of the process of the Webpack Datadog plugin.
${prefix}.warnings.count	[]	count	Number of warnings generated by the build.

We also have some metrics that are only available to esbuild and webpack when the enableTracing option is set to true:

Metric	Tags	Type	Description
${prefix}.loaders.count	[]	count	Number of loaders.
${prefix}.loaders.duration	[loaderName:${name}]	milliseconds	Runtime duration of a loader.
${prefix}.loaders.increment	[loaderName:${name}]	count	Number of hit a loader had.
${prefix}.plugins.count	[]	count	Number of plugins.
${prefix}.plugins.duration	[pluginName:${name}]	milliseconds	Total runtime duration of a plugin.
${prefix}.plugins.hooks.duration	[pluginName:${name}, hookName:${name}]	milliseconds	Runtime duration of a hook.
${prefix}.plugins.hooks.increment	[pluginName:${name}, hookName:${name}]	count	Number of hit a hook had.
${prefix}.plugins.increment	[pluginName:${name}]	count	Number of hit a plugin had.

Dashboard

Tip

You can get this dashboard's configuration by running yarn cli dashboard --prefix <your.prefix> at the root of this repo.