Apache Solr

L'integrazione di Apache Solr raccoglie le metriche principali e della cache. Obiettivo delle metriche principali delle richieste, del numero di documenti e delle dimensioni degli indici. Focus delle metriche cache sulla cache all'utilizzo delle risorse. L'integrazione raccoglie inoltre i log Solr e li analizza in una Payload JSON. Il risultato include i campi per shard, replica, core, livello e messaggio.

Per ulteriori informazioni su Solr, vedi documentazione di Apache Solr.

Prerequisiti

Per raccogliere la telemetria di Solr, 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 8.x e 7.7 di Solr.

Configura la tua istanza Solr

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. A esporre un endpoint JMX da remoto, devi anche impostare java.rmi.server.hostname proprietà di sistema.

Per impostazione predefinita, queste proprietà sono impostate nel deployment solr-env.sh.

Per impostare le proprietà di sistema utilizzando argomenti della riga di comando, anteponi la proprietà nome con -D all'avvio della JVM. Ad esempio, per impostare com.sun.management.jmxremote.port sulla porta 18983, specifica quanto segue all'avvio della JVM:

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

Configurare l'agente operativo per Solr

Seguendo la guida alla configurazione delle operazioni Agent, aggiungi gli elementi richiesti per raccogliere dati di telemetria dalle istanze Solr riavvia l'agente.

Configurazione di esempio

I seguenti comandi creano la configurazione per raccogliere e importare la telemetria per Solr 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:
    solr:
      type: solr
  service:
    pipelines:
      solr:
        receivers:
          - solr

logging:
  receivers:
    solr_system:
      type: solr_system
  service:
    pipelines:
      solr:
        receivers:
          - solr_system
EOF

sudo service google-cloud-ops-agent restart

Configura la raccolta dei log

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

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

Campo Predefinito 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/solr/logs/solr.log] Un elenco di percorsi di file system da leggere eseguendo il tailing di ogni file. Nei percorsi è possibile utilizzare un carattere jolly (*).
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 solr_system.
wildcard_refresh_interval 60s L'intervallo di aggiornamento dei percorsi dei 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 registrazione elevate, in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito.

Che cosa viene registrato nei log

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

I log solr_system contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
jsonPayload.collection string Raccolta Solr correlata al log
jsonPayload.core string Core Solr correlato al log
jsonPayload.exception string Eccezione relativa al log, inclusa l'analisi dettagliata dello stack, se fornita
jsonPayload.level string Livello voce di log
jsonPayload.message string Messaggio di log
jsonPayload.replica string Replica Solr correlata al log
jsonPayload.shard string Shard Solr correlato al log
jsonPayload.source string Origine del luogo di origine del log
jsonPayload.thread string Thread da cui ha avuto origine il log
severity stringa (LogSeverity) Livello di voce del log (tradotto).

Configurazione della raccolta di metriche

Per importare le metriche da Solr, devi creare un ricevitore per le metriche prodotto da Solr, quindi crea 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 solr, specifica i seguenti campi:

Campo Predefinito Descrizione
collection_interval 60s Un valore di durata, ad esempio 30s o 5m.
endpoint localhost:18983 L'URL del servizio JMX o l'host e la porta utilizzati per creare l'URL del servizio. Deve essere nel formato host:port. I valori nel modulo host:port verranno 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 solr.
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 dall'agente Ops dall'istanza Solr.

Tipo di metrica 
Tipo, tipo
Risorse monitorate		 Etichette
workload.googleapis.com/solr.cache.eviction.count
CUMULATIVE, INT64
gce_instance 		cache
core
workload.googleapis.com/solr.cache.hit.count
CUMULATIVE, INT64
gce_instance 		cache
core
workload.googleapis.com/solr.cache.insert.count
CUMULATIVE, INT64
gce_instance 		cache
core
workload.googleapis.com/solr.cache.lookup.count
CUMULATIVE, INT64
gce_instance 		cache
core
workload.googleapis.com/solr.cache.size
GAUGE, INT64
gce_instance 		cache
core
workload.googleapis.com/solr.document.count
GAUGE, INT64
gce_instance 		core
workload.googleapis.com/solr.index.size
GAUGE, INT64
gce_instance 		core
workload.googleapis.com/solr.request.count
CUMULATIVE, INT64
gce_instance 		core
handler
type
workload.googleapis.com/solr.request.error.count
CUMULATIVE, INT64
gce_instance 		core
handler
type
workload.googleapis.com/solr.request.time.average
GAUGE, DOUBLE
gce_instance 		core
handler
type
workload.googleapis.com/solr.request.timeout.count
CUMULATIVE, INT64
gce_instance 		core
handler
type

Verificare la configurazione

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

Per verificare che i log di Solr vengano inviati a 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("solr_system")

Per verificare che le metriche di Solr vengano inviate Cloud Monitoring, segui questi passaggi:

  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 con l'opzione 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/solr.cache.size'
| every 1m

Visualizza dashboard

Per visualizzare le metriche di Solr, devi disporre di un grafico o di una dashboard configurato. L'integrazione di Solr include una o più dashboard. 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 installato, quindi verifica che Ops Agent 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 Integrations (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 Solr 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 criteri di avviso

I criteri di avviso chiedono a Cloud Monitoring di inviarti una notifica quando si verificano condizioni specifiche. L'integrazione di Solr include uno o più criteri di avviso per 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 Integrazioni

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

  2. Individua la voce per Solr e fai clic su Visualizza dettagli.
  3. Seleziona la scheda Avvisi. Questa scheda fornisce le descrizioni criteri di avviso disponibili e fornisce un'interfaccia per l'installazione che li rappresentano.
  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. Dall'elenco dei criteri di avviso disponibili, seleziona quelli da 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 controllarne lo stato in monitoraggio, ma non ricevi 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 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, 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.