shashwatVar / bench-routes

Bench-routes is a highly scalable API monitoring and performance analysis tool, that monitors in regular intervals the state of the server.

Bench-routes

Modern web applications can have routes ranging from a few to millions in numbers. This makes it tough to discover the condition and state of such application at any given point. Bench-routes monitors the routes of a web application and helps you know about the current state of each route, along with various related performance metrics.

Dataflow

Primary goals

1. Monitoring web applications routes at scale.
2. Querying the monitored data in an interactive UI that is minimalistic to learn.
3. Reporting in case of any abnormalities.

For installation instructions, please head-over to INSTALL.md.

Use of MakeFile in bench-routes

We use make for building and executing the program.

Follow the commands to make the development process easier:

1. Updating the dependencies: make update
2. Executing the application (assuming all dependencies are installed): make run
3. Building the application for the current OS: make build
4. Testing Golang code: make test
5. Complete testing include building for all OSs out there: make test_complete
6. Cleaning up the residual files: make clean
7. (optional) Check linting (assuming golangci-lint is installed): make lint

UI of Bench-routes

The old UI for the project is depreceated for now and no longer mantained. Kindly have a look at our new UI here.

Postman Usage

1. Download Postman and Install it.
2. Create a new collection.

To Check Service State

1. Add request
2. Select method GET
3. Copy and Enter below request url
   http://localhost:9990/service-state
4. Send the request to url.
5. This API returns the state of the services (active or passive) in real-time.

To Get Routes Summary

1. Add request
2. Select method GET
3. Copy and Enter below request url
   http://localhost:9990/routes-summary
4. Send the request to url.
5. This API returns the list of all URLs/Routes that are being monitored for testing using the application.

For more information, regarding the APIs. Visit Bench-Routes.

👬 Active maintainers

• Aquib Baig ([e-mail])
• Muskan Khedia ([e-mail])
• Harkishen Singh ([e-mail])

Communication

• Instant messaging: bench-routes/community
• Discussions (Recent): https://groups.google.com/forum/#!forum/bench-routes-discussion

Want to contribute?

Want to file a bug, request a feature, contribute some code, or improve documentation? Excellent! Read up on our guidelines for contributing and then check out one of our issues. Make sure you follow the guidelines before sending a contribution!

Supported by