Apache HBase

L'integrazione di Apache HBase raccoglie le metriche del cluster da master e server della regione. Le metriche dei server della regione sono correlate allo spazio di archiviazione, alle richieste e alla latenza. L'integrazione raccoglie anche i log dei server master e della regione e li analizza in un payload JSON. Il risultato include campi per origine, livello e messaggio.

Per ulteriori informazioni su HBase, consulta la documentazione di Apache HBase.

Prerequisiti

Per raccogliere la telemetria di HBase, devi installare l'agente operativo:

  • Per le metriche, installa la versione 2.11.0 o successive.
  • Per i log, installa la versione 2.11.0 o successive.

Questa integrazione supporta le versioni 1.7.x, 2.3.x e 2.4.x di HBase.

Configura l'istanza HBase

Per esporre un endpoint JMX, devi impostare la proprietà di sistema com.sun.management.jmxremote.port all'avvio della JVM. Ti consigliamo inoltre di impostare la proprietà di sistema com.sun.management.jmxremote.rmi.port sulla stessa porta. Per esporre un endpoint JMX da remoto, devi anche impostare la proprietà di sistema java.rmi.server.hostname.

Per impostazione predefinita, queste proprietà sono impostate nel file hbase-env.sh di un deployment HBase.

Per impostare le proprietà di sistema utilizzando argomenti della riga di comando, anteponi -D al nome della proprietà quando avvii la JVM. Ad esempio, per impostare com.sun.management.jmxremote.port sulla porta 10101, specifica quanto segue all'avvio della JVM:

-Dcom.sun.management.jmxremote.port=10101

Configura Ops Agent per HBase

Seguendo la guida per la configurazione di Ops Agent, aggiungi gli elementi richiesti per raccogliere la telemetria dalle istanze HBase e riavvia l'agente.

Configurazione di esempio

I comandi seguenti creano la configurazione per raccogliere e importare la telemetria per HBase e riavviano Ops Agent.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    hbase:
      type: hbase
      endpoint: service:jmx:rmi:///jndi/rmi://127.0.0.1:10101/jmxrmi
  service:
    pipelines:
      hbase:
        receivers:
          - hbase
logging:
  receivers:
    hbase_system:
      type: hbase_system
  service:
    pipelines:
      hbase_system:
        receivers:
          - hbase_system
EOF

sudo service google-cloud-ops-agent restart
sleep 60

Configura la raccolta di log

Per importare i log da HBase, devi creare ricevitori per i log prodotti da HBase, quindi creare una pipeline per i nuovi ricevitori.

Per configurare un destinatario per i log hbase_system, specifica i seguenti campi:

Campo Predefinito Descrizione
exclude_paths Un elenco di pattern di percorsi del file system da escludere dal set che corrisponde a include_paths.
include_paths [/opt/hbase/logs/hbase-*-regionserver-*.log, /opt/hbase/logs/hbase-*-master-*.log] Un elenco di percorsi di file system da leggere accodando ogni file. È possibile utilizzare un carattere jolly (*) nei percorsi, ad esempio /var/log/hbase*/*.log.
record_log_file_path false Se impostato su true, nella voce di log di output viene visualizzato il percorso del file specifico da cui è stato ottenuto il record di log come valore dell'etichetta agent.googleapis.com/log_file_path. Quando si utilizza un carattere jolly, viene registrato solo il percorso del file da cui è stato ottenuto il record.
type Questo valore deve essere hbase_system.
wildcard_refresh_interval 60s L'intervallo in cui vengono aggiornati i percorsi di file con caratteri jolly in includi_paths. Valore fornito come durata di tempo analizzabile da time.ParseDuration, ad esempio 30s o 2m. Questa proprietà potrebbe essere utile in caso di velocità effettiva di logging elevata, in cui i file di log vengono ruotati più velocemente rispetto all'intervallo predefinito.

Che cosa viene registrato

logName viene ricavato dagli ID destinatario specificati nella configurazione. Di seguito sono riportati i campi dettagliati all'interno di LogEntry.

I log hbase_system contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
jsonPayload.level string Livello di voce di log
jsonPayload.message string Messaggio di log, inclusa l'analisi dello stack dettagliata, se fornita
jsonPayload.module string Modulo di hbase in cui ha avuto origine il log
jsonPayload.source string origine del log
severity stringa (LogSeverity) Livello di voce di log (tradotto).

Configurazione della raccolta di metriche

Per importare le metriche da HBase, devi creare un ricevitore per le metriche prodotte da HBase, quindi creare una pipeline per il nuovo ricevitore.

Questo ricevitore non supporta l'utilizzo di più istanze nella configurazione, ad esempio per monitorare più endpoint. Tutte queste istanze scrivono nella stessa serie temporale e Cloud Monitoring non ha modo di distinguerle.

Per configurare un ricevitore per le metriche hbase, specifica i seguenti campi:

Campo Predefinito Descrizione
collect_jvm_metrics true Configura il ricevitore in modo che raccolga anche le metriche JVM supportate.
collection_interval 60s Un valore di durata temporale, ad esempio 30s o 5m.
endpoint localhost:10101 L'URL del servizio JMX o l'host e la porta utilizzati per creare l'URL del servizio. Questo valore deve essere nel formato service:jmx:<protocol>:<sap> o host:port. I valori nel modulo host:porta vengono utilizzati per creare un URL del servizio di service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi.
password La password configurata se JMX è configurato per richiedere l'autenticazione.
type Questo valore deve essere hbase.
username Il nome utente configurato se JMX è configurato per richiedere l'autenticazione.

Che cosa viene monitorato

La tabella seguente fornisce l'elenco delle metriche raccolte da Ops Agent dall'istanza HBase.

Tipo di metrica
Tipo, tipo
Risorse monitorate
Etichette
workload.googleapis.com/hbase.master.region_server.count
GAUGEINT64
gce_instance
state
workload.googleapis.com/hbase.master.regions_in_transition.count
GAUGEINT64
gce_instance
 
workload.googleapis.com/hbase.master.regions_in_transition.oldest_age
GAUGEINT64
gce_instance
 
workload.googleapis.com/hbase.master.regions_in_transition.over_threshold
GAUGEINT64
gce_instance
 
workload.googleapis.com/hbase.region_server.active_handler.count
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.authentication.count
GAUGEINT64
gce_instance
region_server
state
workload.googleapis.com/hbase.region_server.block_cache.operation.count
GAUGEINT64
gce_instance
region_server
state
workload.googleapis.com/hbase.region_server.blocked_update.time
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.disk.store_file.count
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.disk.store_file.size
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.files.local
GAUGEDOUBLE
gce_instance
region_server
workload.googleapis.com/hbase.region_server.gc.old_gen.time
CUMULATIVEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.gc.time
CUMULATIVEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.gc.young_gen.time
CUMULATIVEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.open_connection.count
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.append.latency.max
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.append.latency.mean
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.append.latency.median
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.append.latency.min
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.append.latency.p99
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.delete.latency.max
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.delete.latency.mean
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.delete.latency.median
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.delete.latency.min
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.delete.latency.p99
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.get.latency.max
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.get.latency.mean
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.get.latency.median
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.get.latency.min
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.get.latency.p99
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.increment.latency.max
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.increment.latency.mean
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.increment.latency.median
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.increment.latency.min
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.increment.latency.p99
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.put.latency.max
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.put.latency.mean
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.put.latency.median
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.put.latency.min
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.put.latency.p99
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.replay.latency.max
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.replay.latency.mean
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.replay.latency.median
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.replay.latency.min
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operation.replay.latency.p99
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.operations.slow
GAUGEINT64
gce_instance
operation
region_server
workload.googleapis.com/hbase.region_server.queue.length
GAUGEINT64
gce_instance
region_server
state
workload.googleapis.com/hbase.region_server.queue.request.count
GAUGEINT64
gce_instance
region_server
state
workload.googleapis.com/hbase.region_server.region.count
GAUGEINT64
gce_instance
region_server
workload.googleapis.com/hbase.region_server.request.count
GAUGEINT64
gce_instance
region_server
state
workload.googleapis.com/hbase.region_server.write_ahead_log.count
GAUGEINT64
gce_instance
region_server

Verificare la configurazione

Questa sezione descrive come verificare di aver configurato correttamente il ricevitore HBase. Ops Agent potrebbe richiedere uno o due minuti per iniziare a raccogliere dati di telemetria.

Per verificare che i log HBase vengano inviati a Cloud Logging, segui questi passaggi:

  1. Nella console Google Cloud, seleziona Logging, quindi Esplora log oppure fai clic sul pulsante seguente:

    Vai a Esplora log

  2. Inserisci la query seguente nell'editor, quindi fai clic su Esegui query:
    resource.type="gce_instance"
    log_id("hbase_system")
    

Per verificare che le metriche HBase vengano inviate a Cloud Monitoring, segui questi passaggi:

  1. Nella console Google Cloud, seleziona Monitoring, quindi  Metrics Explorer oppure fai clic sul pulsante seguente:

    Vai a Metrics Explorer

  2. Nella barra degli strumenti del riquadro Seleziona una metrica, seleziona il pulsante il cui nome inizia con Codice.
  3. Seleziona MQL nel pulsante di attivazione/disattivazione Lingua. L'opzione di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti che consente di formattare la query.
  4. Inserisci la query seguente nell'editor, quindi fai clic su Esegui query:
    fetch gce_instance
    | metric 'workload.googleapis.com/hbase.region_server.operation.append.latency.p99'
    | every 1m
    

Visualizza dashboard

Per visualizzare le metriche HBase, devi aver configurato un grafico o una dashboard. L'integrazione di HBase include una o più dashboard per te. Tutte le dashboard vengono installate automaticamente dopo la configurazione dell'integrazione e dopo che Ops Agent ha iniziato a raccogliere i dati delle metriche.

Puoi anche visualizzare anteprime statiche delle dashboard senza installare l'integrazione.

Per visualizzare una dashboard installata:

  1. Nella console Google Cloud, seleziona Monitoring, quindi seleziona  Dashboard oppure fai clic sul pulsante seguente:

    Vai alle dashboard

  2. Seleziona la scheda Elenco dashboard, quindi scegli la categoria Integrazioni.
  3. Fai clic sul nome della dashboard che vuoi visualizzare.

Se hai configurato un'integrazione, ma la dashboard non è stata installata, verifica che Ops Agent sia in esecuzione. Se non sono disponibili dati sulle metriche per un grafico nella dashboard, l'installazione della dashboard non riesce. Una volta che Ops Agent inizia a raccogliere le metriche, la dashboard viene installata automaticamente.

Per visualizzare un'anteprima statica della dashboard:

  1. Nella console Google Cloud, seleziona Monitoring, quindi seleziona  Integrazioni oppure fai clic sul pulsante seguente:

    Vai a Integrazioni

  2. Fai clic sul filtro Compute Engine per piattaforma di deployment.
  3. Individua la voce per HBase e fai clic su Visualizza dettagli.
  4. Seleziona la scheda Dashboard per visualizzare un'anteprima statica. Se la dashboard è installata, puoi accedervi facendo clic su Visualizza dashboard.

Per ulteriori informazioni sulle dashboard in Cloud Monitoring, consulta Dashboard e grafici.

Per saperne di più sull'utilizzo della pagina Integrazioni, consulta Gestire le integrazioni.

Installa criteri di avviso

I criteri di avviso indicano a Cloud Monitoring di inviarti una notifica quando si verificano condizioni specificate. L'integrazione di HBase include uno o più criteri di avviso che puoi utilizzare. Puoi visualizzare e installare questi criteri di avviso dalla pagina Integrazioni in Monitoring.

Per visualizzare le descrizioni dei criteri di avviso disponibili e installarli:

  1. Nella console Google Cloud, seleziona Monitoring, quindi seleziona  Integrazioni oppure fai clic sul pulsante seguente:

    Vai a Integrazioni

  2. Individua la voce per HBase e fai clic su Visualizza dettagli.
  3. Seleziona la scheda Avvisi. Questa scheda fornisce descrizioni dei criteri di avviso disponibili e un'interfaccia per installarli.
  4. Installa i criteri di avviso. I criteri di avviso devono sapere dove inviare le notifiche relative all'attivazione dell'avviso, quindi richiedono informazioni da parte tua per l'installazione. Per installare i criteri di avviso, segui questi passaggi:
    1. Dall'elenco dei criteri di avviso disponibili, seleziona quelli che vuoi installare.
    2. Nella sezione Configura notifiche, seleziona uno o più canali di notifica. Puoi scegliere di disattivare l'utilizzo dei canali di notifica, ma in questo caso i criteri di avviso vengono attivati senza alcun avviso. Puoi verificarne lo stato in Monitoring, ma non riceverai alcuna notifica.

      Per maggiori informazioni sui canali di notifica, vedi Gestire i canali di notifica.

    3. Fai clic su Crea criteri.

Per ulteriori informazioni sui criteri di avviso in Cloud Monitoring, consulta Introduzione agli avvisi.

Per saperne di più sull'utilizzo della pagina Integrazioni, consulta Gestire le integrazioni.

Passaggi successivi

Per una procedura dettagliata su come utilizzare Ansible per installare Ops Agent, configurare un'applicazione di terze parti e installare una dashboard di esempio, consulta il video Installare Ops Agent per la risoluzione dei problemi delle applicazioni di terze parti.