Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #1820

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+73 −0
Open

Update README.md #1820

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5b4f8ba
Update README.md
dovzhikova Nov 21, 2024
9433a82
Update README.md
dovzhikova Nov 21, 2024
afd3165
Update README.md
dovzhikova Nov 21, 2024
70e0538
Updated the readme file
dovzhikova Nov 21, 2024
b9d1a26
Update README.md
dovzhikova Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 55 additions & 30 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,35 +10,59 @@
</a>
</p>


<p align="center">
<img src="assets/logo.png" width="350" /></br>
<h2>Generate distributed traces for any application in k8s without code changes.</h2>
</p>

<h2 align="center">
<a href="https://www.youtube.com/watch?v=nynyV7FC4VI">Demo Video</a> • <a href="https://docs.odigos.io">Documentation</a> • <a href="https://join.slack.com/t/odigos/shared_invite/zt-1d7egaz29-Rwv2T8kyzc3mWP8qKobz~A">Join Slack Community</a>
<a href="https://youtu.be/bqTrGi3skhk?si=CLAolYpdT7rQb7PH">Demo Videos</a> • <a href="https://docs.odigos.io">Documentation</a> • <a href="https://join.slack.com/t/odigos/shared_invite/zt-1d7egaz29-Rwv2T8kyzc3mWP8qKobz~A">Join Slack Community</a>
</h2>

## What is Odigos?

Odigos is an open-source distributed tracing solution that revolutionizes observability for Kubernetes environments. It provides instant tracing capabilities without requiring any code changes to your applications.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Odigos is an open-source distributed tracing solution that revolutionizes observability for Kubernetes environments. It provides instant tracing capabilities without requiring any code changes to your applications.
Odigos is an open-source distributed tracing solution that revolutionizes observability for Kubernetes environments. It provides instant distributed tracing, metrics and log capabilities without requiring any code changes to your applications.


## Key Features

* **Code-Free Instrumentation**: Set up distributed tracing in minutes, eliminating manual code modifications.
* **Multi-Language Support**: Works with Java, Python, .NET, Node.js, and Go applications.
* **eBPF-Powered**: Utilizes eBPF technology for high-performance instrumentation, especially for Go applications.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the open-source version, eBPF is used only for go. Is the "especially" meant for the enterprise edition?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, I think we can rephrase it like this:
eBPF-Powered: Utilizes eBPF technology for high-performance instrumentation of Go applications. eBPF-based instrumentation for Java, Python, .NET, and Node.js is available in the commercial edition.

* **OpenTelemetry Compatible**: Generates traces in OpenTelemetry format for broad tool compatibility.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* **OpenTelemetry Compatible**: Generates traces in OpenTelemetry format for broad tool compatibility.
* **OpenTelemetry Compatible**: Generates traces, metrics and logs in OpenTelemetry format for broad tool compatibility.

* **Vendor Agnostic**: Integrates with various monitoring solutions, avoiding vendor lock-in.
* **Automatic Scaling**: Manages and scales OpenTelemetry collectors based on data volume.
* **User-Friendly Management**: Offers a web UI for easy configuration and management.
dovzhikova marked this conversation as resolved.
Show resolved Hide resolved

## Why Choose Odigos?

1. **Efficiency**: Over 20x faster than manual instrumentation at higher percentiles.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is only for the enterprise tier

2. **Simplicity**: Implement distributed tracing with minimal effort and complexity.
3. **Performance**: Separates data recording and processing to minimize runtime impact.
4. **Community-Backed**: With 3,000+ GitHub stars and growing contributor base.

Odigos empowers platform engineers, DevOps professionals, and SREs to enhance their observability strategies quickly and effectively, making it an ideal solution for modern cloud-native environments.

## Features

### ✨ Language Agnostic Auto-instrumentation

Odigos supports any application written in Java, Python, .NET, Node.js, and **Go**.
Odigos supports any application written in Java, Python, .NET, Node.js, and **Go**.
Historically, compiled languages like Go have been difficult to instrument without code changes. Odigos solves this problem by uniquely leveraging [eBPF](https://ebpf.io).

![Works on any application](assets/choose_apps.png)


### 🤝 Keep your existing observability tools
Odigos currently supports all the popular managed and open-source destinations.

Odigos currently supports all the popular managed and open-source destinations.
By producing data in the [OpenTelemetry](https://opentelemetry.io) format, Odigos can be used with any observability tool that supports OTLP.

For a complete list of supported destinations, see [here](#supported-destinations).

![Works with any observability tool](assets/choose_dest.png)

### 🎛️ Collectors Management
Odigos automatically scales OpenTelemetry collectors based on observability data volume.
### 🎛️ Collectors Management

Odigos automatically scales OpenTelemetry collectors based on observability data volume.
Manage and configure collectors via a convenient web UI.

![Collectors Management](assets/overview_page.png)
Expand All @@ -48,7 +72,6 @@ Manage and configure collectors via a convenient web UI.
Installing Odigos takes less than 5 minutes and requires no code changes.
Download our [CLI](https://docs.odigos.io/installation) and run the following command:


```bash
odigos install
```
Expand All @@ -61,32 +84,34 @@ For more details, see our [quickstart guide](https://docs.odigos.io/intro).

### Managed

| | Traces | Metrics | Logs |
|-------------------------| ------- | ------- |------|
| New Relic | ✅ | ✅ | ✅ |
| Datadog | ✅ | ✅ | ✅ |
| Grafana Cloud | ✅ | ✅ | ✅ |
| Honeycomb | ✅ | ✅ | ✅ |
| Chronosphere | ✅ | ✅ | |
| Logz.io | ✅ | ✅ | ✅ |
| qryn.cloud | ✅ | ✅ | ✅ |
| OpsVerse | ✅ | ✅ | ✅ |
| Dynatrace | ✅ | ✅ | ✅ |
| AWS S3 | ✅ | ✅ | ✅ |
| Google Cloud Monitoring | ✅ | | ✅ |
| Google Cloud Storage | ✅ | | ✅ |
| Azure Blob Storage | ✅ | | ✅ |
| Splunk | ✅ | | |
| Lightstep | ✅ | | |
| Sentry | ✅ | | |
| Axiom | ✅ | | ✅ |
| Sumo Logic | ✅ | ✅ | ✅ |
| Coralogix | ✅ | ✅ | ✅ |

| | Traces | Metrics | Logs |
| ------------------------- | -------- | --------- | ------ |
| New Relic | ✅ | ✅ | ✅ |
| Datadog | ✅ | ✅ | ✅ |
| Grafana Cloud | ✅ | ✅ | ✅ |
| Honeycomb | ✅ | ✅ | ✅ |
| Chronosphere | ✅ | ✅ | |
| Logz.io | ✅ | ✅ | ✅ |
| qryn.cloud | ✅ | ✅ | ✅ |
| OpsVerse | ✅ | ✅ | ✅ |
| Dynatrace | ✅ | ✅ | ✅ |
| AWS S3 | ✅ | ✅ | ✅ |
| Google Cloud Monitoring | ✅ | | ✅ |
| Google Cloud Storage | ✅ | | ✅ |
| Azure Blob Storage | ✅ | | ✅ |
| Splunk | ✅ | | |
| Lightstep | ✅ | | |
| Sentry | ✅ | | |
| Axiom | ✅ | | ✅ |
| Sumo Logic | ✅ | ✅ | ✅ |
| Coralogix | ✅ | ✅ | ✅ |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This list is not up to date.
While we are at it, or as a followup PR, we can update it and add missing destinations (like Elastic APM and Gigapipe).

I also wonder if it makes more sense to sort it alphabetically


### Open Source


| | Traces | Metrics | Logs |
| ------------- | ------ | ------- | ---- |
| --------------- | -------- | --------- | ------ |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also this list is not up-to-date.

For example, it is missing ClickHouse and otlp (gRPC, http) destinations

| Prometheus | | ✅ | |
| Tempo | ✅ | | |
| Loki | | | ✅ |
Expand Down
Loading