Apache Kafka

L'integrazione di Apache Kafka raccoglie le metriche del broker, ad esempio richieste e errori relativi agli argomenti. Inoltre, monitora le partizioni sul broker. L'integrazione raccoglie i log Kafka e li analizza in un payload JSON. Il risultato include per logger, livello e messaggio.

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

Prerequisiti

Per raccogliere dati di telemetria Kafka, devi installa Ops Agent:

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

Questa integrazione supporta le versioni Kafka da 0.8 a 3.0.0.

Configura la tua istanza Kafka

Per esporre un endpoint JMX, devi impostare la proprietà di sistema com.sun.management.jmxremote.port quando avvii la JVM. Ti consigliamo inoltre di impostare il com.sun.management.jmxremote.rmi.port proprietà di sistema alla stessa porta. Per esporre un endpoint JMX da remoto, devi impostare anche la proprietà di sistema java.rmi.server.hostname.

Per impostazione predefinita, queste proprietà sono impostate nella bin/kafka-run-class.sh.

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

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

Configura Ops Agent per Kafka

Segui la guida per configurare Ops Agent, aggiungi gli elementi necessari per raccogliere la telemetria dalle istanze Kafka e riavvia l'agente.

Configurazione di esempio

I comandi seguenti creano la configurazione per raccogliere e importare dati di telemetria per Kafka e riavviare 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:
    kafka:
      type: kafka
  service:
    pipelines:
      kafka:
        receivers:
          - kafka
logging:
  receivers:
    kafka:
      type: kafka
  service:
    pipelines:
      kafka:
        receivers:
          - kafka
EOF

sudo service google-cloud-ops-agent restart

Configura la raccolta dei log

Per importare i log da Kafka, devi creare un ricevitore per i log prodotto da Kafka, quindi crea una pipeline per il nuovo ricevitore.

Per configurare un ricevitore per i log di kafka, specifica quanto segue campi:

Che cosa viene registrato

logName deriva da gli ID destinatario specificati nella configurazione. I campi dettagliati all'interno di LogEntry sono i seguenti.

I log kafka contengono i seguenti campi in LogEntry:

Configurazione della raccolta di metriche

Per importare le metriche da Kafka, devi creare un ricevitore per le metriche prodotte da Kafka e poi una pipeline per il nuovo ricevitore.

Questo ricevitore non supportare l'uso 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 kafka, specifica quanto segue campi:

Che cosa viene monitorato

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

Verificare la configurazione

Questa sezione descrive come verificare di aver configurato correttamente il ricevitore Kafka. L'inizio della raccolta della telemetria da parte di Ops Agent potrebbe richiedere uno o due minuti.

per verificare che i log Kafka vengano inviati Cloud Logging, segui questi passaggi:

1. Nella console Google Cloud, vai alla pagina Esplora log:

   Vai a Esplora log

   Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Logging.

2. Inserisci la seguente query nell'editor e poi fai clic su Esegui query:
   

   resource.type="gce_instance"
   log_id("kafka")
   

Per verificare che le metriche di Kafka vengano inviate a Cloud Monitoring:

1. Nella console Google Cloud, vai alla pagina leaderboard Esplora metriche:

   Vai a Esplora metriche

   Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

2. Nella barra degli strumenti della riquadro Query Builder, seleziona il pulsante con code MQL o code PromQL.
3. Verifica che sia selezionato MQL 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 poi fai clic su Esegui query:
   

   fetch gce_instance
   | metric 'workload.googleapis.com/kafka.message.count'
   | every 1m
   

Visualizza dashboard

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

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

Per visualizzare una dashboard installata:

1. Nella console Google Cloud, vai alla pagina  Dashboard:

   Vai a Dashboard

   Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

2. Seleziona la scheda Elenco dashboard e poi 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, controlla che l'agente operativo sia in esecuzione. Quando non c'è 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 per te.

Per visualizzare un'anteprima statica della dashboard:

1. Nella console Google Cloud, vai alla pagina  Integrazioni:

   Vai a Integrazioni

   Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

2. Fai clic sul filtro della piattaforma di deployment di Compute Engine.
3. Individua la voce relativa a Kafka 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, vedi Gestisci le integrazioni.

Installa i criteri di avviso

I criteri di avviso indicano a Cloud Monitoring di avvisarti quando che si verifichino determinate condizioni. L'integrazione di Kafka include uno o più criteri di avviso da utilizzare. Puoi visualizzare e installare questi criteri di avviso dalla pagina Integrations (Integrazioni) in Monitoraggio.

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

1. Nella console Google Cloud, vai alla  Integrazioni pagina:

   Vai a Integrations (Integrazioni).

   Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

2. Individua la voce relativa a Kafka 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 che indicano che l'avviso è stato attivato, quindi richiedono informazioni da te per l'installazione. Per installare i criteri di avviso, segui questi passaggi:
   1. Nell'elenco dei criteri di avviso disponibili, seleziona quelli che vuoi installare.

   2. Nella sezione Configura notifiche, seleziona uno o più canali di notifica. Puoi disattivare l'uso dei canali di notifica, ma in questo caso i criteri di avviso vengono attivati in modo silenzioso. Puoi verificarne lo stato nella Monitoraggio, ma non riceverai notifiche.

      Per ulteriori informazioni sui canali di notifica, consulta Gestisci canali di notifica.

   3. Fai clic su Crea criteri.

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

Per saperne di più sull'utilizzo della pagina Integrazioni, vedi Gestisci le integrazioni.

Passaggi successivi

Per una procedura dettagliata su come utilizzare Ansible per installare Ops Agent, configura un'applicazione di terze parti e installare una dashboard di esempio, consulta Video: installa Ops Agent per risolvere i problemi relativi alle applicazioni di terze parti.