Skip to content

Commit

Permalink
[GEN-1836]: images of new UI in readme & docs (#1890)
Browse files Browse the repository at this point in the history
This pull request includes updates to the `README.md` and
`docs/quickstart/building-a-pipeline.mdx` files to improve the
documentation and update image references. The most important changes
include updating image paths and making minor adjustments to the
documentation content.

Documentation updates:

*
[`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L23-L51):
Updated image paths to point to the `docs/images` directory instead of
the `assets` directory.
*
[`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L65-R63):
Corrected the markdown table formatting for the supported destinations
section.

Quickstart guide updates:

*
[`docs/quickstart/building-a-pipeline.mdx`](diffhunk://#diff-87aecaa36b506d782f5f1b598974f317a96424191122ffdeec82a0d3ea7009f5L11-R11):
Updated image paths to point to the `docs/images` directory.
[[1]](diffhunk://#diff-87aecaa36b506d782f5f1b598974f317a96424191122ffdeec82a0d3ea7009f5L11-R11)
[[2]](diffhunk://#diff-87aecaa36b506d782f5f1b598974f317a96424191122ffdeec82a0d3ea7009f5L25-R25)
[[3]](diffhunk://#diff-87aecaa36b506d782f5f1b598974f317a96424191122ffdeec82a0d3ea7009f5L37-R46)
*
[`docs/quickstart/building-a-pipeline.mdx`](diffhunk://#diff-87aecaa36b506d782f5f1b598974f317a96424191122ffdeec82a0d3ea7009f5L37-R46):
Changed the final step text from "Next" to "Done" to match the updated
UI.
  • Loading branch information
BenElferink authored Dec 1, 2024
1 parent 4563a08 commit 21098d7
Show file tree
Hide file tree
Showing 17 changed files with 32 additions and 34 deletions.
56 changes: 27 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
</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>
Expand All @@ -20,35 +19,34 @@
<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>
</h2>


### ✨ Language Agnostic Auto-instrumentation

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)

![Works on any application](docs/images/ui_choose_apps.png)

### 🤝 Keep your existing observability tools

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)
![Works with any observability tool](docs/images/ui_choose_dest.png)

### 🎛️ Collectors Management

### 🎛️ 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)
![Collectors Management](docs/images/ui_overview.png)

## Installation

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,27 +59,27 @@ 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 ||||

### Open Source

Expand Down
Binary file removed assets/choose_apps.png
Binary file not shown.
Binary file removed assets/choose_dest.png
Binary file not shown.
Binary file removed assets/dests.png
Binary file not shown.
Binary file removed assets/hacktoberfest_tee.png
Binary file not shown.
Binary file removed assets/odigos-cover.jpg
Binary file not shown.
Binary file removed assets/overview_page.png
Binary file not shown.
Binary file removed docs/images/choose_apps.png
Binary file not shown.
Binary file removed docs/images/choose_dest.png
Binary file not shown.
Binary file removed docs/images/choose_jaeger.png
Binary file not shown.
Binary file removed docs/images/jaeger_connection.png
Binary file not shown.
Binary file removed docs/images/observability_pipeline.png
Binary file not shown.
Binary file added docs/images/ui_choose_apps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/ui_choose_dest.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/ui_jaeger_connection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/ui_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions docs/quickstart/building-a-pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebarTitle: "Building a pipeline"
You should now see the following page:

<Frame>
<img src="/images/choose_apps.png" alt="Select target applications" />
<img src="/images/ui_choose_apps.png" alt="Select target applications" />
</Frame>

Select all the applications in the `default` namespace and click `Next`.
Expand All @@ -22,7 +22,7 @@ In the next step, you will be asked to select a destination for your traces.
Scroll down to the self hosted destinations and click on **Jaeger**.

<Frame>
<img src="/images/choose_jaeger.png" alt="Select Jaeger" />
<img src="/images/ui_choose_dest.png" alt="Select Jaeger" />
</Frame>

#### Connection details
Expand All @@ -34,14 +34,14 @@ You will now be asked to provide the connection details for your Jaeger instance
Enter any name you want for the destination, and enter `jaeger.tracing:4317` as the host.

<Frame>
<img src="/images/jaeger_connection.png" alt="Jaeger connection details" />
<img src="/images/ui_jaeger_connection.png" alt="Jaeger connection details" />
</Frame>

**That's it!** You can now click `Next` and finish the wizard.
**That's it!** You can now click `Done` and finish the wizard.

Odigos will now instrument your selected applications and deploy the nessesary OpenTelemetry collectors.
The following page will show an overview of your observability pipeline:

<Frame>
<img src="/images/observability_pipeline.png" alt="Observability pipeline" />
<img src="/images/ui_overview.png" alt="Observability pipeline" />
</Frame>

0 comments on commit 21098d7

Please sign in to comment.