vizceral-hystrix

Vizceral is a tool from Netflix to visualize traffic between components. This data needs to be fed from somewhere however. Hystrix provides fault tolerance, and a nice stream of all metrics. Turbine aggregates the hystrix streams per cluster.

This tool reads the hystrix streams and aggregates them and provides an API to get the JSON to be fed into Vizceral.

It assumes that the hystrix "group" has a correlation with the cluster to tail. Once a new group is discovered a new stream will be tailed from turbine. If the group is not named the same as the cluster, mappings can be applied.

You need to specify the entry clusters to start tailing. Usually this is the outermost cluster. All dependencies of this will be automatically discovered.

If a circuit breaker is triggered, the cluster that is the target of the circuit breaker will be set as danger. When some requests are rejected by the hystrix thread pool, the source cluster will be yellow (warning).

Timeouts are treated as warnings (yellow dots), errors are danger (red dots).

Configuration

Sample config file

{
  "regionName": "eu-west-1", //Required, the name of the region
  "httpPort": 8081, (optional) the http port to listen on
  "maxTrafficTtlSeconds": 604800, (optional) how many seconds back we should consider max traffic volume. Defaults to 1 week.
  "timeoutPercentageThreshold": 0, (optional) percentage of timeouts before showing a warning on connection, range 0-1
  "failurePercentageThreshold": 0, (optional) percentage of timeouts before showing a warning on connection, range 0-1
  "turbine": {
    "host": "127.0.0.1", //required, host of the turbine cluster
    "port": 8080, //required, port of the turbine cluster
    "path": "/turbine/turbine.stream?cluster=", //optional, path to the stream on the turbine cluster. Defauls to /turbine.stream?cluster=,
    "secure": true,  //optional, if we should access turbine over ssl
    "auth": {   //optional, if we should use basic auth
      "username": "username", //basic auth username             
      "password": "password"  //basic auth password
    }    
  },
  "entryClusters": [  //required, some initial clusters to tail
    "prod-proxy",
    "someinternalcomponent"
  ],
  "internetClusters": [  //optional, clusters that will be painted as receiving traffic from the internet
    "prod-proxy"
  ],
  "hystrixGroupToCluster": [  //optional, special mappings if the group doesn't match the hystrix cluster name
    {
      "group": "hystrix-prod-proxy",
      "cluster": "prod-proxy"
    }
  ]
}

ZMON integration

ZMON can be used as a source of alerts

In order to activate, add this to the config:

  "zmon": {
    "host": "demo.zmon.io",
    "port": 443,
    "path": "/",
    "secure": true,
    "headers": {
      "Authorization": "Basic b"
    }
  },

Running

To run the app, send the config file as the first argument:

java -jar vizceral-hystrix-1.0.0.jar config.json

If you have multiple regions you can specify multiple config files:

java -jar vizceral-hystrix-1.0.0.jar eu-west-1.json eu-west-2.json

Running in docker

If you prefer running in docker, simply replace the config.json and run

docker build -t vichyz . &&  docker run --name vichyz -p "8080:8080" -p "8081:8081" vichyz

Then open localhost:8080.

If you map port 8081 or change it in the configuration, you'll have to replace it in trafficFlow.jsx