nats-mon

A realtime web based NATS monitor

Table of contents

• Quick Start
• Build status
• Coverage
• Screenshot
• Bugs and feature requests
• Contributing
• Versioning
• Creators
• Copyright and license

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:
• Develop:

Coverage

• Master:
• Develop:

Screenshot

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

• https://twitter.com/repejota
• https://github.com/repejota

Adrià Cidre

• https://twitter.com/adriacidre
• https://github.com/adriacidre

License

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

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