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

docs: explain Jaeger and collector bundling in getting started guide #3743

Closed
wants to merge 6 commits into from
Closed

docs: explain Jaeger and collector bundling in getting started guide #3743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
30a6c1b
Getting Started
Garvit-77 Oct 7, 2024
09816b9
Getting started
Garvit-77 Oct 8, 2024
acaae8d
Revert whitespace changes
mowies Oct 9, 2024
e2955c7
Merge branch 'keptn:main' into OTEL-#3538
Garvit-77 Oct 15, 2024
736e373
Merge branch 'main' into OTEL-#3538
Garvit-77 Oct 16, 2024
bf4dbfa
Merge branch 'keptn:main' into OTEL-#3538
Garvit-77 Oct 18, 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
8 changes: 7 additions & 1 deletion docs/docs/getting-started/observability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,8 +282,14 @@
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)
**Note**
Copy link
Member

Choose a reason for hiding this comment

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

Instead of this note, please reorder the items above so that the OTel collector is right below Jaeger and then add in parentheses:

(in this guide, we will use the OTel collector that comes bundled with the Jaeger `allInOne` image)

The following is an example uses the Jaeger `allInOne` image, which has the UI, query service as well as collector.
The Jaeger installation process bundles the configured OpenTelemetery(OTEL) collector.

Check failure on line 287 in docs/docs/getting-started/observability.md

View workflow job for this annotation

GitHub Actions / Check Spelling 

`Telemetery` is not a recognized word. (unrecognized-spelling)
There are other tools including `jaeger-ui` without `allInOne` image, use OpenTelemetery collector directly.

Check failure on line 288 in docs/docs/getting-started/observability.md

View workflow job for this annotation

GitHub Actions / Check Spelling 

`Telemetery` is not a recognized word. (unrecognized-spelling)
[See for more information](../guides/otel.md)

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

## Step 8: Install Cert Manager

Jaeger requires Cert Manager, so install it now:
Expand Down
22 changes: 22 additions & 0 deletions docs/docs/guides/otel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,3 +208,25 @@
Keptn will re-deploy your application and Jaeger should show a link to the previous trace in the references section.

![linked trace](./assets/linkedtrace.png)

## OTEL Internal Data Processing
Copy link
Member

Choose a reason for hiding this comment

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

Please remove this whole section, it's not necessary to explain, how the OTel collector works. People can read good documentation about it in the OTel docs that are linked already.

Copy link
Author

Choose a reason for hiding this comment

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

@mowies in the DoD it's mentioned to

  1. Detailed explanation in the Otel guide page about how the otel collector wrks in case you do not want to use Jaeger allInOne.

Copy link
Member

Choose a reason for hiding this comment

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

That is not needed. People can read about how the collector works in the OTel docs. No need to document this on our side.


How is data logging is performed.Most Languages have specific instrumentation library which does have expoters

Check failure on line 214 in docs/docs/guides/otel.md

View workflow job for this annotation

GitHub Actions / Check Spelling 

`expoters` is not a recognized word. (unrecognized-spelling)
for popular backends & OTLP. So we can directly send data without collector, but it's reccommended to use

Check failure on line 215 in docs/docs/guides/otel.md

View workflow job for this annotation

GitHub Actions / Check Spelling 

`reccommended` is not a recognized word. (unrecognized-spelling)
collector as it handles various operations.

So if you don't want to use pre-built collector such as `jeager` you can even build or configure a collector according

Check failure on line 218 in docs/docs/guides/otel.md

View workflow job for this annotation

GitHub Actions / Check Spelling 

`jeager` is not a recognized word. (unrecognized-spelling)
to your requirements with the help of [OTEL collector Builder](https://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/builder)

For deployments that don't use the Jaeger allInOne image, follow these steps:

- Deploy the OpenTelemetry Collector: Use the official otel collector image, either by running it as a standalone

Check failure on line 223 in docs/docs/guides/otel.md

View workflow job for this annotation

GitHub Actions / Check Spelling 

`standalone` is not a recognized word. (unrecognized-spelling)
service or integrating it into your infrastructure.

- Configure the otel Collector: Define pipelines to receive traces and metrics from your application and export
them to Jaeger. For example, you can configure the otel collector to receive data over protocols like gRPC,
HTTP, or OTLP, and then export the processed data to Jaeger or other backends.

- Integration with UI(Jaeger as example): Once the otel collector is set up, ensure that your application is
sending telemetry data to the correct otel endpoint, and that the collector is exporting it to Jaeger’s
jaeger-query or other processing units.
Loading