@nodeward/zerocrash

ZeroCrash

For API only usage skip the Usage and Installation steps!

FEATURES

• Monitor users and behaviours on your live app
• Monitor app status, health, Memory usage and CPU
• Monitor API requests, events, response status and time
• Receive Alarms on Crashes/Exceptions and Unusual Traffic
• Debug and Fix Crashes from within the Dashboard

Usage

// Token acquired from the dashboard projects page
const TOKEN = '0ABCDEF12345678901234567890123456789012345678901234567890ABCDEF0';

// Ability to turn on/off any feature that we provide
const options = { alarm: true, events: true, benchmarks: true, crashReporting: true };

// Installing and Initializing the module
const ZeroCrash = require('@nodeward/zerocrash').install(TOKEN, options);

// Before including any route
app.use(ZeroCrash.requestHandler());

// Normal Express routes...
app.get('/', (req, res) => res.json({ message: 'hello world' });

// After including all routes
app.use(ZeroCrash.errorHandler());

Installation

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js.

Installation is done using the npm install command:

$ npm install @nodeward/zerocrash --save

API Usage

(for non-nodejs projects)

  ## !!Replace <token> with the token from the dashboard
  
  ## Endpoints Request
  curl -X POST \ 
      -d '{"endpoint": "/users/:id", "method": "GET", "startAt": "1544268184321", "end": "1544268181234", "ip": "181.215.95.235", "resStatusCode": "200", "resStatusMessage": "Success"}' \
      -H 'Token: <token>' \
      -H 'Content-Type: application/json' \
      'http://207.154.240.216:5555/library/metrics'

  ## Exceptions Request
  curl -X POST \ 
      -d '{"errMsg":"TypeError", "errName":"cannot read property 'length' of undefined", "filename": "app.js", "colno":"13", "lineno":"80", "pre_context":"let x = [1,2,3]", "context_line":"console.log(y.length)", "post_context":"console.log(`DONE ${x}`)", "function":"getLength"}' \
      -H 'Token: <token>' \
      -H 'Content-Type: application/json' \
      'http://207.154.240.216:5555/library/exceptions'

Security Issues

If you discover a security vulnerability in ZeroCrash, please see Security Policies and Procedures.

People

The original authors of ZeroCrash are Pierre Raii and Surge

List of all contributors

License

MIT