Diagnostics Pagelet

Default diagnostics Pagelet used by the diagnostics and 500 Pagelet. This Pagelet is responsible for displaying additional diagnostics. By default the diagnostics Pagelet is provided with BigPipe. However, if you need a custom diagnostics you can extend this Pagelet. For example to change the default view.

Installation

The diagnostics Pagelet is distributed through the node package manager (npm).

npm install --save diagnostics-pagelet

Support

Got stuck? Or can't wrap your head around a concept or just want some feedback, we got a dedicated IRC channel for that on Freenode:

• IRC Server: irc.freenode.net
• IRC Room: #bigpipe

Still stuck? Create an issue. Every question you have is a bug in our documentation and that should be corrected. So please, don't hesitate to create issues, many of them.

Example

In this example the diagnostics Pagelet is extended with a custom view, which in turn is provided to a custom 500 Pagelet. BigPipe will automatically discover this extended version of the 500 Pagelet if it is provided to BigPipe alongside the other pagelets.

'use strict';

//
// Extend 500 Pagelet with custom Diagnostics Pagelet.
//
var Fivehundred = require('500-pagelet').extend({
  pagelets: {
    diagnostics: require('diagnostics-pagelet').extend({
      view: '/path/to/my/custom-view.html'
    })
  }
});

Debugging

The library makes use the diagnostics module from Pagelet. To display the diagnostics Pagelet specific debug messages, supply the following before running the program or

DEBUG=pagelet:diagnostics node ...

Testing

Tests are automatically run on Travis CI to ensure that everything is functioning as intended. For local development we automatically install a pre-commit hook that runs the npm test command every time you commit changes. This ensures that we don't push any broken code in to this project.

To run tests locally, make sure the development dependencies are installed.

npm test
npm run coverage

License

diagnostics-pagelet is released under MIT.