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.

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

how to configure Keptn OpenTelemetry #66

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 33 additions & 0 deletions walkthrough/keptn.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,39 @@ For visualizing DORA metrics and deployment traces,
visit `http://grafana.127.0.0.1.nip.io/`
where several Dashboards are pre-configured.

## Integrate OpenTelemetry in Keptn

Earlier, we configured OpenTelemetry inside the `app.js` file
to track the usage of the application.
We can also configure Keptn to run OpenTelemetry,
which gives us a trace for the "act of deployment".
Copy link
Collaborator

Choose a reason for hiding this comment

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

which gives us a trace per deployment


We have enabled and integrated Keptn for the cluster
and have an Open Telemetry collector running.
Copy link
Collaborator

Choose a reason for hiding this comment

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

OpenTelemetry not Open Telemetry

To integrate OpenTelemetry into Keptn,
we only need to create a
[KeptnConfig](https://lifecycle.keptn.sh/docs/yaml-crd-ref/config/)
resource to tell Keptn where the Open Telemetry collector is running
Copy link
Collaborator

Choose a reason for hiding this comment

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

OpenTelemetry

and how often to rerun the automatic app discovery:

```yaml
apiVersion: options.keptn.sh/v1alpha2
kind: KeptnConfig
metadata:
name: klt-config
spec:
OTelCollectorUrl: 'http://otel-collector.keptn-lifecycle-toolkit-system:4317`
keptnAppCreationRequestTimeoutSeconds: 40
```

This uses the same URL for the OpenTelemetry collector
that we used earlier
and specifies that the automatic app discovery should be run every 40 seconds.

For more information about integrating and using
OpenTelemetry in Keptn, see
[Integrate OpenTelemetry into the Keptn Lifecycle Toolkit](https://lifecycle.keptn.sh/docs/implementing/otel/#integrate-opentelemetry-into-the-keptn-lifecycle-toolkit).

Next: [Define a custom Keptn metric](kmetrics.md)


1 change: 0 additions & 1 deletion walkthrough/kmetrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ To implement a custom Keptn metric:
resource that defines the observability platform query to use
and the interval at which to sample this data.


## Define KeptnMetricProvider

In this exercise, we are fetching metrics from a single instance
Expand Down