L'integrazione di Apache Kafka raccoglie metriche del broker, come richieste di argomenti e errori. Monitora anche le partizioni sul broker. L'integrazione raccoglie i log di Kafka e li analizza in un payload JSON. Il risultato include campi per logger, livello e messaggio.
Per ulteriori informazioni su Kafka, consulta la documentazione di Apache Kafka.
Prerequisiti
Per raccogliere la telemetria di Kafka, devi installare Ops Agent:
- Per le metriche, installa la versione 2.10.0 o successive.
- Per i log, installa la versione 2.10.0 o successive.
Questa integrazione supporta le versioni di Kafka dalla 0.8 alla 3.0.0.
Configura l'istanza Kafka
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 in remoto, devi impostare anche la proprietà di sistema java.rmi.server.hostname
.
Per impostazione predefinita, queste proprietà sono impostate nel file bin/kafka-run-class.sh
di un deployment Kafka.
Per impostare le proprietà di sistema utilizzando gli 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 9999
, specifica quanto segue all'avvio della JVM:
-Dcom.sun.management.jmxremote.port=9999
Configura Ops Agent per Kafka
Segui la guida per la configurazione di Ops Agent, aggiungi gli elementi richiesti per raccogliere i dati di telemetria dalle istanze Kafka e riavvia l'agente.
Configurazione di esempio
Il comando seguente crea la configurazione per raccogliere e importare la telemetria di Kafka e riavvia Ops Agent.
Configura la raccolta dei log
Per importare i log da Kafka, devi creare ricevitori per i log prodotti da Kafka e quindi creare una pipeline per i nuovi ricevitori.
Per configurare un ricevitore per i log kafka
, specifica i seguenti campi:
Campo | Predefinito | Descrizione |
---|---|---|
exclude_paths |
Un elenco di pattern di percorsi del file system da escludere dal set corrispondente da include_paths . |
|
include_paths |
[/var/log/kafka/*.log] |
Un elenco di percorsi di file system da leggere mediante il tailing di ogni file. È possibile utilizzare un carattere jolly * nei percorsi, ad esempio /var/log/kafka*/*.log . |
record_log_file_path |
false |
Se il criterio è 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 |
Questo valore deve essere kafka . |
|
wildcard_refresh_interval |
60s |
L'intervallo con cui vengono aggiornati i percorsi dei file con caratteri jolly in include_paths . Data come durata di tempo analizzabile da time.ParseDuration, ad esempio 30s o 2m . Questa proprietà potrebbe essere utile con velocità effettiva di logging elevate, in cui i file di log vengono ruotati più velocemente rispetto all'intervallo predefinito. |
Cosa viene registrato
logName
deriva dagli ID destinatario specificati nella configurazione. Di seguito sono riportati i campi dettagliati all'interno della LogEntry
.
I log kafka
contengono i seguenti campi in LogEntry
:
Campo | Tipo | Descrizione |
---|---|---|
jsonPayload.level |
stringa (LogSeverity ) |
Livello di voce di log |
jsonPayload.logger |
stringa (Timestamp ) |
Nome del logger da cui ha avuto origine il log. |
jsonPayload.message |
string | Messaggio di log, inclusa l'analisi dettagliata dello stack, se presente |
jsonPayload.source |
string | Modulo e/o thread da cui ha avuto origine il log. |
severity |
string | Livello di voce di log (tradotto). |
timestamp |
string | L'ora di ricezione della richiesta. |
Configurazione della raccolta di metriche
Per importare le metriche da Kafka, devi creare un ricevitore per le metriche produttive da Kafka e 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 kafka
, specifica i seguenti campi:
Campo | Predefinito | Descrizione |
---|---|---|
stub_status_url |
localhost:9999 |
L'URL del servizio JMX o l'host e la porta utilizzati per creare l'URL del servizio. Deve essere nel formato service:jmx:<protocol>:<sap> o host:port . I valori nel formato host:port verranno utilizzati per creare un URL del servizio di service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi . |
collect_jvm_metrics |
true |
Consente di configurare il ricevitore in modo che raccolga anche le metriche JVM supportate. |
collection_interval |
60s |
Un valore di durata del tempo, ad esempio 30s o 5m . |
password |
La password configurata se JMX è configurato per richiedere l'autenticazione. | |
stub_status_url |
localhost:9999 |
L'host o l'URL del servizio JMX e la porta utilizzati per creare l'URL del servizio. Questo valore deve essere nel formato service:jmx: |
type |
Questo valore deve essere kafka . |
|
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 Kafka.
Tipo di metrica | |
---|---|
Tipo, tipo Risorse monitorate |
Etichette |
workload.googleapis.com/kafka.isr.operation.count
|
|
CUMULATIVE , INT64 gce_instance |
operation
|
workload.googleapis.com/kafka.message.count
|
|
CUMULATIVE , INT64 gce_instance |
|
workload.googleapis.com/kafka.network.io
|
|
CUMULATIVE , INT64 gce_instance |
state
|
workload.googleapis.com/kafka.partition.count
|
|
GAUGE , INT64 gce_instance |
|
workload.googleapis.com/kafka.partition.offline
|
|
GAUGE , INT64 gce_instance |
|
workload.googleapis.com/kafka.partition.under_replicated
|
|
GAUGE , INT64 gce_instance |
|
workload.googleapis.com/kafka.purgatory.size
|
|
GAUGE , INT64 gce_instance |
type
|
workload.googleapis.com/kafka.request.count
|
|
CUMULATIVE , INT64 gce_instance |
type
|
workload.googleapis.com/kafka.request.failed
|
|
CUMULATIVE , INT64 gce_instance |
type
|
workload.googleapis.com/kafka.request.time.total
|
|
CUMULATIVE , INT64 gce_instance |
type
|
Verificare la configurazione
Questa sezione descrive come verificare di aver configurato correttamente il ricevitore Kafka. Ops Agent potrebbe impiegare uno o due minuti per iniziare a raccogliere i dati di telemetria.
Per verificare che i log di Kafka vengano inviati a Cloud Logging, segui questi passaggi:
-
Nella console Google Cloud, vai alla pagina Esplora log:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato il cui sottotitolo è Logging.
- Inserisci la seguente query nell'editor e fai clic su Esegui query:
resource.type="gce_instance" log_id("kafka")
Per verificare che le metriche di Kafka vengano inviate a Cloud Monitoring:
-
Nella console Google Cloud, vai alla pagina Metrics Explorer leaderboard:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato il cui sottotitolo è Monitoring.
- Nella barra degli strumenti del riquadro del generatore di query, seleziona il pulsante il cui nome è code MQL o code PromQL.
- 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.
- Inserisci la seguente query nell'editor e fai clic su Esegui query:
fetch gce_instance | metric 'workload.googleapis.com/kafka.message.count' | every 1m
Visualizza dashboard
Per visualizzare le metriche di Kafka, devi aver configurato un grafico o una dashboard. L'integrazione di Kafka 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, segui questi passaggi:
-
Nella console Google Cloud, vai alla pagina Dashboard:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato il cui sottotitolo è Monitoring.
- Seleziona la scheda Elenco dashboard, quindi scegli la categoria Integrazioni.
- Fai clic sul nome della dashboard da visualizzare.
Se hai configurato un'integrazione, ma la dashboard non è stata installata, verifica che Ops Agent sia in esecuzione. Se nella dashboard non sono disponibili dati delle metriche per un grafico, l'installazione della dashboard non riesce. Dopo che Ops Agent ha iniziato a raccogliere le metriche, la dashboard viene installata automaticamente.
Per visualizzare un'anteprima statica della dashboard:
-
Nella console Google Cloud, vai alla pagina Integrazioni:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato il cui sottotitolo è Monitoring.
- Fai clic sul filtro piattaforma di deployment di Compute Engine.
- Individua la voce per Kafka e fai clic su Visualizza dettagli.
- 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 ulteriori informazioni 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 Kafka 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:
-
Nella console Google Cloud, vai alla pagina Integrazioni:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato il cui sottotitolo è Monitoring.
- Individua la voce per Kafka e fai clic su Visualizza dettagli.
- Seleziona la scheda Avvisi. Questa scheda fornisce descrizioni dei criteri di avviso disponibili e un'interfaccia per installarli.
- Installa i criteri di avviso. I criteri di avviso devono sapere dove inviare le notifiche relative all'attivazione dell'avviso, per cui richiedono informazioni da parte tua per l'installazione.
Per installare i criteri di avviso:
- Dall'elenco dei criteri di avviso disponibili, seleziona quelli che vuoi installare.
Nella sezione Configura le notifiche, seleziona uno o più canali di notifica. Puoi disattivare l'utilizzo dei canali di notifica. Tuttavia, in questo caso i criteri di avviso si attivano in modo invisibile. Puoi verificarne lo stato in Monitoring, ma non ricevi notifiche.
Per maggiori informazioni sui canali di notifica, consulta la pagina Gestire i canali di notifica.
- Fai clic su Crea criteri.
Per ulteriori informazioni sui criteri di avviso in Cloud Monitoring, consulta Introduzione agli avvisi.
Per ulteriori informazioni 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.