Elasticsearch

Elasticsearch è un server di ricerca open source, basato sul nella libreria di ricerca di Lucene. Viene eseguito in un ambiente Java Virtuale su vari sistemi operativi. Il destinatario elasticsearch raccoglie dati di telemetria a livello di nodo e cluster dalle tue istanze Elasticsearch.

Per ulteriori informazioni su Elasticsearch, consulta Documentazione di Elasticsearch.

Prerequisiti

Per raccogliere dati di telemetria Elasticsearch, devi installa Ops Agent:

  • Per le metriche, installa la versione 2.10.0 o successive. Nella versione 2.21.0 sono state aggiunte altre metriche.
  • Per i log, installa la versione 2.9.0 o successiva.

Questa integrazione supporta Elasticsearch versione 7.9 o successive.

Configura l'istanza Elasticsearch

Se attivi Elasticsearch security funzionalità, devi configurare un utente con il cluster monitor o manage di accesso ai dati.

Configura Ops Agent per Elasticsearch

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

Configurazione di esempio

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

logging:
  receivers:
    elasticsearch_json:
      type: elasticsearch_json
    elasticsearch_gc:
      type: elasticsearch_gc
  service:
    pipelines:
      elasticsearch:
        receivers:
          - elasticsearch_json
          - elasticsearch_gc
EOF

sudo service google-cloud-ops-agent restart
sleep 60

Configura la raccolta dei log

Per importare i log da Elasticsearch, devi creare ricevitori per i log prodotto da Elasticsearch, quindi crea una pipeline per i nuovi ricevitori.

Per configurare un ricevitore per i log di elasticsearch_json, 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/log/elasticsearch/*_server.json, /var/log/elasticsearch/*_deprecation.json, /var/log/elasticsearch/*_index_search_slowlog.json, /var/log/elasticsearch/*_index_indexing_slowlog.json, /var/log/elasticsearch/*_audit.json] 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 Il valore deve essere elasticsearch_json.
wildcard_refresh_interval 60s L'intervallo di aggiornamento dei percorsi dei file con caratteri jolly in include_path. 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 elasticsearch_gc, 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/log/elasticsearch/gc.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 Il valore deve essere elasticsearch_gc.
wildcard_refresh_interval 60s L'intervallo di aggiornamento dei percorsi dei file con caratteri jolly in include_path. 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 da gli ID destinatario specificati nella configurazione. Campi dettagliati all'interno LogEntry sono i seguenti. Le voci di log non contengono campi vuoti o mancanti.

I log elasticsearch_json contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
jsonPayload.cluster string Il cluster che invia il record di log
jsonPayload.cluster.name string Il nome del cluster che invia il record di log
jsonPayload.cluster.uuid string L'UUID del cluster che invia il record di log
jsonPayload.component string Il componente di Elasticsearch che ha emesso il log
jsonPayload.level string Livello voce di log
jsonPayload.message string Messaggio di log
jsonPayload.node string Nodo che emette il record di log
jsonPayload.node.name string Il nome del nodo che emette il record di log
jsonPayload.node.uuid string L'UUID del nodo che emette il record di log
jsonPayload.type string Il tipo di log, che indica da quale log proviene il record (ad es. server indica che questa voce di log proviene dal log del server)
severity stringa (LogSeverity) Livello voce di log (tradotto)

I log elasticsearch_gc contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
jsonPayload.gc_run numero L'esecuzione del garbage collector
jsonPayload.message string Messaggio di log
jsonPayload.type string Il tipo di record di log
severity stringa (LogSeverity) Livello voce di log (tradotto)

Configurazione della raccolta di metriche

Per importare le metriche da Elasticsearch, devi creare un ricevitore per le metriche prodotto da Elasticsearch, quindi crea una pipeline per il nuovo ricevitore.

Questo ricevitore non supportare l'uso 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 distinguerli.

Per configurare un ricevitore per le metriche elasticsearch, specifica quanto segue campi:

Campo Predefinito Descrizione
ca_file Percorso del certificato CA. In qualità di client, verifica il certificato del server. Se vuoto, il destinatario utilizza la CA radice di sistema.
cert_file Percorso del certificato TLS da utilizzare per le connessioni richieste per mTLS.
collection_interval 60s Un valore di durata temporale, ad esempio 30s o 5m.
endpoint http://localhost:92002 L'URL di base dell'API REST Elasticsearch.
insecure true Consente di impostare se utilizzare o meno una connessione TLS sicura. Se impostato su false, il protocollo TLS è abilitato.
insecure_skip_verify false Consente di scegliere se saltare o meno la verifica del certificato. Se insecure viene impostato su true, il valore insecure_skip_verify non viene utilizzato.
key_file Percorso della chiave TLS da utilizzare per le connessioni richieste da mTLS.
password Password per l'autenticazione con Elasticsearch. Obbligatorio se è stato impostato il nome utente.
type Questo valore deve essere elasticsearch.
username Nome utente per l'autenticazione con Elasticsearch. Obbligatorio se è stata impostata la password.

Che cosa viene monitorato

La tabella seguente fornisce l'elenco delle metriche raccolte da Ops Agent dall'istanza Elasticsearch.

Tipo di metrica
Tipo, tipo
Risorse monitorate		 Etichette
workload.googleapis.com/elasticsearch.breaker.memory.estimated
GAUGE, INT64
gce_instance 		name
workload.googleapis.com/elasticsearch.breaker.memory.limit
GAUGE, INT64
gce_instance 		name
workload.googleapis.com/elasticsearch.breaker.tripped
CUMULATIVE, INT64
gce_instance 		name
workload.googleapis.com/elasticsearch.cluster.data_nodes
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.cluster.health
GAUGE, INT64
gce_instance 		status
workload.googleapis.com/elasticsearch.cluster.in_flight_fetch
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.cluster.nodes
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.cluster.pending_tasks
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.cluster.published_states.differences
GAUGE, INT64
gce_instance 		state
workload.googleapis.com/elasticsearch.cluster.published_states.full
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.cluster.shards
GAUGE, INT64
gce_instance 		state
workload.googleapis.com/elasticsearch.cluster.state_queue
GAUGE, INT64
gce_instance 		state
workload.googleapis.com/elasticsearch.cluster.state_update.count
CUMULATIVE, INT64
gce_instance 		state
workload.googleapis.com/elasticsearch.cluster.state_update.time
CUMULATIVE, INT64
gce_instance 		state
type
workload.googleapis.com/elasticsearch.indexing_pressure.memory.limit
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.indexing_pressure.memory.total.primary_rejections
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.indexing_pressure.memory.total.replica_rejections
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.memory.indexing_pressure
GAUGE, INT64
gce_instance 		stage
workload.googleapis.com/elasticsearch.node.cache.count
GAUGE, INT64
gce_instance 		type
workload.googleapis.com/elasticsearch.node.cache.evictions
CUMULATIVE, INT64
gce_instance 		cache_name
workload.googleapis.com/elasticsearch.node.cache.memory.usage
GAUGE, INT64
gce_instance 		cache_name
workload.googleapis.com/elasticsearch.node.cluster.connections
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.cluster.io
CUMULATIVE, INT64
gce_instance 		direction
workload.googleapis.com/elasticsearch.node.disk.io.read
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.disk.io.write
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.documents
GAUGE, INT64
gce_instance 		state
workload.googleapis.com/elasticsearch.node.fs.disk.available
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.fs.disk.free
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.fs.disk.total
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.http.connections
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.ingest.documents
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.ingest.documents.current
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.ingest.operations.failed
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.open_files
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.operations.completed
CUMULATIVE, INT64
gce_instance 		operation
workload.googleapis.com/elasticsearch.node.operations.time
CUMULATIVE, INT64
gce_instance 		operation
workload.googleapis.com/elasticsearch.node.pipeline.ingest.documents.current
GAUGE, INT64
gce_instance 		name
workload.googleapis.com/elasticsearch.node.pipeline.ingest.documents.preprocessed
GAUGE, INT64
gce_instance 		name
workload.googleapis.com/elasticsearch.node.pipeline.ingest.operations.failed
CUMULATIVE, INT64
gce_instance 		name
workload.googleapis.com/elasticsearch.node.script.cache_evictions
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.script.compilation_limit_triggered
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.script.compilations
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.shards.data_set.size
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.shards.reserved.size
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.shards.size
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.thread_pool.tasks.finished
CUMULATIVE, INT64
gce_instance 		state
thread_pool_name
workload.googleapis.com/elasticsearch.node.thread_pool.tasks.queued
GAUGE, INT64
gce_instance 		thread_pool_name
workload.googleapis.com/elasticsearch.node.thread_pool.threads
GAUGE, INT64
gce_instance 		state
thread_pool_name
workload.googleapis.com/elasticsearch.node.translog.operations
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.translog.size
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.node.translog.uncommitted.size
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.os.cpu.load_avg.15m
GAUGE, DOUBLE
gce_instance 		 
workload.googleapis.com/elasticsearch.os.cpu.load_avg.1m
GAUGE, DOUBLE
gce_instance 		 
workload.googleapis.com/elasticsearch.os.cpu.load_avg.5m
GAUGE, DOUBLE
gce_instance 		 
workload.googleapis.com/elasticsearch.os.cpu.usage
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/elasticsearch.os.memory
GAUGE, INT64
gce_instance 		state

Verificare la configurazione

In questa sezione viene descritto come verificare la corretta configurazione del Ricevitore Elasticsearch. Potrebbero essere necessari uno o due minuti prima che Ops Agent inizi a raccogliere dati di telemetria.

Per verificare che i log di Elasticsearch 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("elasticsearch_json") OR log_id("elasticsearch_gc"))

Per verificare che le metriche di Elasticsearch vengano inviate a 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 Monitoraggio.

  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/elasticsearch.node.open_files'
| every 1m

Visualizza dashboard

Per visualizzare le metriche di Elasticsearch, devi disporre di un grafico o di una dashboard configurato. L'integrazione di Elasticsearch include una o più dashboard per te. Qualsiasi dashboard viene installata automaticamente dopo integrazione e Ops Agent ha iniziato a raccogliere 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 Monitoraggio.

  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. Quando non c'è 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 per te.

Per visualizzare un'anteprima statica della dashboard:

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

    Vai a Integrazioni

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

  2. Fai clic sul filtro della piattaforma di deployment di Compute Engine.
  3. Individua la voce per Elasticsearch 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 saperne di più sulle dashboard in Cloud Monitoring, consulta Dashboard e grafici.

Per saperne di più sull'utilizzo della pagina Integrazioni, vedi Gestisci le integrazioni.

Installa criteri di avviso

I criteri di avviso indicano a Cloud Monitoring di avvisarti quando che si verifichino determinate condizioni. L'integrazione di Elasticsearch include uno o più criteri di avviso per da utilizzare. Puoi visualizzare e installare questi criteri di avviso dalla pagina Integrations (Integrazioni) in monitoraggio.

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

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

    Vai a Integrazioni

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

  2. Individua la voce per Elasticsearch 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, segui questi passaggi:
    1. Dall'elenco dei criteri di avviso disponibili, seleziona quelli da installare.

    2. Nella sezione Configura notifiche, seleziona una o più canali di notifica. Puoi scegliere di disattivare i canali di notifica, ma se lo fai, la funzione si attivano automaticamente. Puoi verificarne lo stato nella Monitoraggio, ma non riceverai notifiche.

      Per ulteriori informazioni sui canali di notifica, consulta Gestire canali di notifica.

    3. 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 Gestisci le integrazioni.

Passaggi successivi

Per una procedura dettagliata su come utilizzare Ansible per installare Ops Agent, configura un 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.