ZooKeeper Apache

L'integrazione Apache ZooKeeper raccoglie metriche sul traffico per i nodi, come latenza, richieste attive e connessioni attive. L'integrazione raccoglie inoltre i log di ZooKeeper e li analizza in un payload JSON. Il risultato include campi per ID nodo, origine, livello e messaggio.

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

Prerequisiti

Per raccogliere la telemetria di ZooKeeper, devi installare Ops Agent:

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

Questa integrazione supporta le versioni di ZooKeeper 3.5, 3.6 e 3.7.

Configura Ops Agent per ZooKeeper

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

Configurazione di esempio

I comandi seguenti creano la configurazione per raccogliere e importare la telemetria per ZooKeeper 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:
    zookeeper:
      type: zookeeper
  service:
    pipelines:
      zookeeper:
        receivers:
          - zookeeper

logging:
  receivers:
    zookeeper_general:
      type: zookeeper_general
  service:
    pipelines:
      zookeeper_general:
        receivers:
          - zookeeper_general

EOF

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

Configura la raccolta dei log

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

Per configurare un ricevitore per i log zookeeper_general, specifica i seguenti campi:

Campo Predefinito Descrizione
exclude_paths Un elenco di pattern di percorsi del file system da escludere dal set corrispondente a include_paths.
include_paths [/opt/zookeeper/logs/zookeeper-*.out, /var/log/zookeeper/zookeeper.log] Un elenco di percorsi di file system da leggere mediante la coda di ciascun file. Nei percorsi è possibile utilizzare un carattere jolly (*), ad esempio /var/log/zookeeper*/*.log.
record_log_file_path false Se impostato su true, il percorso del file specifico da cui è stato ottenuto il record di log viene visualizzato nella voce di log di output come valore dell'etichetta agent.googleapis.com/log_file_path. Quando utilizzi un carattere jolly, viene registrato solo il percorso del file da cui è stato ottenuto il record.
type Il valore deve essere zookeeper_general.
wildcard_refresh_interval 60s L'intervallo in cui i percorsi dei file con caratteri jolly in includi_path vengono aggiornati. Indicata come durata di tempo, 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 dell'intervallo predefinito.

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 zookeeper_general contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
jsonPayload.level string Livello di voce di log
jsonPayload.line number Numero della riga da cui è stato generato il log nell'origine
jsonPayload.message string Messaggio di log, inclusa analisi dettagliata dello stack, se fornita
jsonPayload.myid number ID numerico dell'istanza Zookeeper
jsonPayload.source string Origine dell'origine del log
jsonPayload.thread string Thread da cui ha avuto origine il log
severity stringa (LogSeverity) Livello di voce di log (tradotto).

Configurazione della raccolta di metriche

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

Questo destinatario 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 zookeeper, specifica i seguenti campi:

Campo Predefinito Descrizione
collection_interval 60s Una durata di tempo.
endpoint localhost:2181 L'URL esposto da ZooKeeper.
type Questo valore deve essere zookeeper.

Che cosa viene monitorato

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

Tipo di metrica
Tipo
Risorse monitorate		 Etichette
workload.googleapis.com/zookeeper.connection.active
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/zookeeper.data_tree.ephemeral_node.count
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/zookeeper.data_tree.size
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/zookeeper.file_descriptor.limit
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/zookeeper.file_descriptor.open
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/zookeeper.fsync.exceeded_threshold.count
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/zookeeper.latency.avg
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/zookeeper.latency.max
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/zookeeper.latency.min
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/zookeeper.packet.count
CUMULATIVE, INT64
gce_instance 		direction
workload.googleapis.com/zookeeper.request.active
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/zookeeper.watch.count
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/zookeeper.znode.count
GAUGE, INT64
gce_instance 		 

Verificare la configurazione

Questa sezione descrive come verificare di aver configurato correttamente il ricevitore ZooKeeper. Potrebbero essere necessari uno o due minuti prima che Ops Agent inizi a raccogliere i dati di telemetria.

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

  1. Nel pannello di navigazione della console Google Cloud, seleziona Logging e poi Esplora log:

    Vai a Esplora log

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

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

  1. Nel pannello di navigazione della console Google Cloud, seleziona Monitoring e poi  Metrics Explorer:

    Vai a Metrics Explorer

  2. Nella barra degli strumenti del riquadro del generatore di query, seleziona il pulsante il cui nome è  MQL o  PromQL.
  3. Verifica che MQL sia selezionato nel pulsante di attivazione/disattivazione Lingua. Il pulsante di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti che consente di formattare la query.
  4. Inserisci la seguente query nell'editor e fai clic su Esegui query: 
    fetch gce_instance
| metric 'workload.googleapis.com/zookeeper.file_descriptor.limit'
| every 1m

Visualizza dashboard

Per visualizzare le metriche di ZooKeeper, devi aver configurato un grafico o una dashboard. L'integrazione di ZooKeeper include una o più dashboard per te. 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. Nel pannello di navigazione della console Google Cloud, seleziona Monitoring, quindi seleziona  Dashboard:

    Vai a 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 delle 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. Nel pannello di navigazione della console Google Cloud, seleziona Monitoring e poi  Integrazioni:

    Vai a Integrazioni

  2. Fai clic sul filtro della piattaforma di deployment di Compute Engine.
  3. Individua la voce ZooKeeper 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 ZooKeeper 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. Nel pannello di navigazione della console Google Cloud, seleziona Monitoring e poi  Integrazioni:

    Vai a Integrazioni

  2. Individua la voce ZooKeeper 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 notifiche relative all'attivazione dell'avviso, quindi richiedono informazioni da parte tua per l'installazione. Per installare i criteri di avviso:
    1. Dall'elenco dei criteri di avviso disponibili, seleziona quelli che vuoi installare.

    2. Nella sezione Configura le notifiche, seleziona uno o più canali di notifica. Hai la possibilità di disattivare l'utilizzo dei canali di notifica, ma in questo caso i criteri di avviso si attivano automaticamente. Puoi controllarne lo stato in Monitoring, ma non ricevi notifiche.

      Per maggiori informazioni sui canali di notifica, consulta 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 istruzioni dettagliate su come utilizzare Ansible per installare Ops Agent, configurare un'applicazione di terze parti e installare una dashboard di esempio, guarda il video Installare Ops Agent per risolvere i problemi delle applicazioni di terze parti.