L'integrazione di Apache Cassandra raccoglie metriche di richiesta, 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 la telemetria di 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 successive.
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 anche impostare 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 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 7199
, specifica quanto segue all'avvio della JVM:
-Dcom.sun.management.jmxremote.port=7199
Configura Ops Agent per Cassandra
Segui 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 la 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 saperne di più, consulta Configurare la raccolta di metriche.
Configura la raccolta dei log
Per importare i log da Cassandra, devi creare ricevitori per i log prodotti da Cassandra, quindi creare una pipeline per i nuovi ricevitori.
Per configurare un ricevitore per i log cassandra_system
, 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 |
[/var/log/cassandra/system*.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/cassandra/system*.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 cassandra_system . |
|
wildcard_refresh_interval |
60s |
L'intervallo in base al quale vengono aggiornati i percorsi dei file con caratteri jolly in include_paths . Indicata 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 dell'intervallo predefinito. |
Per configurare un ricevitore per i log cassandra_debug
, 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 |
[/var/log/cassandra/debug*.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/cassandra/system*.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 cassandra_debug . |
|
wildcard_refresh_interval |
60s |
L'intervallo in base al quale vengono aggiornati i percorsi dei file con caratteri jolly in include_paths . Indicata 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 dell'intervallo predefinito. |
Per configurare un ricevitore per i log cassandra_gc
, 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 |
[/var/log/cassandra/gc.log.*.current] |
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/cassandra/system*.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 cassandra_gc . |
|
wildcard_refresh_interval |
60s |
L'intervallo in base al quale vengono aggiornati i percorsi dei file con caratteri jolly in include_paths . Indicata 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 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
.
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 in cui ha avuto origine il log |
jsonPayload.level |
string | Livello di 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 analisi dettagliata dello stack, se fornita |
jsonPayload.module |
string | Modulo di cassandra in cui ha avuto origine il log |
severity |
stringa (LogSeverity ) |
Livello di voce di log (tradotto) |
I log cassandra_debug
contengono i seguenti campi in LogEntry
:
Campo | Tipo | Descrizione |
---|---|---|
jsonPayload.javaClass |
string | Classe Java in cui ha avuto origine il log |
jsonPayload.level |
string | Livello di 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 in cui ha avuto origine il log |
severity |
stringa (LogSeverity ) |
Livello di 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 interrotta per la garbage collection |
jsonPayload.timeStopping |
string | Secondi impiegati dalla JVM per interrompere i thread prima della garbage collection |
jsonPayload.uptime |
string | Secondi in cui la JVM è stata attiva |
severity |
stringa (LogSeverity ) |
Livello di voce di log (tradotto) |
Configurazione della raccolta di metriche
Per importare le metriche da Cassandra, devi creare un ricevitore per le metriche prodotta da Cassandra, 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 cassandra
, 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 di tempo, come 30s o 5m . |
endpoint |
localhost:7199 |
L'URL o l'host e la porta del servizio JMX 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 di servizio di service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi . |
password |
La password configurata se JMX è configurato in modo da richiedere l'autenticazione. | |
type |
Il valore deve essere cassandra . |
|
username |
Il nome utente configurato se JMX è configurato in modo da richiedere l'autenticazione. |
Che cosa viene monitorato
La tabella seguente fornisce l'elenco delle metriche raccolte da Ops Agent dall'istanza Cassandra.
Tipo di metrica | |
---|---|
Tipo Risorse monitorate |
Etichette |
workload.googleapis.com/cassandra.client.request.count
|
|
CUMULATIVE , INT64 gce_instance |
operation
|
workload.googleapis.com/cassandra.client.request.error.count
|
|
CUMULATIVE , INT64 gce_instance |
operation
status
|
workload.googleapis.com/cassandra.client.request.range_slice.latency.50p
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.client.request.range_slice.latency.99p
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.client.request.range_slice.latency.max
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.client.request.read.latency.50p
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.client.request.read.latency.99p
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.client.request.read.latency.max
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.client.request.write.latency.50p
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.client.request.write.latency.99p
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.client.request.write.latency.max
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.compaction.tasks.completed
|
|
CUMULATIVE , INT64 gce_instance |
|
workload.googleapis.com/cassandra.compaction.tasks.pending
|
|
GAUGE , INT64 gce_instance |
|
workload.googleapis.com/cassandra.storage.load.count
|
|
GAUGE , INT64 gce_instance |
|
workload.googleapis.com/cassandra.storage.total_hints.count
|
|
CUMULATIVE , INT64 gce_instance |
|
workload.googleapis.com/cassandra.storage.total_hints.in_progress.count
|
|
GAUGE , INT64 gce_instance |
Verificare la configurazione
Questa sezione descrive come verificare di aver configurato correttamente il ricevitore Cassandra. Potrebbero essere necessari uno o due minuti prima che Ops Agent inizi a raccogliere i dati di telemetria.
Per verificare che i log di Cassandra vengano inviati a Cloud Logging, segui questi passaggi:
-
Nel pannello di navigazione della console Google Cloud, seleziona Logging e poi Esplora log:
- Inserisci la seguente query nell'editor e 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 Cassandra vengano inviate a Cloud Monitoring, segui questi passaggi:
-
Nel pannello di navigazione della console Google Cloud, seleziona Monitoring e poi leaderboard Metrics Explorer:
- Nella barra degli strumenti del riquadro del generatore di query, seleziona il pulsante il cui nome è code MQL o code PromQL.
- 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.
- Inserisci la seguente query nell'editor e fai clic su Esegui query:
fetch gce_instance | metric 'workload.googleapis.com/cassandra.client.request.count' | every 1m
Visualizza dashboard
Per visualizzare le metriche Cassandra, devi aver configurato un grafico o una dashboard. L'integrazione di Cassandra 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:
-
Nel pannello di navigazione della console Google Cloud, seleziona Monitoring, quindi seleziona Dashboard:
- 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 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:
-
Nel pannello di navigazione della console Google Cloud, seleziona Monitoring e poi Integrazioni:
- Fai clic sul filtro della piattaforma di deployment di Compute Engine.
- Individua la voce 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, 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 Cassandra 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:
-
Nel pannello di navigazione della console Google Cloud, seleziona Monitoring e poi Integrazioni:
- Individua la voce Cassandra 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 notifiche relative all'attivazione dell'avviso, quindi 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. 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.
- 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.