morrisenobong: Provide me with all the steps with explanation to set up full

observability stack using Opentelmetry for existing java spring boot

microservices on kubernets cluster using zero-code uato instrumentation.

GitHub Copilot: To set up a full observability stack using OpenTelemetry for

existing Java Spring Boot microservices on a Kubernetes cluster with zero-
code auto-instrumentation, follow these steps:

### Step 1: Set Up OpenTelemetry Collector

1. **Create a Kubernetes Namespace for Observability:**

```sh

kubectl create namespace observability

```

2. **Deploy OpenTelemetry Collector:**

Create a configuration file `otel-collector-config.yaml` for the

OpenTelemetry Collector:

```yaml

# filepath: otel-collector-config.yaml

apiVersion: v1

kind: ConfigMap

metadata:

name: otel-collector-config

namespace: observability

data:

otel-collector-config.yaml: |

receivers:

Sensitivity: Public
 otlp:

protocols:

grpc:

http:

exporters:

logging:

loglevel: debug

otlp:

endpoint: "<your-otel-endpoint>"

service:

pipelines:

traces:

receivers: [otlp]

exporters: [logging, otlp]

```

Apply the configuration:

```sh

kubectl apply -f otel-collector-config.yaml

```

Deploy the OpenTelemetry Collector:

```yaml

# filepath: otel-collector-deployment.yaml

apiVersion: apps/v1

kind: Deployment

metadata:

Sensitivity: Public
 name: otel-collector

namespace: observability

spec:

replicas: 1

selector:

matchLabels:

app: otel-collector

template:

metadata:

labels:

app: otel-collector

spec:

containers:

- name: otel-collector

image: otel/opentelemetry-collector:latest

command:

- "/otelcol"

- "--config=/etc/otel-collector-config.yaml"

volumeMounts:

- name: otel-collector-config-vol

mountPath: /etc/otel-collector-config.yaml

subPath: otel-collector-config.yaml

volumes:

- name: otel-collector-config-vol

configMap:

name: otel-collector-config

items:

Sensitivity: Public
 - key: otel-collector-config.yaml

path: otel-collector-config.yaml

```

Apply the deployment:

```sh

kubectl apply -f otel-collector-deployment.yaml

```

### Step 2: Configure Auto-Instrumentation for Java Applications

1. **Download the OpenTelemetry Java Agent:**

```sh

curl -L -o opentelemetry-javaagent.jar
https://github.com/open-telemetry/opentelemetry-java-instrumentation/
releases/download/v1.6.0/opentelemetry-javaagent.jar

```

2. **Update Your Kubernetes Deployment Manifests:**

Modify your existing Spring Boot microservices deployment manifests to

include the OpenTelemetry Java Agent. For example:

```yaml

# filepath: your-microservice-deployment.yaml

apiVersion: apps/v1

kind: Deployment

metadata:

name: your-microservice

namespace: your-namespace

Sensitivity: Public
 spec:

replicas: 1

selector:

matchLabels:

app: your-microservice

template:

metadata:

labels:

app: your-microservice

spec:

containers:

- name: your-microservice

image: your-microservice-image:latest

env:

- name: JAVA_TOOL_OPTIONS

value: "-javaagent:/path/to/opentelemetry-javaagent.jar -
Dotel.exporter.otlp.endpoint=http://otel-collector.observability:4317"

volumeMounts:

- name: otel-agent

mountPath: /path/to/opentelemetry-javaagent.jar

subPath: opentelemetry-javaagent.jar

volumes:

- name: otel-agent

configMap:

name: otel-agent-config

items:

- key: opentelemetry-javaagent.jar

Sensitivity: Public
 path: opentelemetry-javaagent.jar

```

Apply the updated deployment:

```sh

kubectl apply -f your-microservice-deployment.yaml

```

### Step 3: Verify the Setup

1. **Check the OpenTelemetry Collector Logs:**

```sh

kubectl logs -n observability deployment/otel-collector

```

2. **Check Your Observability Backend:**

Ensure that traces and metrics are being sent to your observability
backend (e.g., Jaeger, Prometheus, Grafana).

### Step 4: Optional - Set Up Dashboards and Alerts

1. **Deploy Grafana and Prometheus (if not already set up):**

Follow the official documentation to deploy Grafana and Prometheus on

your Kubernetes cluster.

2. **Create Dashboards:**

Use Grafana to create dashboards for visualizing the metrics and traces
collected by OpenTelemetry.

Sensitivity: Public
 3. **Set Up Alerts:**

Configure alerts in Prometheus and Grafana to monitor the health and

performance of your microservices.

By following these steps, you will have a full observability stack set up for
your Java Spring Boot microservices on a Kubernetes cluster using
OpenTelemetry with zero-code auto-instrumentation.

Similar code found with 1 license type

morrisenobong: add the steps to add jaeger as by observability backend

GitHub Copilot: To add Jaeger as your observability backend, follow these

steps:

### Step 1: Deploy Jaeger on Kubernetes

1. **Create a Namespace for Jaeger:**

```sh

kubectl create namespace observability

```

2. **Deploy Jaeger:**

Create a Jaeger deployment file `jaeger-deployment.yaml`:

```yaml

# filepath: jaeger-deployment.yaml

apiVersion: v1

Sensitivity: Public
 kind: Service

metadata:

name: jaeger

namespace: observability

spec:

ports:

- port: 16686

name: query

- port: 14268

name: collector

- port: 14250

name: grpc

selector:

app: jaeger

---

apiVersion: apps/v1

kind: Deployment

metadata:

name: jaeger

namespace: observability

spec:

replicas: 1

selector:

matchLabels:

app: jaeger

template:

metadata:

Sensitivity: Public
 labels:

app: jaeger

spec:

containers:

- name: jaeger

image: jaegertracing/all-in-one:1.22

ports:

- containerPort: 16686

- containerPort: 14268

- containerPort: 14250

```

Apply the Jaeger deployment:

```sh

kubectl apply -f jaeger-deployment.yaml

```

### Step 2: Update OpenTelemetry Collector Configuration

1. **Update the OpenTelemetry Collector ConfigMap:**

Modify the `otel-collector-config.yaml` to include Jaeger as an exporter:

```yaml

# filepath: otel-collector-config.yaml

apiVersion: v1

kind: ConfigMap

metadata:

name: otel-collector-config

Sensitivity: Public
 namespace: observability

data:

otel-collector-config.yaml: |

receivers:

otlp:

protocols:

grpc:

http:

exporters:

logging:

loglevel: debug

jaeger:

endpoint: "jaeger.observability:14250"

tls:

insecure: true

service:

pipelines:

traces:

receivers: [otlp]

exporters: [logging, jaeger]

```

Apply the updated ConfigMap:

```sh

kubectl apply -f otel-collector-config.yaml

```

Sensitivity: Public
 ### Step 3: Update Your Microservices Deployment

1. **Update Your Kubernetes Deployment Manifests:**

Ensure your microservices are configured to send traces to the

OpenTelemetry Collector. For example:

```yaml

# filepath: your-microservice-deployment.yaml

apiVersion: apps/v1

kind: Deployment

metadata:

name: your-microservice

namespace: your-namespace

spec:

replicas: 1

selector:

matchLabels:

app: your-microservice

template:

metadata:

labels:

app: your-microservice

spec:

containers:

- name: your-microservice

image: your-microservice-image:latest

env:

- name: JAVA_TOOL_OPTIONS

Sensitivity: Public
 value: "-javaagent:/path/to/opentelemetry-javaagent.jar -
Dotel.exporter.otlp.endpoint=http://otel-collector.observability:4317"

volumeMounts:

- name: otel-agent

mountPath: /path/to/opentelemetry-javaagent.jar

subPath: opentelemetry-javaagent.jar

volumes:

- name: otel-agent

configMap:

name: otel-agent-config

items:

- key: opentelemetry-javaagent.jar

path: opentelemetry-javaagent.jar

```

Apply the updated deployment:

```sh

kubectl apply -f your-microservice-deployment.yaml

```

### Step 4: Verify the Setup

1. **Check the OpenTelemetry Collector Logs:**

```sh

kubectl logs -n observability deployment/otel-collector

```

Sensitivity: Public
 2. **Access Jaeger UI:**

Forward the Jaeger UI port to your local machine:

```sh

kubectl port-forward -n observability service/jaeger 16686:16686

```

Open your browser and navigate to `http://localhost:16686` to access the

Jaeger UI.

By following these steps, you will have Jaeger set up as the observability
backend for your Java Spring Boot microservices on a Kubernetes cluster
using OpenTelemetry with zero-code auto-instrumentation.

morrisenobong: provide a downloadable file for all the provided steps

GitHub Copilot: Sure, here are the downloadable YAML files for the provided
steps:

### `otel-collector-config.yaml`

```yaml

apiVersion: v1

kind: ConfigMap

metadata:

name: otel-collector-config

namespace: observability

data:

otel-collector-config.yaml: |

receivers:

Sensitivity: Public
 otlp:

protocols:

grpc:

http:

exporters:

logging:

loglevel: debug

jaeger:

endpoint: "jaeger.observability:14250"

tls:

insecure: true

service:

pipelines:

traces:

receivers: [otlp]

exporters: [logging, jaeger]

```

### `otel-collector-deployment.yaml`

```yaml

apiVersion: apps/v1

kind: Deployment

metadata:

name: otel-collector

namespace: observability

spec:

replicas: 1

Sensitivity: Public
 selector:

matchLabels:

app: otel-collector

template:

metadata:

labels:

app: otel-collector

spec:

containers:

- name: otel-collector

image: otel/opentelemetry-collector:latest

command:

- "/otelcol"

- "--config=/etc/otel-collector-config.yaml"

volumeMounts:

- name: otel-collector-config-vol

mountPath: /etc/otel-collector-config.yaml

subPath: otel-collector-config.yaml

volumes:

- name: otel-collector-config-vol

configMap:

name: otel-collector-config

items:

- key: otel-collector-config.yaml

path: otel-collector-config.yaml

```

Sensitivity: Public
 ### `jaeger-deployment.yaml`

```yaml

apiVersion: v1

kind: Service

metadata:

name: jaeger

namespace: observability

spec:

ports:

- port: 16686

name: query

- port: 14268

name: collector

- port: 14250

name: grpc

selector:

app: jaeger

---

apiVersion: apps/v1

kind: Deployment

metadata:

name: jaeger

namespace: observability

spec:

replicas: 1

selector:

matchLabels:

Sensitivity: Public
 app: jaeger

template:

metadata:

labels:

app: jaeger

spec:

containers:

- name: jaeger

image: jaegertracing/all-in-one:1.22

ports:

- containerPort: 16686

- containerPort: 14268

- containerPort: 14250

```

### `your-microservice-deployment.yaml`

```yaml

apiVersion: apps/v1

kind: Deployment

metadata:

name: your-microservice

namespace: your-namespace

spec:

replicas: 1

selector:

matchLabels:

app: your-microservice

Sensitivity: Public
 template:

metadata:

labels:

app: your-microservice

spec:

containers:

- name: your-microservice

image: your-microservice-image:latest

env:

- name: JAVA_TOOL_OPTIONS

value: "-javaagent:/path/to/opentelemetry-javaagent.jar -
Dotel.exporter.otlp.endpoint=http://otel-collector.observability:4317"

volumeMounts:

- name: otel-agent

mountPath: /path/to/opentelemetry-javaagent.jar

subPath: opentelemetry-javaagent.jar

volumes:

- name: otel-agent

configMap:

name: otel-agent-config

items:

- key: opentelemetry-javaagent.jar

path: opentelemetry-javaagent.jar

```

You can download these files and apply them to your Kubernetes cluster as
described in the steps.

Sensitivity: Public
 Similar code found with 1 license type

Sensitivity: Public