metricio / metricio

⚡ Simple framework for easily creating dashboards to display metrics ⚡

Metricio (🔊) is a dashboard framework that helps you display metrics and monitor systems and APIs.

Simple to get started and quick to create build screens for all your teams.

Metricio has a similar design and architecture to Dashing, which used to be my "goto" framework for dashboards. Unfortunately, Dashing is no longer maintained. However, if you have a preference to writing CoffeeScript and Ruby then that framework is still awesome!

Metricio allows you to:

• Build widgets with React components
• Create jobs with Node.js and async/await
• Support for multiple dashboards
• CRON like scheduling with node-scheduler
• Caching handled with Redis
• Event-based communication with socket.io
• Number formatting with Numeral

The UI aims to use a little resource as possible. Enabling your dashboards to run without crashing for prolonged lengths of time on even the most neglected Raspberry Pi.

See the Docs for requirements, setup and customisation.

Install

npm install

Start - Develop

npm run start

Test

npm run test

Start - Production

npm run production

Lint Project

npm run lint

Contributing

Any help is welcomed and appreciated.

License

Distributed under the MIT license

metricio's Issues

v1.2.0 Start Script Failure

Hello 👋

Working on a MacOS 10.14.5 and after a clean download of Metricio (downloaded the latest zip) I am having issues when running:

npm i && npm run start

Specifically, I am getting this:

> [email protected] start /Users/erubioteruel/Documents/GitHub/DevOps-Dashboard
> babel-node app.js

/Users/erubioteruel/Documents/GitHub/DevOps-Dashboard/app.js:1
import { createServer } from 'http';
       ^

SyntaxError: Unexpected token {
    at Module._compile (internal/modules/cjs/loader.js:721:23)
    at loader (/Users/erubioteruel/Documents/GitHub/DevOps-Dashboard/node_modules/babel-register/lib/node.js:144:5)
    at Object.require.extensions.(anonymous function) [as .js] (/Users/erubioteruel/Documents/GitHub/DevOps-Dashboard/node_modules/babel-register/lib/node.js:154:7)
    at Module.load (internal/modules/cjs/loader.js:653:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:593:12)
    at Function.Module._load (internal/modules/cjs/loader.js:585:3)
    at Function.Module.runMain (internal/modules/cjs/loader.js:829:12)
    at Object.<anonymous> (/Users/erubioteruel/Documents/GitHub/DevOps-Dashboard/node_modules/babel-cli/lib/_babel-node.js:154:22)
    at Module._compile (internal/modules/cjs/loader.js:776:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:787:10)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] start: `babel-node app.js`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the [email protected] start script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/erubioteruel/.npm/_logs/2019-07-23T16_56_42_601Z-debug.log

I thought it might be because I had not installed Redis, but I went ahead and did that but I am still getting the same message.

Any help would be appreciated!!

Error starting Metricio 1.1.0: The "path" argument must be of type string

This is a perfectly clean install of Metricio. All I did was download the .zip (following the get started guide), extract it to a folder in my user directory and in Powershell run npm install and then npm run start.

I'm on Windows 10 with Node v9.5.0 and NPM v5.6.0

Here's the output:

PS C:\Users\Mike\Projects\react\metricio-1.1.0> npm run start

> [email protected] start C:\Users\Mike\Projects\react\metricio-1.1.0
> babel-node app.js

path.js:28
    throw new errors.TypeError('ERR_INVALID_ARG_TYPE', 'path', 'string');
    ^

TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string
    at assertPath (path.js:28:11)
    at Object.join (path.js:489:7)
    at Object.<anonymous> (C:/Users/Mike/Projects/react/metricio-1.1.0/config/paths.js:6:20)
    at Module._compile (module.js:660:30)
    at loader (C:\Users\Mike\Projects\react\metricio-1.1.0\node_modules\babel-register\lib\node.js:144:5)
    at Object.require.extensions.(anonymous function) [as .js] (C:\Users\Mike\Projects\react\metricio-1.1.0\node_modules\babel-register\lib\node.js:154:7)
    at Module.load (module.js:573:32)
    at tryModuleLoad (module.js:513:12)
    at Function.Module._load (module.js:505:3)
    at Module.require (module.js:604:17)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] start: `babel-node app.js`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] start script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\Mike\AppData\Roaming\npm-cache\_logs\2018-05-02T21_49_33_538Z-debug.log

Any help would be much appreciated!

[QUESTION] - Docker Installation

Any docs or plans for docker/docker-compose solution?

After npm run production nothing happens

In dev mode all works but on the target server (Google Compute Engine, f1-micro - 1CPU 0.6Gb RAM, Ubuntu 18.04) after run

npm run production

I see in the console only

> [email protected] production /home/danil_borchevkin/web_electricmeter
> cross-env NODE_ENV=production webpack -p && NODE_ENV=production babel-node app.js

Ports doesn't open, nothing to happens.

Why I can try to resolve this situation?

Disable caching

The caching is a good idea for always displaying something if it ever succeeded but I need to know if a service is down. As such I don't want to see a cached result if the service is unreachable for example. I was wondering if there is a way to set a flag in the job to disable caching of certain requests.

Installation under node 9.8.0 "Failed at the [email protected] start script."

> babel-node app.js

/metricio/app.js:1
(function (exports, require, module, __filename, __dirname) { import { createServer } from 'http';
                                                              ^^^^^^
SyntaxError: Unexpected token import

ASP Backend with Metrico

Would be great to work with ASP MVC and Metrico, tooling and widgeting would be easy