Skip to content

docs: clarify OTel collector usage in getting started guide #3775

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

Merged
mowies merged 5 commits into from
Oct 29, 2024
Merged

docs: clarify OTel collector usage in getting started guide #3775

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ec974e1
issue-3538
Garvit-77 Oct 22, 2024
5f4e0a3
reviewed changes
Garvit-77 Oct 23, 2024
38b0f82
reorder sentences slightly
mowies Oct 23, 2024
583bdb7
Diagram changes
Garvit-77 Oct 23, 2024
9bcec26
Update observability.md
Garvit-77 Oct 28, 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
Binary file modified docs/docs/getting-started/assets/install01.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions docs/docs/getting-started/observability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,9 +277,10 @@ So let's install new Observability components to help us:

- [Cert manager](https://cert-manager.io): Jaeger requires cert-manager
- [Jaeger](https://jaegertracing.io): Store and view DORA deployment traces
- [OpenTelemetry collector](https://opentelemetry.io/docs/collector/): Scrape metrics from the above DORA metrics endpoint
& forward to Prometheus.
In this guide, we will use the OTel collector that comes bundled with the Jaeger `allInOne` image.
- [Prometheus](https://prometheus.io): Store DORA metrics
- [OpenTelemetry collector](https://opentelemetry.io/docs/collector/):
Scrape metrics from the above DORA metrics endpoint & forward to Prometheus
- [Grafana](https://grafana.com) (and some prebuilt dashboards): Visualise the data

![add observability](./assets/install01.png)
Expand Down