--- title: Charmhub | Deploy Apache Kafka Connect - K8s using Charmhub - The Open Operator Collection description: Deploy the latest version of Apache Kafka Connect - K8s as a Kubernetes Operator on any cloud. url: https://charmhub.io/kafka-connect-k8s/docs/h-enable-monitoring --- # Apache Kafka Connect - K8s [Canonical](https://charmhub.io/publisher/data-platform "View all packages from Canonical") * [Canonical](https://charmhub.io/publisher/data-platform "View all packages from Canonical") Platform: 4/stable 18 ``` juju deploy kafka-connect-k8s --channel 4/stable ``` [Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications) --- #### Relevant links * [Homepage](https://github.com/canonical/kafka-connect-k8s-operator) --- #### Contacts ##### Maintainers + [Canonical Data Platform](mailto:data-platform@lists.launchpad.net) * [Submit a bug](https://github.com/canonical/kafka-connect-k8s-operator/issues) --- Share your thoughts on this charm with the community on discourse. [Join the discussion](https://discourse.charmhub.io/) # Enable monitoring Both Charmed Apache Kafka K8s and Charmed Apache ZooKeeper K8s come with the [JMX exporter](https://github.com/prometheus/jmx_exporter/). The metrics can be queried by accessing the `http://:9101/metrics` and `http://:9998/metrics` endpoints, respectively. Additionally, the charm provides integration with the [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack). ## [Prerequisites](https://charmhub.io/kafka-connect-k8s/docs/h-enable-monitoring#p-25109-prerequisites) * A deployed [Charmed Apache Kafka K8s and Charmed Apache ZooKeeper K8s bundle](https://charmhub.io/kafka-connect-k8s/docs/h-deploy-anywhere) * A deployed [`cos-lite` bundle in a Kubernetes environment](https://charmhub.io/topics/canonical-observability-stack/tutorials/install-microk8s) ## [Offer interfaces via the COS controller](https://charmhub.io/kafka-connect-k8s/docs/h-enable-monitoring#p-25109-offer-interfaces-via-the-cos-controller) First, we will switch to the COS K8s environment and offer COS interfaces to be cross-model integrated with the Charmed Apache Kafka K8s model. To switch to the Kubernetes controller for the COS model, run ``` juju switch : ``` To offer the COS interfaces, run ``` juju offer grafana:grafana-dashboard grafana-dashboards juju offer loki:logging loki-logging juju offer prometheus:receive-remote-write prometheus-receive-remote-write ``` ## [Consume offers via the Apache Kafka model](https://charmhub.io/kafka-connect-k8s/docs/h-enable-monitoring#p-25109-consume-offers-via-the-apache-kafka-model) Next, we will switch to the Charmed Apache Kafka K8s model, find offers, and consume them. We are currently on the Kubernetes controller for the COS model. To switch to the Apache Kafka model, run ``` juju switch : ``` To find offers, run the following command (make sure not to miss the “:” at the end!): ``` juju find-offers : ``` The output should be similar to the sample below, where `k8s` is the K8s controller name and `cos` is the model where `cos-lite` has been deployed: ``` Store URL Access Interfaces k8s admin/cos.grafana-dashboards admin grafana_dashboard:grafana-dashboard k8s admin/cos.loki-logging admin loki_push_api:logging k8s admin/cos.prometheus-receive-remote-write admin prometheus_remote_write:receive-remote-write ... ``` To consume offers to be reachable in the current model, run ``` juju consume :admin/.grafana-dashboards juju consume :admin/.loki-logging juju consume :admin/.prometheus-receive-remote-write ``` ## [Deploy and integrate Grafana](https://charmhub.io/kafka-connect-k8s/docs/h-enable-monitoring#p-25109-deploy-and-integrate-grafana) First, deploy [grafana-agent-k8s](https://charmhub.io/grafana-agent-k8s): ``` juju deploy grafana-agent-k8s --trust ``` Then, integrate `grafana-agent-k8s` with consumed COS offers: ``` juju integrate grafana-agent-k8s grafana-dashboards juju integrate grafana-agent-k8s loki-logging juju integrate grafana-agent-k8s prometheus-receive-remote-write ``` Finally, integrate (previously known as “[relate](https://juju.is/docs/juju/integration)”) it with Charmed Apache Kafka K8s ``` juju integrate grafana-agent-k8s kafka-k8s:grafana-dashboard juju integrate grafana-agent-k8s kafka-k8s:logging juju integrate grafana-agent-k8s kafka-k8s:metrics-endpoint ``` and Charmed Apache ZooKeeper K8s ``` juju integrate grafana-agent-k8s zookeeper-k8s:grafana-dashboard juju integrate grafana-agent-k8s zookeeper-k8s:logging juju integrate grafana-agent-k8s zookeeper-k8s:metrics-endpoint ``` Wait for all components to settle down on a `active/idle` state on both models, e.g. `` and ``. After this is complete, the monitoring COS stack should be up and running and ready to be used. ### [Connect Grafana web interface](https://charmhub.io/kafka-connect-k8s/docs/h-enable-monitoring#p-25109-connect-grafana-web-interface) To connect to the Grafana web interface, follow the [Browse dashboards](https://charmhub.io/topics/canonical-observability-stack/tutorials/install-microk8s?_ga=2.201254254.1948444620.1704703837-757109492.1701777558#heading--browse-dashboards) section of the MicroK8s “Getting started” guide. ``` juju run grafana/leader get-admin-password --model : ``` ## [Tune server logging level](https://charmhub.io/kafka-connect-k8s/docs/h-enable-monitoring#p-25109-tune-server-logging-level) To tune the level of the server logs for Apache Kafka and Apache ZooKeeper, configure the `log-level` and `log_level` properties accordingly. ### [Apache Kafka](https://charmhub.io/kafka-connect-k8s/docs/h-enable-monitoring#p-25109-apache-kafka) ``` juju config kafka log_level= ``` Possible values are `ERROR`, `WARNING`, `INFO`, `DEBUG`. ### [Apache ZooKeeper](https://charmhub.io/kafka-connect-k8s/docs/h-enable-monitoring#p-25109-apache-zookeeper) ``` juju config kafka log-level= ``` Possible values are `ERROR`, `WARNING`, `INFO`, `DEBUG`. ---