Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/teletrace/teletrace

Open-Source Tracing Platform
https://github.com/teletrace/teletrace

debugging distributed-tracing monitoring observability opentelemetry tracing

Last synced: 4 months ago
JSON representation

Open-Source Tracing Platform

Awesome Lists containing this project

README 

        



[![Logo](./website/docs/assets/teletrace.png)](https://docs.teletrace.io/)









[![Slack](https://img.shields.io/badge/slack-teletrace-brightgreen.svg?logo=slack)](https://join.slack.com/t/teletrace/shared_invite/zt-1qv0kogcn-KlbBB2yS~gUCGszZoSpJfQ)

[![Version](https://img.shields.io/github/v/release/teletrace/teletrace?color=blueviolet)](https://github.com/teletrace/teletrace/releases)

[![Commits](https://img.shields.io/github/commits-since/teletrace/teletrace/latest?color=ff69b4&include_prereleases)](https://github.com/teletrace/teletrace/graphs/commit-activity)

[![Merge Queue](https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/teletrace/teletrace&style=flat)](https://github.com/teletrace/teletrace/actions/workflows/merge-queue.yml)

[![Docs](https://github.com/teletrace/teletrace/actions/workflows/docs.yml/badge.svg)](https://docs.teletrace.io/)

[![Go Report](https://img.shields.io/badge/go%20report-A+-brightgreen.svg?color=blue)](https://goreportcard.com/report/github.com/teletrace/teletrace)

[![Contributors](https://img.shields.io/github/contributors/teletrace/teletrace.svg?color=orange)](https://github.com/teletrace/teletrace/graphs/contributors)

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg?color=red)](https://github.com/teletrace/teletrace/blob/main/LICENSE)








  📝 Explore the docs •

  💬 Join Our Slack •

  🐛 Report Bug •

  ✨ Request Feature




## ⭐️ **Why Teletrace?**



Teletrace is an open-source distributed tracing system that helps developers monitor and troubleshoot complex distributed systems by providing end-to-end transaction monitoring and tracing across various microservices.

Teletrace is built from the ground up for modern applications. It relies on open standards like OpenTelemetry. It is an easy-to-deploy scalable solution, that supports multiple storage options.



## ✨ **Features**



- Advanced search to pinpoint slow and failing requests.

- Visualize requests to understand their context in your application.

- Track user requests and data across your application.



## 🖼 **Demo**






To learn more, please visit our demo [GitHub](https://github.com/teletrace/opentelemetry-demo) project and try open telemetry demo on your own machine.



## 📚 **Table of contents**



- [Features](#-features)

- [Demo](#-demo)

- [Getting Started](#-getting-started)

- [Contribution](#-contribution)

- [Community](#-community)

- [Code of Conduct](#-code-of-conduct)

- [License](#-license)



## 🚀 **Getting started**



### Requirements



- [Docker](https://docs.docker.com/compose/install/)



### Using Docker



Using docker-compose:



```sh

curl https://raw.githubusercontent.com/teletrace/teletrace/main/deploy/docker-compose/teletrace-otel-collector.yaml > teletrace-otel-collector.yaml && \

curl https://raw.githubusercontent.com/teletrace/teletrace/main/deploy/docker-compose/docker-compose.yml > docker-compose.yml && \

docker-compose up

```



Alternatively, using docker CLI:



```sh

curl https://raw.githubusercontent.com/teletrace/teletrace/main/teletrace-otelcol/config/all-in-one-config.yaml > all-in-one-config.yaml && \

docker run \

    -v $(pwd)/all-in-one-config.yaml:/etc/config.yaml \

    -p 8080:8080 \

    -p 4317:4317 \

    -p 4318:4318 \

    teletrace/teletrace:latest \

    --config /etc/config.yaml

```



### Using Helm Chart



To install the Helm chart, follow the steps outlined in this [guide](https://docs.teletrace.io/user-guide/deployment/helm_chart/) to ensure a smooth installation process.



Alternatively, visit our helm chart [repo](https://github.com/teletrace/helm-charts).



## 💬 **Community**



Join our [Slack](https://join.slack.com/t/teletrace/shared_invite/zt-1qv0kogcn-KlbBB2yS~gUCGszZoSpJfQ) for questions, support and fun.



Start with our [Documentation](https://docs.teletrace.io/) for quick tutorials and examples.



If you need direct support you can contact us at [email protected].



## 👨‍💻 **Contribution**



Contributions are welcome!



Start by reviewing the [contribution guidelines](CONTRIBUTING.md). After that, take a look at a [good first issue](https://github.com/teletrace/teletrace/issues?q=is:issue+is:open+label:%22good+first+issue%22).



[![Contributors](https://contrib.rocks/image?repo=teletrace/teletrace)](https://github.com/teletrace/teletrace/graphs/contributors)



Thank you to all the people who already contributed to Teletrace ❤️



## ❗ **Code of conduct**



We take our community seriously and we are dedicated to providing a safe and welcoming environment for everyone.

Please take a few minutes to review our [Code of Conduct](./CODE_OF_CONDUCT.md).



## 🪪 **License**



Copyright (c) Cisco Systems, Inc. [Apache 2.0 License](./LICENSE).