Apache Cassandra

L'integrazione di Apache Cassandra raccoglie metriche relative a richieste, attività e archiviazione per evidenziare il carico su un'istanza. Se vuoi, l'integrazione può anche raccogliere le metriche generali della JVM relative alla memoria e alla raccolta dei rifiuti. L'integrazione raccoglie anche i log di sistema, di debug e di garbage collection. Questi log vengono analizzati in un payload JSON, che include 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 installa 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 la tua istanza Cassandra

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 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 di Cassandra.

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 7199, specifica quanto segue all'avvio della JVM:

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

Configurare Ops Agent per Cassandra

Seguendo la guida alla configurazione di Ops Agent, aggiungi gli elementi necessari per raccogliere la telemetria dalle istanze Cassandra e riavvia l'agente.

Configurazione di esempio

I comandi seguenti creano la configurazione per raccogliere e importare dati di telemetria per Cassandra e riavvia 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

Configura la raccolta dei log

Per importare i log da Cassandra, devi creare un ricevitore per i log prodotti da Cassandra e poi una pipeline per il nuovo ricevitore.

Per configurare un destinatario 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 dall'insieme corrispondente a include_paths.
include_paths [/var/log/cassandra/system*.log] Un elenco di percorsi del file system da leggere tramite il comando tail di ogni 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 del log viene visualizzato nella voce del 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 cassandra_system.
wildcard_refresh_interval 60s L'intervallo di aggiornamento dei percorsi file con caratteri jolly in include_paths. Data come durata di tempo, 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 destinatario 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 dall'insieme corrispondente a include_paths.
include_paths [/var/log/cassandra/debug*.log] Un elenco di percorsi del file system da leggere tramite il comando tail 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 Questo valore deve essere cassandra_debug.
wildcard_refresh_interval 60s L'intervallo di aggiornamento dei percorsi file con caratteri jolly in include_paths. Data come durata di tempo, ad esempio 30s o 2m. Questa proprietà potrebbe essere utile in caso di flussi di lavoro elevati per la registrazione, in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito.

Per configurare un destinatario 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 dall'insieme corrispondente a include_paths.
include_paths [/var/log/cassandra/gc.log.*.current] Un elenco di percorsi del file system da leggere tramite il comando tail 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 Questo valore deve essere cassandra_gc.
wildcard_refresh_interval 60s L'intervallo di aggiornamento dei percorsi file con caratteri jolly in include_paths. Specificato come durata, ad esempio 30s o 2m. Questa proprietà potrebbe essere utile in caso di flussi di lavoro elevati per la registrazione, in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito.

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 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 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 la traccia dello stack dettagliata, se fornita
jsonPayload.module string Modulo di Cassandra da cui ha avuto origine il tronco
severity stringa (LogSeverity) Livello di voce del 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 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 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.level string Livello della voce di log
jsonPayload.message string Messaggio di log
jsonPayload.pid string ID processo del processo Java che registra il messaggio
jsonPayload.tid string ID thread del processo Java che registra il messaggio
jsonPayload.timeStopped string Secondi in cui la JVM è stata interrotta per la raccolta dei rifiuti
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 poi 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 destinatario 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 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 modulo host:port vengono utilizzati per creare un URL del servizio di service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi.
password La password configurata se JMX è configurato per richiedere l'autenticazione.
type Questo 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 raccolte da Ops Agent dall'istanza Cassandra.

Tipo di metrica 
Tipo, 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 dati di telemetria.

Per verificare che i log di Cassandra vengano inviati a Cloud Logging:

  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("cassandra_system") OR log_id("cassandra_debug") OR log_id("cassandra_gc"))

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

  1. Nella console Google Cloud, vai alla pagina  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  MQL o  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. 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/cassandra.client.request.count'
| every 1m

Visualizza dashboard

Per visualizzare le metriche di Cassandra, devi avere un grafico o una dashboard configurato. L'integrazione di Cassandra 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 installare 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, 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 installato, quindi verifica che Ops Agent sia in esecuzione. Se non sono disponibili dati metrici per un grafico nella dashboard, l'installazione della dashboard non va a buon fine. 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 per Cassandra e fai clic su Visualizza dettagli.
  4. Seleziona la scheda Dashboard per visualizzare un'anteprima statica. Se sia installata, quindi puoi accedervi facendo clic 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 i criteri di avviso

I criteri di avviso chiedono a Cloud Monitoring di inviarti una notifica quando si verificano condizioni specifiche. 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 Monitoraggio.

Per visualizzare le descrizioni dei criteri di avviso disponibili e procedi nel seguente modo:

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

    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 per Cassandra 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 richiedono per sapere dove inviare le notifiche relative a un avviso vengono attivati, quindi richiedono informazioni per l'installazione. Per installare i criteri di avviso:
    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 scegliere di disattivare l'uso dei canali di notifica, ma se lo fai, la funzione si attivano automaticamente. Puoi verificarne lo stato nella Monitoraggio, ma non riceverai notifiche.

      Per saperne di più sui canali di notifica, consulta la pagina Gestire i canali di notifica.

    3. Fai clic su Crea criteri.

Per ulteriori informazioni sui criteri di avviso in Cloud Monitoring, consulta la pagina 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 l'Ops Agent, configurare un'applicazione di terze parti e installare una dashboard di esempio, guarda il video Installa l'Ops Agent per risolvere i problemi relativi alle applicazioni di terze parti.