Giter Club home page Giter Club logo

greenyet's Introduction

greenyet

One status dashboard to rule them all, those lousy microservices. Are they green yet?

Problem Solution statement

Show the applications statuses across the IT floor, to

  1. Encourage good status pages,
  2. Share application health with all stakeholders,
  3. Don't make humans check a list of machines manually.

Greenyet polls all your services for status information and gives a traffic light overview on the application health.

Usage

greenyet is written in Clojure. Give it a try if you haven't yet.

$ CONFIG_DIR=example/simple ./lein ring server
$ ./example/simple/run_mock_service.sh

Don't want to go that far? We got you covered! Try the production release standalone JAR (run via java -jar greenyet-*-standalone.jar).

Configuration

Config as YAML (remember JSON is a subset):

  1. Status URL config status_url.yaml

    ---
    - system: SimpleSystem
      url: http://%host%:8080/
    - system: SystemWithStatusJson
      url: http://%hostname%:8080/status.json
      color: "status"
    - system: SystemWithComplexStatusJson
      url: http://%hostname%:8080/complex_status.json
      package-version: "packageNameWithVersion"
      message: "readableStatus"
      color:
        json-path: $.statuses[0].color # query as implemented by https://github.com/gga/json-path
        green-value: "healthy"
        yellow-value: "warning"
    - system: SystemWithComponents
      url: http://%hostname%:8080/status_with_components.json
      color: "status"
      components:
        json-path: $.subSystems
        color: "status"
        name: "name"
        message: "description"
  2. Host list hosts.yaml

    ---
    - hostname: 192.168.0.10
      environment: DEV
      system: SimpleSystem
    - hostname: 192.168.10.42
      environment: PROD
      system: SimpleSystem

Master greenyet

Monitor your whole lot together

Put in your reverse proxy/load balancer together with your nodes. Most of the times your machines will be green, so only the first entry of the config will be shown per environment (e.g. the reverse proxy, your call). The list unfolds once one machine changes color.

Green is green

Make sure that the main machine changes color when a component gets unhealthy. Greenyet does not interpret component colors, but only looks at the overall one.

Visualise the flow to production

Get your environments sorted in the order from dev to prod. Make use of the environment names that greenyet knows about to get the right ordering.

Start with little

You can monitor just based on a HTTP 200 response, if you don't have an elaborate JSON available yet.

Development

# Back-end unit tests
$ ./lein test
# UI unit tests, later `open http://localhost:3000/styleguide.html` 
$ CONFIG_DIR=example/simple lein ring server-headless 

More

Reach out to @cburgmer for feedback and ideas.

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.