Skip to content

joola/joola.io.express

Repository files navigation

joola.io.express Build Status Coverage Status

EXPERIMENTAL

Instant, real-time, back-end performance analytics for your Express.js app.

joola.io.express is a small middleware you can seamlessly plug into your expressjs app to log performance data on your app and later query it using expressive queries and visualizations. joola.io.express is based on the joola.io framework and uses [reflect.io] reflect.io as a free store for your website performance data. This means that data is securely stored, backed up and managed by reflect.io and its team.

If you prefer you can install your own copy of joola.io and save data on your premises.

Install

$ npm install joola.io.express

Basic Usage

  1. npm install joola.io.express
  2. In your app.js add:
app.use(require('joola.io.express')({
    readKey: 'READKEY',
    writeKey: 'WRITEKEY',
    host: 'http://reflect.io:8080'
  }
));
  1. Run your node app and navigate to: http://yourwebserver/analytics

Getting Read/Write Keys

Before you can start writing and reading data securely, you will need to obtain read/write keys from reflect.io.

If you wish to avoid registration, you can download and install your copy of joola.io.

Experimental

This is an Experimental package
Other than guaranteeing that any data collected is securely stored within our servers, there are no guarantees.

Contribute

We would love to get your help! We have outlined a simple Contribution Policy to support a transparent and easy merging of ideas, code, bug fixes and features.

If you're looking for a place to start, you can always go over the list of open issues, pick one and get started. If you're feeling lost or unsure, just let us know.

Contact

Contacting us is easy, ping us on one of these:

License

Copyright (c) 2012-2013 Joola Smart Solutions. MIT Licensed, see LICENSE for details.

About

Instant Analytics for Express.js

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published