hapi-raygun

Raygun error reporting as a Hapi.js plugin

Usage no npm install needed!

<script type="module">
  import hapiRaygun from 'https://cdn.skypack.dev/hapi-raygun';
</script>

README

hapi-raygun

npm version dependencies status npm downloads npm downloads

A Hapi.js plugin for reporting server-side errors to Raygun.

Usage

var Hapi = require("hapi");
var Raygun = require("hapi-raygun");

var server = new Hapi.Server();

server.register({
  register: Raygun,
  options: {
    apiKey: /* Your Raygun API key */
  }
}, function (err) {
  if (err) {
    throw err;
  }

  server.start(function () {
    console.log("Server running at:", server.info.uri);
  });
});

Configuration

  • options
    • apiKey - String. Your Raygun API key. If not set, no error handler will be registered and plugin will be a no-op.
    • filters - Array, default ["password"]. Array of strings to filter from payload sent to Raygun (see this for example)
    • log - Boolean, default false. If true, uses server.log() to log when plugin logs calls to Raygun. Depends on logging to be setup properly, i.e. use good and good-console configured to log server log events.
    • user - Function. Takes a callback accepting a single argument and returning the request's user context. See Raygun documentation for user callback
    • version - String. Format of "n.n.n.n" where n is a number. See raygun docs