0.1.0 • Published 7 years ago

carotte-dashboard v0.1.0

Weekly downloads
-
License
GNU 3
Repository
-
Last release
7 years ago

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

Bouillon preview

Configuration (Env variables)

NameDefaultDescription
WEBSITE_NAMECarotte DashboardThe name of the hosted carotte dashboard
AMQP_HOSTNAMElocalhost:5672The AMQP broker connection string
REFRESH_INTERVAL60000The interval in ms to refresh the services data
HTTP_PORT3000The http port of the hosted carotte dashboard
EXCHANGE_NAMEcarotte.fanoutThe 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

LanguageNameRepo
node.js (>=6)carotte-amqpSee 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