Giter VIP home page Giter VIP logo

anwersayeed / bench-routes Goto Github PK

View Code? Open in Web Editor NEW

This project forked from bench-routes/bench-routes

0.0 0.0 0.0 17.73 MB

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

Home Page: https://bench-routes.netlify.com/

License: BSD 3-Clause "New" or "Revised" License

Go 44.67% Shell 1.41% Makefile 0.75% HTML 4.16% Dockerfile 0.19% JavaScript 2.86% CSS 0.42% TypeScript 45.54%

bench-routes's Introduction

Bench-routes

Linux build Mac build Go Report Card Gitter

Modern web applications can have routes ranging from a few to millions in numbers. This makes it tough to discover then condition and state of the 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

Screenshot from 2020-03-21 20-09-00

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. Run UI (assuming all dependencies in dashboard/v1.1 are installed): make view-v1.1
  4. Building the application for the current OS: make build
  5. Testing Golang code: make test
  6. Complete testing include building for all OSs out there: make test_complete
  7. Cleaning up the residual files: make clean
  8. (optional) Check linting (assuming golangci-lint is installed): make lint

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

Communication

Want to contribute? contributions welcome

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

JetBrains

bench-routes's People

Contributors

harkishen-singh avatar aquibbaig avatar muskankhedia avatar ganeshpatro321 avatar ankitjena avatar jayashree-panda avatar sachdeva-shrey avatar dependabot-preview[bot] avatar ruddi10 avatar tushar3099 avatar rishav4101 avatar pratik32 avatar ashiscs avatar chetanyakan avatar merge-when-green[bot] avatar dikshantbrahma avatar shashwatvar avatar iamkryptonite avatar anuragtech02 avatar recrsn avatar robin828 avatar binayakbehera999 avatar ani-sha avatar sanketwable avatar tjzabel avatar suvidsahay avatar rn0311 avatar maheshschand avatar prajwal714 avatar jayjeetatgithub avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.