Elasticsearch è un server di ricerca open source, basato sulla libreria di ricerca Lucene. Viene eseguito in una macchina virtuale
Java su diversi sistemi operativi. Il ricevitore elasticsearch
raccoglie la telemetria a livello di nodo e cluster dalle istanze Elasticsearch.
Per ulteriori informazioni su Elasticsearch, consulta la documentazione di Elasticsearch.
Prerequisiti
Per raccogliere la telemetria di Elasticsearch, devi installare Ops Agent:
- Per le metriche, installa la versione 2.10.0 o successive. Ulteriori metriche sono state aggiunte nella versione 2.21.0.
- Per i log, installa la versione 2.9.0 o successive.
Questa integrazione supporta Elasticsearch versione 7.9 o successive.
Configura l'istanza Elasticsearch
Se abiliti le funzionalità di sicurezza di Elasticsearch, devi configurare un utente con il privilegio di cluster monitor
o manage
.
Configura Ops Agent per Elasticsearch
Segui la guida per configurare Ops Agent, aggiungi gli elementi richiesti per raccogliere i dati di telemetria dalle istanze Elasticsearch e riavvia l'agente.
Configurazione di esempio
I comandi seguenti creano la configurazione per raccogliere e importare la telemetria per Elasticsearch e riavvia Ops Agent.
Configura la raccolta dei log
Per importare i log da Elasticsearch, devi creare ricevitori per i log prodotti da Elasticsearch, quindi creare una pipeline per i nuovi ricevitori.
Per configurare un ricevitore per i log elasticsearch_json
, specifica i seguenti campi:
Campo | Predefinito | Descrizione |
---|---|---|
exclude_paths |
Un elenco di pattern di percorsi del file system da escludere dal set corrispondente da 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 mediante il tailing di ogni file. È possibile utilizzare un carattere jolly (* ) nei percorsi. |
record_log_file_path |
false |
Se il criterio è 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 con cui vengono aggiornati i percorsi dei file con caratteri jolly in include_paths. Data come durata di tempo analizzabile da time.ParseDuration , ad esempio 30s o 2m . Questa proprietà potrebbe essere utile con velocità effettiva di logging elevate, in cui i file di log vengono ruotati più velocemente rispetto all'intervallo predefinito. |
Per configurare un ricevitore per i log elasticsearch_gc
, specifica i seguenti campi:
Campo | Predefinito | Descrizione |
---|---|---|
exclude_paths |
Un elenco di pattern di percorsi del file system da escludere dal set corrispondente da include_paths . |
|
include_paths |
[/var/log/elasticsearch/gc.log] |
Un elenco di percorsi di file system da leggere mediante il tailing di ogni file. È possibile utilizzare un carattere jolly (* ) nei percorsi. |
record_log_file_path |
false |
Se il criterio è 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 con cui vengono aggiornati i percorsi dei file con caratteri jolly in include_paths. Data come durata di tempo analizzabile da time.ParseDuration , ad esempio 30s o 2m . Questa proprietà potrebbe essere utile con velocità effettiva di logging elevate, in cui i file di log vengono ruotati più velocemente rispetto all'intervallo predefinito. |
Cosa viene registrato
logName
deriva dagli ID destinatario specificati nella configurazione. Di seguito sono riportati i campi dettagliati all'interno della LogEntry
. 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 emette il record di log |
jsonPayload.cluster.uuid |
string | L'UUID del cluster che emette il record di log |
jsonPayload.component |
string | Il componente di Elasticsearch che ha emesso il log |
jsonPayload.level |
string | Livello di voce di log |
jsonPayload.message |
string | Messaggio di log |
jsonPayload.node |
string | Il 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 di voce di log (tradotto) |
I log elasticsearch_gc
contengono i seguenti campi in LogEntry
:
Campo | Tipo | Descrizione |
---|---|---|
jsonPayload.gc_run |
number | L'esecuzione di garbage collector |
jsonPayload.message |
string | Messaggio di log |
jsonPayload.type |
string | Il tipo di record di log |
severity |
stringa (LogSeverity ) |
Livello di voce di log (tradotto) |
Configurazione della raccolta di metriche
Per importare le metriche da Elasticsearch, devi creare un ricevitore per le metriche prodotte da Elasticsearch 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 elasticsearch
, specifica i seguenti campi:
Campo | Predefinito | Descrizione |
---|---|---|
ca_file |
Percorso del certificato CA. In qualità di client, questa operazione 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 da mTLS. | |
collection_interval |
60s |
Un valore di durata del tempo, ad esempio 30s o 5m . |
endpoint |
http://localhost:92002 |
L'URL di base per l'API REST Elasticsearch. |
insecure |
true |
Consente di specificare se utilizzare o meno una connessione TLS sicura. Se il criterio viene impostato su false , il protocollo TLS è abilitato. |
insecure_skip_verify |
false |
Consente di scegliere se saltare o meno la verifica del certificato. Se insecure è 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 è impostato un nome utente. | |
type |
Questo valore deve essere elasticsearch. | |
username |
Nome utente per l'autenticazione con Elasticsearch. Obbligatorio se è stata impostata una 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
Questa sezione descrive come verificare di aver configurato correttamente il ricevitore Elasticsearch. Ops Agent potrebbe impiegare uno o due minuti per iniziare a raccogliere i dati di telemetria.
Per verificare che i log di ElasticSearch vengano inviati a Cloud Logging, segui questi passaggi:
-
Nel pannello di navigazione della console Google Cloud, seleziona Logging, quindi Esplora log:
- Inserisci la seguente query nell'editor e 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:
-
Nella console Google Cloud, vai alla pagina Metrics Explorer leaderboard:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato il cui sottotitolo è Monitoring.
- Nella barra degli strumenti del riquadro del generatore di query, seleziona il pulsante il cui nome è code MQL o code PromQL.
- 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 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/elasticsearch.node.open_files' | every 1m
Visualizza dashboard
Per visualizzare le metriche di Elasticsearch, devi aver configurato un grafico o una dashboard. L'integrazione di Elasticsearch include una o più dashboard per te. Tutte 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, segui questi passaggi:
-
Nella console Google Cloud, vai alla pagina Dashboard:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato il cui sottotitolo è Monitoring.
- Seleziona la scheda Elenco dashboard, quindi scegli la categoria Integrazioni.
- Fai clic sul nome della dashboard da visualizzare.
Se hai configurato un'integrazione, ma la dashboard non è stata installata, verifica che Ops Agent sia in esecuzione. Se nella dashboard non sono disponibili dati delle metriche per un grafico, l'installazione della dashboard non riesce. Dopo che Ops Agent ha iniziato 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 il cui sottotitolo è Monitoring.
- Fai clic sul filtro piattaforma di deployment di Compute Engine.
- Individua la voce per Elasticsearch 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 ulteriori informazioni 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 Elasticsearch 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:
-
Nella console Google Cloud, vai alla pagina Integrazioni:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato il cui sottotitolo è Monitoring.
- Individua la voce per Elasticsearch 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 le notifiche relative all'attivazione dell'avviso, per cui 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. Puoi disattivare l'utilizzo dei canali di notifica. Tuttavia, in questo caso i criteri di avviso si attivano in modo invisibile. Puoi verificarne lo stato in Monitoring, ma non ricevi notifiche.
Per maggiori informazioni sui canali di notifica, consulta la pagina 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 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, configurare un'applicazione di terze parti e installare una dashboard di esempio, consulta il video Installare Ops Agent per la risoluzione dei problemi delle applicazioni di terze parti.