This topic describes how to expose data by using instrumentation points in ZooKeeper, capture data by using Prometheus Monitoring of Application Real-Time Monitoring Service (ARMS), and display data on the Prometheus Grafana dashboard to monitor ZooKeeper by using ARMS Prometheus Monitoring.

Background information

The following figure shows the procedure.

How It Works

Step 1: Start the JMX service

Enable the Java Management Extensions (JMX) service in ZooKeeper to obtain resource information.

  1. Add JMXPORT=8999 in line 44 in the /opt/zk/zookeeper-3.4.10/bin/zkServer.sh file, as shown in the following content:
    if [ "x$JMXLOCALONLY" = "x" ]
    then
        JMXLOCALONLY=false
    fi
    
    JMXPORT=8999 ## Added here in line 44.if [ "x$JMXDISABLE" = "x" ] || [ "$JMXDISABLE" = 'false' ]
    then
      echo "ZooKeeper JMX enabled by default $JMXPORT ..." >&2
      if [ "x$JMXPORT" = "x" ]
      then
  2. Restart ZooKeeper.
    /opt/zk/zookeeper-3.4.10/bin/zkServer.sh start /opt/zk/zookeeper-3.4.10/conf/zoo_sample.cfg &

Step 2: Start jmx_exporter in ZooKeeper

Start jmx_exporter to allow access to JMX information by using HTTP so that ARMS Prometheus Monitoring can capture data.

  1. Download zookeeper.yaml to the /opt/exporter_zookeeper/ directory.
  2. Add hostPort: localhost:8999 to the first line in the downloaded file /opt/exporter_zookeeper/zookeeper.yaml to expose the running port of the JMX service to jmx_exporter.
  3. Download the executable file of jmx_exporter to the opt/exporter_zookeeper/ directory.
  4. Start jmx_exporter.
    java -Dcom.sun.management.jmxremote.ssl=false -
    Dcom.sun.management.jmxremote.authenticate=false -
    Dcom.sun.management.jmxremote.port=8998 -cp /opt/exporter_zookeeper/jmx_prometheus_httpserver-0.12.0-jar-with-dependencies.jar 
    io.prometheus.jmx.WebServer 8997 /opt/exporter_zookeeper/zookeeper_exporter.yaml &
    After you perform the preceding operations, the application configuration is complete. You can run the following command to check whether jmx_exporter is running properly:
    curl http://<IP address of the server where jmx_exporter is deployed>:9997/metrics

Step 3: Configure ARMS Prometheus Monitoring to capture ZooKeeper data

Configure ARMS Prometheus Monitoring to capture ZooKeeper data.

  1. Log on to the ARMS console.
  2. In the left-side navigation pane, click Prometheus Monitoring.
  3. In the upper-left corner of the Prometheus Monitoring page, select the region where your Container Service for Kubernetes (ACK) clusters are deployed. Click Settings in the Actions column corresponding to a cluster.
  4. On the page that appears, click the Prometheus Settings tab.
  5. On the Prometheus Settings tab, enter the following code and click Save:
      global:
      scrape_interval:     15s # Set the scrape interval to every 15 seconds. 
    Default is every 1 minute.
      evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute.
    scrape_configs:
      - job_name: 'zookeeper'    
        static_configs:    
        - targets: ['121.40.124.46:8997']

Step 4: Display ZooKeeper data on the Grafana dashboard

Import the Grafana dashboard template on the Prometheus Monitoring page and specify the cluster where the Prometheus data source is deployed.

  1. Go to Host Dashboard.
  2. In the left-side navigation pane, choose + > Import. On the Import page, enter 10981 in the Grafana.com Dashboard field and click Load.
    Import Grafana Dashboard
  3. On the Import page, enter the following information and click Import.
    Import Grafana Dashboard with Options
    1. Enter a custom dashboard name in the Name field.
    2. Select the cluster from the Folder drop-down list.
    3. Select the cluster from the Select a Prometheus data source drop-down list.
    After the configuration is complete, the Prometheus Grafana ZooKeeper dashboard appears, as shown in the following figure.prom-zoo gra

Step 5: Create an ARMS Prometheus Monitoring alert

  1. Log on to the ARMS console.
  2. In the left-side navigation pane, click Prometheus Monitoring.
  3. In the top navigation bar, select a region. Then, click the name of the required Kubernetes cluster.
  4. In the left-side navigation pane, choose Alarm configuration beta. Then, click Create Alert in the upper-right corner.
  5. In the Create Alert dialog box, configure the following parameters, and then click OK.
    Note The Time parameter is not supported.
    1. Enter a name in the Rule Name field. Example: alerts for inbound traffic.
    2. Enter an expression that uses a PromQL statement. Example: (sum(rate(kube_state_metrics_list_total{job="kube-state-metrics",result="error"}[5m])) / sum(rate(kube_state_metrics_list_total{job="kube-state-metrics"}[5m]))) > 0.01.
      Notice An error may be reported if a PromQL statement contains a dollar sign ($). You must remove the equal sign (=) and the parameters on both sides of the equal sign (=) from the statement that contains the dollar sign ($). For example, change sum (rate (container_network_receive_bytes_total{instance=~"^$HostIp.*"}[1m])) to sum (rate (container_network_receive_bytes_total[1m])).
    3. In the Labels section, click Create Tag to specify alert tags. The specified tags can be used as options for a dispatch rule.
    4. In the Annotations section, specify a template for alert messages. Click Create Annotation. Set Key to message and Value to {{variable name}} alert message. The specified annotation is in the format of message:{{variable name}} alert notification. Example: message:{{$labels.pod_name}} restart.

      You can customize a variable name or select an existing tag as the variable name. Existing tags:

      • The tags that are carried in the metrics of an alert rule expression.
      • The tags that are created when you create an alert rule. For more information, see Create an alert.
      • The default tags provided by ARMS. The following table describes the default tags.
        Tag Description
        alertname The name of the alert. The format is <Alert name>_<Cluster name>.
        _aliyun_arms_alert_level The level of the alert.
        _aliyun_arms_alert_type The type of the alert.
        _aliyun_arms_alert_rule_id The ID of the alert rule.
        _aliyun_arms_region_id The ID of the region.
        _aliyun_arms_userid The ID of the user.
        _aliyun_arms_involvedObject_type The subtype of the associated object, for example, ManagedKubernetes or ServerlessKubernetes.
        _aliyun_arms_involvedObject_kind The type of the associated object, for example, app or cluster.
        _aliyun_arms_involvedObject_id The ID of the associated object.
        _aliyun_arms_involvedObject_name The name of the associated object.
    Prometheus-Create alarm

What to do next

After the Prometheus Grafana ZooKeeper dashboard is configured, you can view ARMS Prometheus Monitoring metrics and customize the dashboard. For more information, see the following references.