A realtime web based NATS monitor
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin Accept env variables and flags to start nats-mon: Apr 8, 2017
public Merge pull request #20 from repejota/feature/17 Apr 8, 2017
routes
test
views
.coveralls.yml Added coveralls support Jul 22, 2015
.csslintrc Linted css stylesheets Jul 20, 2015
.gitignore Simple vagrant file Aug 3, 2015
.travis.yml Added travis support Jul 22, 2015
AUTHORS Fixes #2 - Complete REAME.md with dev info Jul 31, 2015
CONTRIBUTING.md Added contributing document Jul 22, 2015
Dockerfile fixed dockerfile Aug 4, 2015
LICENSE Updated copyright Oct 10, 2017
Makefile Updated deps Oct 16, 2017
README.md
VERSION Updated copyright Oct 10, 2017
app.js Added tasks on makefile to start server and server-dev Apr 7, 2017
config.json Fixes #3 By extending config to the frontend Aug 5, 2015
gulpfile.js Lint all js source code with jshint Jul 22, 2015
package-lock.json Updated deps Oct 16, 2017
package.json Updated deps Oct 16, 2017
screenshot.gif Animated screenshot Aug 1, 2015
screenshot.png New screenshot with charts Aug 1, 2015

README.md

nats-mon

A realtime web based NATS monitor

Table of contents

Quick start

Install nats-mon

git clone https://github.com/repejota/nats-mon.git
cd  nats-mon
npm install

Run nats-mon

npm start

You will also need gnatsd running with monitoring enabled:

./gnatsd -m 8222

Now you can open nats-mon on your browser through http://localhost:3000

Environment variables

nats-mon support the following environment variables:

  • NATSMON_SERVER_ADDRESS : Server address, by default localhost.
  • NATSMON_SERVER_PORT : Server port, by default 3000.

More options

nats-mon support the following options and command line flags:

This flags, overrides the values from the environment variables above.

$ nats-mon --help

  Usage: nats-mon [options]

  Options:

    -h, --help                  output usage information
    -V, --version               output the version number
    --server-address [address]  Server address
    --server-port [port]        Server port

Build status

  • Master: Build Status
  • Develop: Build Status

Coverage

  • Master: Coverage Status
  • Develop: Coverage Status

Screenshot

Alt text

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, if your pull request contains patches or features, you must include relevant unit tests.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, this project is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to those rules whenever possible.

Creators

Raül Pérez

Adrià Cidre

License

Code and documentation copyright 2015-2017 nats-mon authors.

By contributing your code, you agree to license your contribution under the MIT license.