https://github.com/sumologic/java-auto-instrumentation-operator

https://github.com/sumologic/java-auto-instrumentation-operator

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/sumologic/java-auto-instrumentation-operator
• Owner: SumoLogic
• Created: 2020-07-13T13:21:37.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-01-02T16:42:48.000Z (11 months ago)
• Last Synced: 2024-06-21T13:12:04.461Z (5 months ago)
• Language: Go
• Size: 133 KB
• Stars: 0
• Watchers: 22
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# java-auto-instrumentation-operator

This repo contains Kubernetes operator that allows auto instrumentation of Java applications. It does so by automatically injecting Java Auto Instrumentation agent and configuration

# Installation

## Preparing the pods

The deployment needs to have following labels applied:

* `should-auto-instrument` set to *true*

* `auto-instrumentation-exporter` preferably set to `otlp`

* `auto-instr-service-name` set to name the service should be presented in spans

* `collector-host` set to host where spans need to be sent

For example:

```

apiVersion: apps/v1

kind: Deployment

metadata:

  name: service-a

  namespace: java-demo-app

  labels:

    should-auto-instrument: "true"

    auto-instrumentation-exporter: "otlp"

    auto-instr-service-name: "service-a"

    collector-host: "collection-sumologic-otelcol.sumologic"

```

## Adding the Operator

The best way to install the operator is to install it as a Helm chart. For example, to install it in `opeartor-helm` namespace, run

following commands (for Helm 3):

```shell script

helm repo add java-auto-instrumentation-operator https://sumologic.github.io/java-auto-instrumentation-operator

helm install operator java-auto-instrumentation-operator/java-auto-instrumentation-operator --namespace operator-helm

```

# Limitations

Currently only single-container deployments are being supported

Following operator installation, auto-instrumentation injection is applied only for newly started or restarted pods (currently running services need to be restarted manually to enable auto-instrumentation for them).

# License

Apache 2