Note: It is recommended to change default memory for docker from 2GiB to 4GiB and default CPU's to 3 to get Hypertrace up and running.

If you want to see Hypertrace in action, you can quickly start Hypertrace via Docker.

:IMPORTANT: We recommend you change the Docker Desktop default settings from 2 GB of memory to 4 GB of memory, and set CPUs to at least 4 CPUs. When reporting problems, please include the output of docker stats --no-stream.

git clone https://github.com/hypertrace/hypertrace.git
cd hypertrace/docker
docker-compose pull
docker-compose up --force-recreate

This will start all services required for Hypertrace. Once you see the service hypertrace-ui start, you can visit Hypertrace UI at http://localhost:2020 .

Hypertrace Dashboard

If you are facing any issues with docker-compose setup, we have listed down common issues and resolutions here.

Hypertrace uses two different types of store currently

• Document store (for entities)
• OLAP store (for timeseries data) By default, we run docker-compose with mongo as a document store. Recently, we have also added support for postgres as an alternative to mongo. To run hypertrace with postgres override the document-store service

Run docker-compose -f docker-compose.yml -f docker-compose.postgres.yml up

References #114 #124

Run docker-compose -f docker-compose.yml -f docker-compose.alerting.yml up or docker-compose -f docker-compose.yml -f docker-compose.postgres.yml -f docker-compose.alerting.yml up (for postgres as document-store)

Update alerting rule definition in alert-rules.json, notification-rules.json

To enable the metrics component, include docker-compose.prometheus.yml in your docker-compose up/down command.

Run docker-compose -f docker-compose.yml -f docker-compose.prometheus.yml up or docker-compose -f docker-compose.yml -f docker-compose.postgres.yml -f docker-compose.prometheus.yml up (for postgres as document-store)

Here are the default Hypertrace ports:

• The example app has two services: frontend and backend. They both report trace data to Hypertrace. To setup the demo, you need to start Frontend, Backend and Hypertrace.
• You can start sample by running docker-compose -f docker-compose-zipkin-example.yml up if you have hypertrace running already.
• You can start sample app with Hypertrace using docker-compose -f docker-compose.yml -f docker-compose-zipkin-example.yml up.
• Example app will be served at http://localhost:8081 . You can visit app and refresh it few times to generate some sample requests!