Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/catchpoint/tracing.examples-kubernetes-java
Catchpoint Tracing examples for Java applications deploying to Kubernetes
https://github.com/catchpoint/tracing.examples-kubernetes-java
Last synced: about 1 month ago
JSON representation
Catchpoint Tracing examples for Java applications deploying to Kubernetes
- Host: GitHub
- URL: https://github.com/catchpoint/tracing.examples-kubernetes-java
- Owner: catchpoint
- License: apache-2.0
- Created: 2024-03-02T08:41:44.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-08-07T08:22:05.000Z (5 months ago)
- Last Synced: 2024-08-07T12:07:06.693Z (5 months ago)
- Language: Java
- Size: 147 KB
- Stars: 23
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Catchpoint Tracing Examples - Kubernetes/Java
## Pre-Requirements
1. **JDK** (`1.8+`)
2. **Maven** (`3.x`)
3. Please make sure **Docker Desktop** is installed and **Kubernetes** is activated.
Read [this](https://birthday.play-with-docker.com/kubernetes-docker-desktop) for details.
4. Please make sure **Kubernetes CLI** (`kubernetes-cli`/`kubectl`) is installed.
See [here](https://kubernetes.io/docs/tasks/tools/) for details.
## Setup with OpenTelemetry From the Beginning
This setup shows how you can install OpenTelemetry resources into Kubernetes first and deploy application later then.
So deployed applications will be auto instrumented.
### Setup OpenTelemetry Resources in Kubernetes
1. Replace `` with your Catchpoint Tracing API key in `otel/collector.yaml` file.
2. Then run the setup script which installs **OpenTelemetry Operator** and **OpenTelemetry Instrumentation CR** (Custom Resource) into Kubernetes:
```bash
./otel/setup-otel.sh
```
### Deploy the Applications into Kubernetes with OTEL
1. Run the deployment script which deploys database and applications **with** OpenTelemetry configuration into Kubernetes:
```bash
./apps/deploy-apps-with-otel-conf.sh
```
2. Wait until all services are activated.
3. Go to http://localhost:30000.
## Install OpenTelemetry After Setup
### Deploy the Applications into Kubernetes without OTEL
1. Run the deployment script which deploys database and applications **without** OpenTelemetry configuration into Kubernetes:
```bash
./apps/deploy-apps.sh
```
2. Wait until all services are activated.
3. Go to http://localhost:30000.
### Setup OpenTelemetry Resources in Kubernetes
1. Replace `` with your Catchpoint Tracing API key in `otel/collector.yaml` file.
2. Then run the setup script which installs **OpenTelemetry Operator** and **OpenTelemetry Instrumentation CR** (Custom Resource) into Kubernetes:
```bash
./otel/setup-otel.sh
```
### Patch Services to be Traced by OpenTelemetry
1. Run the patch script which updates application deployments by adding **OpenTelemetry Auto Instrumentation Annotation** (`instrumentation.opentelemetry.io/inject-java`) to the services to be traced:
```bash
./apps/patch-apps-with-otel-conf.sh
```
2. Wait until all services are restarted.
3. Go to http://localhost:30000.
## Destroy
### Destroy the Deployment of Applications
1. Run the application destroy script which deletes applications and database deployed to Kubernetes:
```bash
./apps/destroy-apps.sh
```
2. Wait until all resources are deleted.
### Destroy the Resources of OpenTelemetry
1. Run the OpenTelemetry destroy script for deleting the OpenTelemetry resources (operator and instrumentation CR),
```bash
./otel/destroy-otel.sh
```
2. Wait until all resources are deleted.