yslow-data-service

yslow-data-service

A Node package for persisting web performance data from YSlow to a MongoDB database.

For a YSlow data REST interface see yslow-data-rest-api.

Requirements

• MongoDB

Installation

npm install --save yslow-data-service

Usage

var yslow = require('yslow-data-service');

Store a new result:

var data = {
  v: "3.1.8",
  w: 510283,
  o: 76,
  u: "http://www.bbc.co.uk/",
  r: 87,
  i: "ydefault",
  lt: 1706
}

yslow.results.create(data, function (err, result) {
  // ...
});

Retrieve all stored results:

yslow.results.all(function (err, results) {
  // ...
});

Retrieve all results for a given URL:

yslow.results.all({url: 'http://www.example.com'}, function (err, results) {
  // ...
});

Retrieve the latest result:

yslow.results.latest(function (err, result) {
  // ...
});

Retrieve the latest result for a URL:

yslow.results.latest({url: 'http://www.example.com'}, function (err, result) {
  // ...
});

Retrieve a result by its ID:

yslow.results.findById('some_id', function (err, result) {
  // ...
});

Remove all results:

yslow.results.removeAll(function (err) {
  // ...
});

Remove a result by its ID:

yslow.results.removeById('some_id', function (err) {
  // ...
});

Retieve an array of unique URLs that are stored:

yslow.urls.all(function (err, urls) {
  // ...
});

Configuration

By default the package is configured to use a MongoDB database at mongodb://127.0.0.1:27017/yslow. To change this, set the environment variable YSLOW_DATA_DB e.g.

EXPORT YSLOW_DATA_DB="mongodb://127.0.0.1:27017/some_db"