Skip to content

Commit

Permalink
Getting started
Browse files Browse the repository at this point in the history
OTEL Collector
  • Loading branch information
Garvit-77 committed Oct 8, 2024
1 parent 30a6c1b commit 09816b9
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/docs/getting-started/observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,9 +281,10 @@ So let's install new Observability components to help us:
Scrape metrics from the above DORA metrics endpoint & forward to Prometheus
- [Grafana](https://grafana.com) (and some prebuilt dashboards): Visualise the data

**Note**
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 286 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)
Other tools including `jaeger-ui` without `allInOne` image, use OpenTelemetery collector directly.
There are other tools including `jaeger-ui` without `allInOne` image, use OpenTelemetery collector directly.

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)
[See for more information](../guides/otel.md)

![add observability](./assets/install01.png)
Expand Down
22 changes: 22 additions & 0 deletions docs/docs/guides/otel.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,3 +208,25 @@ of your application and apply the`KeptnAppContext`.
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

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.

0 comments on commit 09816b9

Please sign in to comment.