carotte-dashboard

carotte-dashboard will generate a documentation website from your microservices data, and keep track of your microservices health and performances. Your services needs to embed a carotte AMQP agent (see available carotte-compatible agents for your language below).

Preview

Configuration (Env variables)

| Name | Default | Description | | ------------- |:-------------:|--------------| | WEBSITE_NAME | Carotte Dashboard | The name of the hosted carotte dashboard | | AMQP_HOSTNAME | localhost:5672 | The AMQP broker connection string | | REFRESH_INTERVAL | 60000 | The interval in ms to refresh the services data | | HTTP_PORT | 3000 | The http port of the hosted carotte dashboard | | EXCHANGE_NAME | carotte.fanout | The fanout exchange name to be used on the broker |

Launch with docker

docker run -d --name rabbitmq rabbitmq:3.6-management-alpine
docker run --link rabbitmq:rabbitmq -p 3000:3000 cubyn/carotte-dashboard:develop

Carotte-compatible agents

| Language | Name | Repo | | ------------- |:-------------:|--------------| | node.js (>=6) | carotte-amqp | See on GitHub |

Local development

# one-time only
make deps
make init

# run and watch for changes (requires nodemon)
nodemon src/

# lint
make lint
# tests
make test
# coverage
make cover