grunt-ot-webpagetest v1.0.2

grunt-ot-webpagetest

Grunt task for running against the WebPageTest API and firing the results into Hipchat and Logstash/StatsD

Getting Started

This plugin is compatible with Grunt 0.4.1 to 1.0.1.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-ot-webpagetest --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-ot-webpagetest');

The 'ot-webpagetest' Task

ot-webpagetest requires the following parameters to be set in your Gruntfile.js config:

ot-webpagetest: {
  google: {
    options: {
      testUrl: 'http://google.com',
      apiKey: 'API_KEY_HERE',
      // These options are passed through to the webpagetest-api module
      wpt: {
        runs: 1,
        location: 'Dulles:Chrome'
      },
      // Below options are optional
      instanceUrl: 'www.webpagetest.org',
      hipchat: {
        apiKey: 'API_KEY_HERE',
        roomId: 12345
      },
      logstash: {
        host: 'localhost',
        port: 6379
      },
      statsd: {
        host: 'localhost',
        port: 8125,
        prefix: 'PREFIX_HERE'
      }
    }
  }
}

With these configuration properties set, you can add ot-webpagetest to your default tasks list. That'll look something like this:

grunt.registerTask('default', ['jshint', 'ot-webpagetest']);