Apache HBase

Ce document explique comment configurer le déploiement de Google Kubernetes Engine afin de pouvoir collecter des métriques depuis Apache HBase à l'aide de Google Cloud Managed Service pour Prometheus. Sur cette page, vous allez :

• configurer l'exportateur pour HBase afin de générer des rapports sur les métriques ;
• configurer une ressource PodMonitoring pour Managed Service pour Prometheus afin de collecter les métriques exportées ;
• accéder à un tableau de bord dans Cloud Monitoring pour consulter les métriques ;
• configurer des règles d'alerte pour surveiller les métriques.

Ces instructions ne s'appliquent que si vous utilisez une collecte gérée avec Managed Service pour Prometheus. Si vous utilisez une collecte autodéployée, consultez le dépôt source de l'exportateur JMX pour obtenir des informations sur l'installation.

Ces instructions sont fournies à titre d'exemple et devraient fonctionner dans la plupart des environnements Kubernetes. Si vous rencontrez des difficultés pour installer une application ou un exportateur en raison de règles de sécurité ou d'organisation restrictives, nous vous recommandons de consulter la documentation Open Source pour obtenir de l'aide.

Pour en savoir plus sur HBase, consultez la page Apache HBase.

Prérequis

Pour collecter des métriques à partir de HBase en utilisant Managed Service pour Prometheus et la collecte gérée, votre déploiement doit répondre aux exigences suivantes :

• Votre cluster doit exécuter Google Kubernetes Engine version 1.21.4-gke.300 ou ultérieure.
• Vous devez exécuter Managed Service pour Prometheus en ayant activé la collecte gérée. Pour en savoir plus, consultez la page Premiers pas avec la collecte gérée.

• Pour utiliser les tableaux de bord disponibles dans Cloud Monitoring pour l'intégration de HBase, vous devez utiliser jmx-exporter version 0.17.0 ou ultérieure.

  Pour en savoir plus sur les tableaux de bord disponibles, consultez Afficher les tableaux de bord.

Installer l'exportateur HBase

Nous vous recommandons d'installer l'exportateur HBase, jmx-exporter, en tant que side-car pour votre charge de travail HBase. Pour en savoir plus sur l'utilisation des side-cars, consultez Applications étendues sur Kubernetes avec des pods multiconteneurs.

Pour installer jmx-exporter en tant que side-car pour HBase, modifiez la configuration de HBase comme indiqué dans l'exemple suivant :

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

+ apiVersion: v1
+ kind: ConfigMap
+ metadata:
+   name: hbase-exporter
+ data:
+   config.yaml: |
+     hostPort: localhost:9900
+     rules:
+     - pattern: "Hadoop<service=HBase, name=RegionServer, sub=TableLatencies><>Namespace_(\\w+)_table_(\\w+)_metric_(\\w+)"
+       name: "hbase_$3"
+       labels:
+         namespace: "$1"
+         table: "$2"
+     - pattern: "Hadoop<service=HBase, name=RegionServer, sub=Regions><>Namespace_(\\w+)_table_(\\w+)_region(\\W+)_metric_(\\w+)"
+       name: "hbase_$4"
+       labels:
+         namespace: "$1"
+         table: "$2"
+         region: "$3"
+     - pattern: "Hadoop<service=HBase, name=(\\w+), sub=(\\w+)><>(\\w+)"
+       name: "hbase_$1_$2_$3"
+     - pattern: "Hadoop<service=HBase, name=(\\w+)><>(\\w+)"
+       name: "hbase_$1_$2"
+     - pattern: "org.apache.ZooKeeperService<name0=StandaloneServer_port(\\d+)><>(\\w+)"
+       type: GAUGE
+       name: "zookeeper_$2"
+     - pattern: "org.apache.ZooKeeperService<name0=StandaloneServer_port(\\d+), name1=InMemoryDataTree><>(\\w+)"
+       type: GAUGE
+       name: "zookeeper_$2"
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: hbase
spec:
  selector:
    matchLabels:
+     app.kubernetes.io/name: hbase
  template:
    metadata:
      labels:
+       app.kubernetes.io/name: hbase
    spec:
      containers:
      - name: hbase
+       image: dajobe/hbase:latest
        ports:
+       - containerPort: 9900
+         name: jmx
        env:
+       - name: HBASE_MASTER_OPTS
+         value: -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.rmi.port=9900 -Dcom.sun.management.jmxremote.port=9900
+     - name: jmx-exporter
+       image: bitnami/jmx-exporter:0.17.0
+       command:
+         - java
+         - -jar
+         - jmx_prometheus_httpserver.jar
+       args:
+         - "9000"
+         - config.yaml
+       ports:
+       - containerPort: 9000
+         name: prometheus
+       volumeMounts:
+       - mountPath: /opt/bitnami/jmx-exporter/config.yaml
+         subPath: config.yaml
+         name: hbase-exporter
+     volumes:
+     - name: hbase-exporter
+       configMap:
+         name: hbase-exporter
+         defaultMode: 0644
+         items:
+         - key: config.yaml
+           path: config.yaml

Vous devez ajouter toutes les lignes précédées du symbole + à votre configuration.

HBase est compatible avec JMX, mais il doit être activé. Le meilleur moyen d'activer JMX consiste à transmettre des options jmxremote au script de démarrage, généralement en définissant la variable d'environnement HBASE_MASTER_OPTS ou HBASE_REGIONSERVER_OPTS.

Pour appliquer les modifications de configuration à partir d'un fichier local, exécutez la commande suivante :

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Vous pouvez également utiliser Terraform pour gérer vos configurations.

Définir une ressource PodMonitoring

Pour la découverte des cibles, l'opérateur Managed Service pour Prometheus doit disposer d'une ressource PodMonitoring correspondant à l'exportateur HBase dans le même espace de noms.

Vous pouvez utiliser la configuration PodMonitoring suivante :

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: PodMonitoring
metadata:
  name: hbase
  labels:
    app.kubernetes.io/name: hbase
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: prometheus
    scheme: http
    interval: 30s
    path: /metrics
  selector:
    matchLabels:
      app.kubernetes.io/name: hbase

Assurez-vous que les sélecteurs de libellés et le port correspondent aux sélecteurs et au port utilisés dans la section Installer l'exportateur HBase.

Pour appliquer les modifications de configuration à partir d'un fichier local, exécutez la commande suivante :

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Vous pouvez également utiliser Terraform pour gérer vos configurations.

Définir des règles et des alertes

Vous pouvez utiliser la configuration Rules suivante pour définir des alertes sur vos métriques HBase :

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: Rules
metadata:
  name: hbase-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: hbase-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: hbase
    interval: 30s
    rules:
    - alert: HBaseAuthenticationErrors
      annotations:
        description: |-
          HBase authentication errors
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: HBase authentication errors (instance {{ $labels.instance }})
      expr: rate(hbase_RegionServer_IPC_authenticationFailures[5m]) > 5
      for: 5m
      labels:
        severity: warning

Pour appliquer les modifications de configuration à partir d'un fichier local, exécutez la commande suivante :

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Vous pouvez également utiliser Terraform pour gérer vos configurations.

Pour en savoir plus sur l'application de règles à votre cluster, consultez Évaluation des règles et alertes gérées.

Vous pouvez ajuster les seuils d'alerte en fonction de votre application.

Vérifier la configuration

Vous pouvez utiliser l'Explorateur de métriques pour vérifier que vous avez correctement configuré l'exportateur HBase. L'ingestion de vos métriques par Cloud Monitoring peut prendre une ou deux minutes.

Procédez comme suit pour vérifier que les métriques ont bien été ingérées :

1. Dans le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis  Explorateur de métriques :

   Accéder à l'explorateur de métriques

2. Dans la barre d'outils du volet de création de requêtes, sélectionnez le bouton nommé  MQL ou  PromQL.
3. Vérifiez que PromQL est sélectionné dans le bouton d'activation Langage. Le bouton de langage se trouve dans la barre d'outils qui vous permet de mettre en forme votre requête.
4. Saisissez et exécutez la requête suivante :
   

   up{job="hbase", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Afficher les tableaux de bord

L'intégration de Cloud Monitoring inclut les tableaux de bord "Prometheus". Les tableaux de bord sont installés automatiquement lorsque vous configurez l'intégration. Vous pouvez également afficher des aperçus statiques de tableaux de bord sans installer l'intégration.

Pour afficher un tableau de bord installé, procédez comme suit :

1. Dans le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis  Tableaux de bord :

   Accéder à la page Tableaux de bord

2. Sélectionnez l'onglet Liste des tableaux de bord.
3. Choisissez la catégorie Intégrations.
4. Cliquez sur le nom du tableau de bord que vous souhaitez afficher.

Pour afficher un aperçu statique du tableau de bord, procédez comme suit :

1. Dans le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis  Intégrations :

   Accéder à la page Intégrations

2. Cliquez sur le filtre de plate-forme de déploiement Kubernetes Engine.
3. Recherchez l'intégration Apache HBase et cliquez sur Afficher les détails.
4. Sélectionnez l'onglet Tableaux de bord.

Dépannage

Pour en savoir plus sur la résolution des problèmes d'ingestion de métriques, consultez la section Problèmes liés à la collecte par les exportateurs dans la section Résoudre les problèmes côté ingestion.