Telemetry Controller collects, routes and forwards telemetry data (logs, metrics and traces) from Kubernetes clusters supporting multi-tenancy out of the box.
Telemetry-controller can be configured using Custom Resources to set up an opinionated Opentelemetry Collector configuration to route log messages based on rules defined as a Tenant -> Subscription relation map.
To get started with the Telemetry Controller, complete the following steps. Alternatively, see our Telemetry Controller overview and quickstart blog post.
- go version v1.22+
- docker version 24+
- kubectl version v1.26+
- kubernetes v1.26+ with containerd as the container runtime
We recommend using kind or minikube for local experimentation and development.
Kind uses containerd by default, but for minikube you have to start the cluster using the --container-runtime=containerd
flag.
kind create cluster
# or
minikube start --container-runtime=containerd
Deploy latest telemetry-controller:
# Install telemetry-controller, and opentelemetry-operator as a sub-chart
helm upgrade --install --wait --create-namespace --namespace telemetry-controller-system telemetry-controller oci://ghcr.io/kube-logging/helm-charts/telemetry-controller
# Install dependencies (opentelemtry-operator):
make install-deps
# Install the CRDs and RBAC into the cluster:
make install
# Option 1 (faster): Run the operator from you local machine (uses cluster-admin rights)
make run
# Option 2 (safer): Build and run the operator inside the cluster (uses proper RBAC)
make docker-build IMG=telemetry-controller:latest
kind load docker-image telemetry-controller:latest
# or
minikube image load telemetry-controller:latest
make deploy IMG=telemetry-controller:latest
You can deploy the example configuration provided as part of the docs. This will deploy a demo pipeline with one tenant, two subscriptions, and an OpenObserve instance. Deploying Openobserve is an optional, but recommended step, logs can be forwarded to any OTLP endpoint. Openobserve provides a UI to visualize the ingested logstream.
# Deploy Openobserve
kubectl apply -f docs/examples/simple-demo/openobserve.yaml
# Set up portforwarding for Openobserve UI
kubectl -n openobserve port-forward svc/openobserve 5080:5080 &
Open the UI at localhost:5080
, navigate to the Ingestion/OTEL Collector
tab, and copy the authorization token as seen on the screenshot.
Paste this token to the example manifests:
sed -i '' -e "s/\<TOKEN\>/INSERT YOUR COPIED TOKEN HERE/" docs/examples/simple-demo/one_tenant_two_subscriptions.yaml
# Deploy the pipeline definition
kubectl apply -f docs/examples/simple-demo/one_tenant_two_subscriptions.yaml
Create a workload, which will generate logs for the pipeline:
helm install --wait --create-namespace --namespace example-tenant-ns --generate-name oci://ghcr.io/kube-logging/helm-charts/log-generator
Open the Openobserve UI and inspect the generated log messages:
Set up portforwarding for Openobserve UI
kubectl -n openobserve port-forward svc/openobserve 5080:5080
Install dependencies (cert-manager and opentelemetry-operator):
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.4/cert-manager.yaml
kubectl apply -f https://github.com/open-telemetry/opentelemetry-operator/releases/download/v0.112.0/opentelemetry-operator.yaml
# Wait for the opentelemtry-operator to be running
kubectl wait --namespace opentelemetry-operator-system --for=condition=available deployment/opentelemetry-operator-controller-manager --timeout=300s
Deploy latest telemetry-controller:
kubectl apply -k github.com/kube-logging/telemetry-controller/config/default --server-side
Install logging-operator
helm upgrade --install logging-operator oci://ghcr.io/kube-logging/helm-charts/logging-operator --version=4.6.0 -n logging-operator --create-namespace
Install log-generator
helm upgrade --install --wait log-generator oci://ghcr.io/kube-logging/helm-charts/log-generator -n log-generator --create-namespace
Apply the provided example resource for logging-operator: logging-operator.yaml
kubectl apply -f logging-operator.yaml
Apply the provided example resource for telemetry-controller: telemetry-controller.yaml
kubectl apply -f telemetry-controller.yaml
If you find this project useful, help us:
- Support the development of this project and star this repo! ⭐
- Help new users with issues they may encounter 💪
- Send a pull request with your new features and bug fixes 🚀
Please read the Organisation's Code of Conduct!
For more information, read our organization's contribution guidelines.
The project is licensed under the Apache 2.0 License.