Skip to content

brandondoran/stats-reporter-webpack-plugin

Repository files navigation

Stats reporting plugin for webpack

Build Status Coverage Status dependencies Status devDependencies Status peerDependencies Status semantic-release Greenkeeper badge

Send the stats of a build to a reporting service. Currently DataDog is the only reporter implemented.

Installation

npm install --save-dev stats-reporter-webpack-plugin

Usage

const { StatsPlugin, DataDogStatsReporter } = require('stats-reporter-webpack-plugin');

module.exports = {
  plugins: [
    new StatsReporterPlugin({
      test:
      reporter: new DataDogStatsReporter({
        apiKey: process.env.DD_API_KEY,
        metricName: 'my-app.assets',
        tags: ['app:my-app', 'env:production'],
        test: /(js|css)$/
      })
    })
  ]
};

API

StatsReporterPlugin

new StatsReporterPlugin(options: StatsReporterPluginOptions);

StatsReporterPluginOptions fields

  • reporter: StatsReporter: The reporter to use for sending stats.

Stats Reporters

DataDogStatsReporter

new DataDogStatsReporter(options: DataDogStatsReporterOptions);
DataDogStatsReporterOptions fields
  • apiKey: string: Your DataDog API key
  • gzipSize?: boolean = true: Report gzipped size if true, uncompressed size if false
  • metricName: string: The base name for the metric
  • tags?: string[]: Custom tags for the metric. The following tags are always added:
    • chunk: the chunk name
    • type: the type of asset (js, css, etc)
  • test?: RegExp: Test to match files against. If not set, stats for all emitted assets will be sent.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •