Skip to content

Personal Knowledge Base

Coroot — Commands & Recipes

Coroot — Commands & Recipes¶

Runnable commands, configuration snippets, and troubleshooting recipes for Coroot.

Installation¶

Helm Install (Kubernetes)¶

# Add repo and install operator
helm repo add coroot https://coroot.github.io/helm-charts
helm repo update coroot
helm install -n coroot --create-namespace coroot-operator coroot/coroot-operator

# Install Community Edition
helm install -n coroot coroot coroot/coroot-ce

# Install with custom ClickHouse sizing
helm install -n coroot coroot coroot/coroot-ce \
  --set "clickhouse.shards=2,clickhouse.replicas=2" \
  --set "clickhouse.resources.requests.memory=4Gi"

Docker Compose¶

git clone https://github.com/coroot/coroot.git && cd coroot
docker compose up -d
# UI: http://localhost:8080

Access & Verification¶

# Port-forward to UI
kubectl port-forward -n coroot service/coroot-coroot 8080:8080

# Check operator status
kubectl get coroot -n coroot

# List all Coroot pods
kubectl get pods -n coroot -o wide

# Check node-agent logs
kubectl logs -n coroot -l app=coroot-node-agent --tail=50

# Check cluster-agent logs
kubectl logs -n coroot -l app=coroot-cluster-agent --tail=50

Configuration Recipes¶

Enable TLS for Coroot Server (v1.19.0+)¶

helm upgrade -n coroot coroot coroot/coroot-ce \
  --set "server.tls.enabled=true" \
  --set "server.tls.certFile=/etc/coroot/tls/tls.crt" \
  --set "server.tls.keyFile=/etc/coroot/tls/tls.key"

Private Registry¶

helm install -n coroot coroot coroot/coroot-ce \
  --set registry.url=https://registry.example.com/coroot \
  --set registry.pullSecret=coroot-registry-auth

Multi-Cluster (Remote Agents Only)¶

# On remote cluster
helm install -n coroot --create-namespace coroot-operator coroot/coroot-operator
helm install -n coroot coroot coroot/coroot-ce \
  --set "agentsOnly=true" \
  --set "agents.server.url=https://central-coroot.example.com"

Troubleshooting¶

eBPF Agent Not Collecting Data¶

# Check kernel version (needs 4.16+)
uname -r

# Check if node-agent has privileged access
kubectl get pod -n coroot -l app=coroot-node-agent -o jsonpath='{.items[0].spec.containers[0].securityContext}'

# Check node-agent eBPF loading errors
kubectl logs -n coroot -l app=coroot-node-agent | grep -i "error\|failed\|ebpf"

# Verify cgroup mount
kubectl exec -n coroot $(kubectl get pod -n coroot -l app=coroot-node-agent -o name | head -1) -- ls /sys/fs/cgroup/

ClickHouse Storage Full¶

# Check ClickHouse disk usage
kubectl exec -n coroot $(kubectl get pod -n coroot -l app=clickhouse -o name | head -1) -- \
  clickhouse-client --query "SELECT formatReadableSize(sum(bytes_on_disk)) FROM system.parts"

# Check retention settings
kubectl exec -n coroot $(kubectl get pod -n coroot -l app=clickhouse -o name | head -1) -- \
  clickhouse-client --query "SELECT database, table, engine_full FROM system.tables WHERE database LIKE 'coroot%'"

# Force merge old parts
kubectl exec -n coroot $(kubectl get pod -n coroot -l app=clickhouse -o name | head -1) -- \
  clickhouse-client --query "OPTIMIZE TABLE coroot_traces.spans FINAL"

Upgrade¶

helm repo update coroot
helm upgrade -n coroot coroot-operator coroot/coroot-operator
helm upgrade -n coroot coroot coroot/coroot-ce

# Verify
kubectl get pods -n coroot
kubectl get coroot -n coroot

Sources¶