Zerok-Observer

The Zerok Observer is part of the Zerok System, which is a set of tools for observability in Kubernetes clusters. The Zerok System works along with the OpenTelemetry Operator. Check out these docs [add link here] to learn more about how Zerok can benefit you.

The Zerok Observer is responsible for collecting spans from the OpenTelemetry collector and storing them in the badger DB. Zerok Observer is installed as a Daemonset, and each pod is responsible for collecting the spans emitted by the pods on that specific node. The Zerok Observer also provides an API to query the traces stored in the badger DB. The Zerok Observer stores information in Redis about spans that meet the probe conditions defined in the ZerokProbe CRD. The ZerokProbe CRD is managed by the Zerok Operator.

Prerequisites

Zerok Operator needs to be installed in the cluster in zk-client namespace for the observer to work.

Get Helm Repositories Info

helm repo add zerok-ai https://zerok-ai.github.io/helm-charts
helm repo update

See helm repo for command documentation.

Install Helm Chart

Install the Zerok Observer.

helm install [RELEASE_NAME] zerok-ai/zk-observer

See helm install for command documentation.

Uninstall Helm Chart

helm uninstall [RELEASE_NAME]

This removes all the Kubernetes components associated with the chart and deletes the release.

See helm uninstall for command documentation.

Upgrading Helm Chart

helm upgrade [RELEASE_NAME] [CHART] --install

See helm upgrade for command documentation.

Contributing

Contributions to the Zerok Observer are welcome! Submit bug reports, feature requests, or code contributions.

Reporting Issues

Encounter an issue? Please file a report on our GitHub issues page with detailed information to aid in quick resolution.