Elasticsearch è un server di ricerca open source basato sulla libreria di ricerca Lucene. Viene eseguito in una Java Virtual Machine
su vari sistemi operativi. Il ricevitore elasticsearch
raccoglie la telemetria a livello di nodo e cluster dalle tue istanze Elasticsearch.
Per ulteriori informazioni su Elasticsearch, consulta la documentazione di Elasticsearch.
Prerequisiti
Per raccogliere dati di telemetria Elasticsearch, devi installare 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 abiliti le funzionalità di sicurezza di Elasticsearch, devi configurare un utente con il privilegio monitor
o manage
.
Configura Ops Agent per Elasticsearch
Seguendo la guida per la configurazione di Ops Agent, aggiungi gli elementi richiesti per raccogliere la telemetria dalle istanze Elasticsearch e riavvia l'agente.
Configurazione di esempio
I comandi seguenti creano la configurazione per raccogliere e importare i dati di telemetria per Elasticsearch e riavviano 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 di elasticsearch_json
, specifica i seguenti campi:
Campo | Predefinita | 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 la coda 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 i seguenti campi:
Campo | Predefinita | 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 la coda 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 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 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 |
number | 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 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 | Predefinita | 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 che Ops Agent raccoglie 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. Ops Agent potrebbe impiegare uno o due minuti per iniziare a raccogliere dati di telemetria.
Per verificare che i log di Elasticsearch vengano inviati a Cloud Logging, segui questi passaggi:
-
Nella console Google Cloud, vai alla pagina Esplora log:
Se usi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Logging.
- Inserisci la seguente query nell'editor, quindi fai clic su Esegui query:
resource.type="gce_instance" (log_id("elasticsearch_json") OR log_id("elasticsearch_gc"))
Per verificare che le metriche Elasticsearch vengano inviate a Cloud Monitoring, segui questi passaggi:
-
Nella console Google Cloud, vai alla pagina leaderboard Esplora metriche:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
- Nella barra degli strumenti del riquadro di creazione di query, seleziona il pulsante con il nome code MQL o code PromQL.
- Verifica che sia selezionato MQL nell'opzione di attivazione/disattivazione Lingua. L'opzione di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti che ti consente di formattare la query.
- Inserisci la seguente query nell'editor, quindi fai clic su Esegui query:
fetch gce_instance | metric 'workload.googleapis.com/elasticsearch.node.open_files' | every 1m
Visualizza dashboard
Per visualizzare le metriche Elasticsearch, devi aver configurato un grafico o una dashboard. L'integrazione di Elasticsearch include una o più dashboard per te. Qualsiasi dashboard viene installata automaticamente dopo che hai configurato l'integrazione e 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:
-
Nella console Google Cloud, vai alla pagina Dashboard :
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
- 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 presenti 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 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 con il sottotitolo Monitoring.
- Fai clic sul filtro della 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 saperne di più sull'utilizzo della pagina Integrazioni, vedi Gestire le integrazioni.
Installa criteri di avviso
I criteri di avviso indicano a Cloud Monitoring di avvisarti quando si verificano condizioni specificate. L'integrazione di Elasticsearch include uno o più criteri di avviso da 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, segui questi passaggi:
-
Nella console Google Cloud, vai alla pagina Integrazioni:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
- Individua la voce per Elasticsearch e fai clic su Visualizza dettagli.
- Seleziona la scheda Avvisi. Questa scheda fornisce le descrizioni dei criteri di avviso disponibili e fornisce un'interfaccia per installarli.
- Installa i criteri di avviso. I criteri di avviso devono sapere dove inviare le notifiche di attivazione dell'avviso, pertanto richiedono informazioni da parte tua per l'installazione.
Per installare i criteri di avviso, segui questi passaggi:
- Dall'elenco dei criteri di avviso disponibili, seleziona quelli che vuoi installare.
Nella sezione Configura notifiche, seleziona uno o più canali di notifica. Puoi scegliere di disabilitare l'utilizzo dei canali di notifica, ma in questo caso i criteri di avviso vengono attivati automaticamente. Puoi verificarne lo stato in Monitoring, ma non riceverai notifiche.
Per maggiori informazioni sui canali di notifica, consulta la pagina relativa alla gestione dei 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, vedi 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, guarda il video Installare Ops Agent per risolvere i problemi delle applicazioni di terze parti.