firstandthird / hapi-dashboard Goto Github PK

View Code? Open in Web Editor NEW

2.0 6.0 2.0 73 KB

Hapi plugin for displaying metrics on a dashboard

JavaScript 79.76% HTML 20.24%

hapi-plugin

hapi-dashboard's Introduction

hapi-dashboard

Hapi plugin for displaying metrics on a dashboard

Installation

npm install --save hapi-dashboard

Usage

server.pack.register([
  { plugin: require('hapi-dashboard'), options: {
    //defaults shown below
    endpoint: '/dashboard'
    dashboards: {},
    ttl: 60*1000, //time to cache responses. 60 seconds
    concurrent: 20, //max metrics to process at once
    password: 'something', //password used to access dashboards
	favicon: 'favicon.png' // Also used as home screen icon for ios
  }}
], function(err) {
});

Dashboards Object

Dashboards object should look something like this:

{
  'dashboard-1': {
    name: 'Dashboard 1',
    metrics: {
      loggedIn: {
        value: function(server, done) {
          //perform some async call
          server.plugins.db.metrics.loggedInCount(function(err, result) {
            done(null, {
            name: 'Number of times a user logged in',
            value: result.total
          });
          }
        },
        ttl: 60
      }
    }
  }
}

hapi-dashboard's People

Contributors

Stargazers

Watchers

Forkers

majjihari my-hapi

hapi-dashboard's Issues

remove password protection

auto refresh

should we add a meta content refresh every minute?

pass in auth strategy

show last checked time on table

multiple columns

we have a use case to show total, last 30 days, last 7 days, yesterday, today. How should we handle this? Maybe on the dashboard level, we define columns that get passes to each metric?

@dawnerd

allow / to be endpoint

currently, if I set endpoint: '/', hapi throws an error

password protection

very simple, pass in the password via options. build a simple password protection page, set a cookie on post and check the cookie on the dashboard pages.

sorted csv export comes back with json

from the csv:

json export

/{{endpoint}}.json
/{{endpoint}}/{{name}}.json

similar to csv

set this inside value function to the request

if ttl = 0, hapi throws an error

log

we should log when data is fetched with a 'dashboard' tag. log the name of the dashboard and the metric name

500 error in handler

Pretty sure it's erroring out because Hapi is defined in devDeps. We should also just use Boom for error responses instead of the outdated Hapi.error

{"statusCode":500,"payload":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred"},"headers":{}},"path":"/_dashboard/circles.csv","method":"get","payload":null,"stack":"TypeError: Cannot call method 'notFound' of undefined\n at Object.exports.dashboard (/app/node_modules/hapi-dashboard/lib/handler.js:29:29)

support passing back html as a value

be able to return multiple metrics from a single call

there are some instances where we want to return multiple metrics for a single call. We need to think through how to tackle it. One way would be to return something like:

done(null, [ { name: 'Blah', value: 123 }, { name: 'Blah2', value: 456 }]);

and then have the top level metric name be a row with no value and then have the sub metrics indented in on the table. Thoughts @dawnerd ?

MVP

need to be able to easily run a bunch of queries and show them in a data table.
will allow multiple dashboards
each metric should be queried in parallel
metrics should be cached by a given ttl (look into catbox-mongodb) - should we cache each query or the whole output?
implementation details in the readme

Next Rev

date ranges (need to think through how to handle this)
password protection
multiple widget types (graphs?)