etsangsplk / hypertrace

An open source distributed tracing & observability platform

Hypertrace

Hypertrace is a cloud-native distributed tracing based Observability platform that gives visibility into your dev and production distributed systems.

Hypertrace was originally developed by Traceable as a highly scalable distributed tracing platform and it is used by Traceable’s cloud-native application security platform. Realizing that Hypertrace was a powerful standalone tracing and observability platform, Traceable created this open source project for the software development community to use in their applications.

---

Quick-start

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

Requirements:

• docker-engine (17.12.0+)
• docker-compose (1.21.0 +)
• 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. Note: 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 the UI at http://localhost:2020.

If your application is already instrumented to send traces to Zipkin or Jaeger, it will work with Hypertrace.

If not, you can try Hypertrace with our sample application by running

docker-compose -f docker-compose-zipkin-example.yml up

the sample app will run at http://localhost:8081. You should request the URL a few times to generate some sample trace requests!

Deploy in production with Kubernetes

We support helm charts to simplify deploying Hypertrace in Kubernetes environment, maybe on your on-premise server or cloud instance!

Please refer to the deployments section in our documentation which lists the steps to deploy Hypertrace on different Kubernetes flavors across different operating systems and cloud providers. You can find the Helm Charts and installation scripts with more details here.

Note: We have created hypertrace-ingester and hypertrace-service to simplify local deployment and quick-start with Hypertrace. As of now, we don't support them for production because of some limitations and some unreliabiliy with scaling. So, we will encourage you to deploy individual components for staging as well as production deployments.

Community

Join the Hypertrace Workspace on Slack to connect with other users, contributors and people behind Hypertrace.

Documentation

Check out Hypertrace documentation to learn more about Hypetrace features, it's architecture and other insights!

Docker images

Released versions of Docker images for various Hypertrace components are available on dockerhub.

Related Repositories

Data Ingestion Pipeline

• Hypertrace Ingester

Query Layer Services

• GraphQL
• Gateway Service
• Query Service
• Entity Service
• Attribute Service

UI

• Hypertrace UI
• Hyperdash
• Hyperdash Angular

Data Service Deployment

• Kafka helm charts
• Pinot helm charts
• MongoDB helm charts

License

Hypertrace follows the open core model where "Hypertrace core" (or simply Core) is made available under the Apache 2.0 license, which has distributed trace ingestion and exploration features. The Services, Endpoints, Backends and Service Graph features of Hypertrace Community Edition are made available under the Traceable Community license.