L'integrazione di Apache Cassandra raccoglie metriche su richieste, attività e archiviazione che evidenziano il carico su un'istanza. Facoltativamente, l'integrazione può anche raccogliere metriche JVM generali relative alla memoria e alla garbage collection. L'integrazione raccoglie anche log di sistema, di debug e di garbage collection. Questi log vengono analizzati in un payload JSON, che include i campi per il messaggio, la classe Java e il numero di riga.
Per ulteriori informazioni su Cassandra, consulta la documentazione di Apache Cassandra.
Prerequisiti
Per raccogliere dati di telemetria Cassandra, devi installare Ops Agent:
- Per le metriche, installa la versione 2.6.0 o successive.
- Per i log, installa la versione 2.5.0 o successiva.
Questa integrazione supporta le versioni Cassandra 3.11 e 4.0.
Configura l'istanza Cassandra
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 impostare anche la proprietà di sistema java.rmi.server.hostname.
Per impostazione predefinita, queste proprietà sono impostate nel file cassandra-env.sh di un deployment Cassandra.
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 7199, specifica quanto segue quando avvii la JVM:
-Dcom.sun.management.jmxremote.port=7199
Configura Ops Agent per Cassandra
Seguendo la guida per la configurazione di Ops Agent, aggiungi gli elementi richiesti per raccogliere la telemetria dalle istanze Cassandra e riavvia l'agente.
Configurazione di esempio
I comandi seguenti creano la configurazione per raccogliere e importare i dati di telemetria per Cassandra 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:
cassandra:
type: cassandra
endpoint: service:jmx:rmi:///jndi/rmi://127.0.0.1:7199/jmxrmi
service:
pipelines:
cassandra:
receivers:
- cassandra
logging:
receivers:
cassandra_system:
type: cassandra_system
cassandra_debug:
type: cassandra_debug
cassandra_gc:
type: cassandra_gc
service:
pipelines:
cassandra:
receivers:
- cassandra_system
- cassandra_debug
- cassandra_gc
EOF
sudo service google-cloud-ops-agent restart
sleep 60
In questo esempio, le proprietà di sistema com.sun.management.jmxremote.port e com.sun.management.jmxremote.rmi.port sono state impostate su 7199 e la proprietà di sistema java.rmi.server.hostname è stata impostata su 127.0.0.1. Per
ulteriori informazioni, consulta Configurare la raccolta delle metriche.
Configura la raccolta dei log
Per importare i log da Cassandra, devi creare ricevitori per i log prodotti da Cassandra e quindi creare una pipeline per i nuovi ricevitori.
Per configurare un ricevitore per i log di cassandra_system, specifica i seguenti campi:
| Campo | Predefinita | Descrizione |
|---|---|---|
exclude_paths |
Un elenco di pattern di percorso del file system da escludere dal set con corrispondenza in base a include_paths. |
|
include_paths |
[/var/log/cassandra/system*.log] |
Un elenco di percorsi di file system da leggere eseguendo la coda di ogni file. Nei percorsi è possibile utilizzare un carattere jolly (*), ad esempio /var/log/cassandra/system*.log. |
record_log_file_path |
false |
Se il criterio viene 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 cassandra_system. |
|
wildcard_refresh_interval |
60s |
L'intervallo di aggiornamento dei percorsi dei file con caratteri jolly in include_paths. Valore come durata analizzabile da time.ParseDuration, ad esempio 30s o 2m. Questa proprietà può essere utile in caso di velocità effettiva di logging elevate, in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito. |
Per configurare un ricevitore per i log di cassandra_debug, specifica i seguenti campi:
| Campo | Predefinita | Descrizione |
|---|---|---|
exclude_paths |
[] |
Un elenco di pattern di percorso del file system da escludere dal set con corrispondenza in base a include_paths. |
include_paths |
[/var/log/cassandra/debug*.log] |
Un elenco di percorsi di file system da leggere eseguendo la coda di ogni file. Nei percorsi è possibile utilizzare un carattere jolly (*), ad esempio /var/log/cassandra/system*.log. |
record_log_file_path |
false |
Se il criterio viene 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 cassandra_debug. |
|
wildcard_refresh_interval |
60s |
L'intervallo di aggiornamento dei percorsi dei file con caratteri jolly in include_paths. Valore come durata analizzabile da time.ParseDuration, ad esempio 30s o 2m. Questa proprietà può essere utile in caso di velocità effettiva di logging elevate, in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito. |
Per configurare un ricevitore per i log di cassandra_gc, specifica i seguenti campi:
| Campo | Predefinita | Descrizione |
|---|---|---|
exclude_paths |
[] |
Un elenco di pattern di percorso del file system da escludere dal set con corrispondenza in base a include_paths. |
include_paths |
[/var/log/cassandra/gc.log.*.current] |
Un elenco di percorsi di file system da leggere eseguendo la coda di ogni file. Nei percorsi è possibile utilizzare un carattere jolly (*), ad esempio /var/log/cassandra/system*.log. |
record_log_file_path |
false |
Se il criterio viene 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 cassandra_gc. |
|
wildcard_refresh_interval |
60s |
L'intervallo di aggiornamento dei percorsi dei file con caratteri jolly in include_paths. Valore come durata analizzabile da time.ParseDuration, ad esempio 30s o 2m. Questa proprietà può essere utile in caso di velocità effettiva di logging elevate, in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito. |
Che cosa viene registrato
logName deriva dagli ID destinatario specificati nella configurazione. Di seguito sono riportati i campi dettagliati all'interno di LogEntry.
Le voci di log non contengono campi vuoti o mancanti.
I log cassandra_system contengono i seguenti campi in LogEntry:
| Campo | Tipo | Descrizione |
|---|---|---|
jsonPayload.javaClass |
string | Classe Java da cui ha avuto origine il log |
jsonPayload.level |
string | Livello voce di log |
jsonPayload.lineNumber |
string | Numero di riga del file di origine da cui ha avuto origine il log |
jsonPayload.message |
string | Messaggio di log, inclusa l'analisi dettagliata dello stack, se fornita |
jsonPayload.module |
string | Modulo di Cassandra da cui ha avuto origine il tronco |
severity |
stringa (LogSeverity) |
Livello voce di log (tradotto) |
I log cassandra_debug contengono i seguenti campi in LogEntry:
| Campo | Tipo | Descrizione |
|---|---|---|
jsonPayload.javaClass |
string | Classe Java da cui ha avuto origine il log |
jsonPayload.level |
string | Livello voce di log |
jsonPayload.lineNumber |
string | Numero di riga del file di origine da cui ha avuto origine il log |
jsonPayload.message |
string | Messaggio di log |
jsonPayload.module |
string | Modulo di Cassandra da cui ha avuto origine il tronco |
severity |
stringa (LogSeverity) |
Livello voce di log (tradotto) |
I log cassandra_gc contengono i seguenti campi in LogEntry:
| Campo | Tipo | Descrizione |
|---|---|---|
jsonPayload.message |
string | Messaggio di log |
jsonPayload.timeStopped |
string | Secondi in cui la JVM è stata arrestata per la garbage collection |
jsonPayload.timeStopping |
string | Secondi utilizzati dalla JVM per arrestare i thread prima della garbage collection |
jsonPayload.uptime |
string | Secondi in cui la JVM è stata attiva |
severity |
stringa (LogSeverity) |
Livello voce di log (tradotto) |
Configurazione della raccolta di metriche
Per importare le metriche da Cassandra, devi creare un ricevitore per le metriche prodotte da Cassandra 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 cassandra, specifica i seguenti campi:
| Campo | Predefinita | 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:7199 |
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 formato host:port vengono utilizzati per creare un URL del servizio service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi. |
password |
La password configurata se JMX è configurato per richiedere l'autenticazione. | |
type |
Il valore deve essere cassandra. |
|
username |
Il nome utente configurato se JMX è configurato per richiedere l'autenticazione. |
Che cosa viene monitorato
La tabella seguente fornisce l'elenco delle metriche che Ops Agent raccoglie dall'istanza Cassandra.
| Tipo di metrica | |
|---|---|
| Tipo, tipo Risorse monitorate |
Etichette |
workload.googleapis.com/cassandra.client.request.count
|
|
CUMULATIVE, INT64gce_instance |
operation
|
workload.googleapis.com/cassandra.client.request.error.count
|
|
CUMULATIVE, INT64gce_instance |
operation
status
|
workload.googleapis.com/cassandra.client.request.range_slice.latency.50p
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.client.request.range_slice.latency.99p
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.client.request.range_slice.latency.max
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.client.request.read.latency.50p
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.client.request.read.latency.99p
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.client.request.read.latency.max
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.client.request.write.latency.50p
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.client.request.write.latency.99p
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.client.request.write.latency.max
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.compaction.tasks.completed
|
|
CUMULATIVE, INT64gce_instance |
|
workload.googleapis.com/cassandra.compaction.tasks.pending
|
|
GAUGE, INT64gce_instance |
|
workload.googleapis.com/cassandra.storage.load.count
|
|
GAUGE, INT64gce_instance |
|
workload.googleapis.com/cassandra.storage.total_hints.count
|
|
CUMULATIVE, INT64gce_instance |
|
workload.googleapis.com/cassandra.storage.total_hints.in_progress.count
|
|
GAUGE, INT64gce_instance |
|
Verificare la configurazione
In questa sezione viene descritto come verificare di aver configurato correttamente il ricevitore Cassandra. Ops Agent potrebbe impiegare uno o due minuti per iniziare a raccogliere dati di telemetria.
Per verificare che i log di Cassandra vengano inviati a Cloud Logging, segui questi passaggi:
-
Nella console Google Cloud, vai alla pagina Esplora log:
Se usi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Logging.
- Inserisci la seguente query nell'editor, quindi fai clic su Esegui query:
resource.type="gce_instance" (log_id("cassandra_system") OR log_id("cassandra_debug") OR log_id("cassandra_gc"))
Per verificare che le metriche di Cassandra vengano inviate a Cloud Monitoring, segui questi passaggi:
-
Nella console Google Cloud, vai alla pagina leaderboard Esplora metriche:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
- Nella barra degli strumenti del riquadro di creazione di query, seleziona il pulsante con il nome code MQL o code PromQL.
- Verifica che sia selezionato MQL nell'opzione di attivazione/disattivazione Lingua. L'opzione di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti che ti consente di formattare la query.
- Inserisci la seguente query nell'editor, quindi fai clic su Esegui query:
fetch gce_instance | metric 'workload.googleapis.com/cassandra.client.request.count' | every 1m
Visualizza dashboard
Per visualizzare le metriche di Cassandra, devi aver configurato un grafico o una dashboard. L'integrazione di Cassandra include una o più dashboard per te. Qualsiasi dashboard viene installata automaticamente dopo che hai configurato l'integrazione e 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:
-
Nella console Google Cloud, vai alla pagina Dashboard
:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
- Seleziona la scheda Elenco dashboard, quindi scegli la categoria Integrazioni.
- 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 presenti dati delle metriche per un grafico nella dashboard, l'installazione della dashboard non riesce. Dopo che Ops Agent inizia 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 con il sottotitolo Monitoring.
- Fai clic sul filtro della piattaforma di deployment di Compute Engine.
- Individua la voce per Cassandra 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 saperne di più sull'utilizzo della pagina Integrazioni, vedi Gestire le integrazioni.
Installa criteri di avviso
I criteri di avviso indicano a Cloud Monitoring di avvisarti quando si verificano condizioni specificate. L'integrazione di Cassandra include uno o più criteri di avviso da 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, segui questi passaggi:
-
Nella console Google Cloud, vai alla pagina
Integrazioni:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
- Individua la voce per Cassandra e fai clic su Visualizza dettagli.
- Seleziona la scheda Avvisi. Questa scheda fornisce le descrizioni dei criteri di avviso disponibili e fornisce un'interfaccia per installarli.
- Installa i criteri di avviso. I criteri di avviso devono sapere dove inviare le notifiche di attivazione dell'avviso, pertanto richiedono informazioni da parte tua per l'installazione.
Per installare i criteri di avviso, segui questi passaggi:
- Dall'elenco dei criteri di avviso disponibili, seleziona quelli che vuoi installare.
Nella sezione Configura notifiche, seleziona uno o più canali di notifica. Puoi scegliere di disabilitare l'utilizzo dei canali di notifica, ma in questo caso i criteri di avviso vengono attivati automaticamente. Puoi verificarne lo stato in Monitoring, ma non riceverai notifiche.
Per maggiori informazioni sui canali di notifica, consulta la pagina relativa alla gestione dei canali di notifica.
- 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, vedi 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, guarda il video Installare Ops Agent per risolvere i problemi delle applicazioni di terze parti.