Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pavolloffay/kubecon-eu-2023-opentelemetry-kubernetes-tutorial


https://github.com/pavolloffay/kubecon-eu-2023-opentelemetry-kubernetes-tutorial

distributed-tracing monitoring observability opentelemetry tutorial

Last synced: 7 days ago
JSON representation

Awesome Lists containing this project

README 

        
# KubeCon EU 2023 OpenTelemetry Kubernetes tutorial



__Abstract__:

Deploying an end-to-end observability system comes with many challenges. The organization has to decide how data will be collected, what data formats will be used, sampling strategies, filter sensitive data (a.k.a. PII), and ultimately send data to the observability platform of their choice. In this session, we will teach you how to roll out end-to-end observability data collection on Kubernetes using the OpenTelemetry project. You will learn how to effectively instrument applications using auto-instrumentation, deploy the OpenTelemetry collector, and collect traces, metrics, and logs. You will gain the knowledge needed to tackle the mentioned challenges. After this session, you will be able to understand and use OpenTelemetry instrumentation libraries, collector and Kubernetes operator.



__Schedule__: https://kccnceu2023.sched.com/event/1HyZ3/



__Slides__: https://docs.google.com/presentation/d/1oDpQo9KW_C5HznE0GR53P22HzP_SN2Ml/edit#slide=id.g227fe4440bd_0_0 or [slides.pdf](./slides.pdf)



__Recording__: https://www.youtube.com/watch?v=XvPsdjNrpKo



---



### Prerequisites



This tutorial requires just requieres two major things:

1. A tool like docker or podman to run OCI Container Images

1. Access to a Kubernetes cluster within the version 1.19-1.26



In case you do not have access to a K8S cluster, you can use  [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/) or [Minikube](https://minikube.sigs.k8s.io/docs/start/) for a local Kubernetes cluster installations.



Here you will find our [cluster setup](./00-cluster-setup.md).



### Initial Setup



#### Deploy cert-manager



[cert-manager](https://cert-manager.io/docs/) is used by OpenTelemetry operator to provision TLS certificates for admission webhooks.



```bash

kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.11.0/cert-manager.yaml

```



#### Deploy observability backend



This course is all about Observabilty, so a backend is needed. If you don't have one, you can install a Prometheus compatible database Grafana [Mimir](https://github.com/grafana/mimir) as well as [Loki](https://github.com/grafana/loki) for logs and [Tempo](https://github.com/grafana/tempo) for traces as follows:



```bash

kubectl apply -f https://raw.githubusercontent.com/pavolloffay/kubecon-eu-2023-opentelemetry-kubernetes-tutorial/main/backend/01-backend.yaml

```



Afterwards, the backend can be found in the namespace x. A grafana dashboard with preconfigured datasources and dashboard is available for visualisation and can be made accessible with port-fowarding.



```bash

kubectl port-forward -n observability-backend svc/grafana 3000:3000

```



Open it in the browser [localhost:3000](http://localhost:3000/)



---



### Welcome to the OpenTelemetry Kubernetes tutorial.



Each tutorial step is located in a separate file:



1. [OpenTelemetry Collector introduction](./01-collector-introduction.md) (Bene, 10 min)

1. [OpenTelemetry Operator introduction](./02-operator-introduction.md) (Pavol, 10 min)

1. [Application instrumentation](./03-app-instrumentation.md) (Severin, Pavol, 30 min)

1. [Collecting metrics](./04-metrics.md) (Kristina, 15 min)

1. [Collecting logs](./05-logs.md) (Yuri, 10 min)

1. [Roadmap](./06-roadmap.md) (Yuri, 5 min)