Apache Flink

L'integrazione di Apache Flink raccoglie i log di client, jobmanager e taskmanager e le analizza in un payload JSON. Il risultato include i campi per source, livello e messaggio.

Per ulteriori informazioni su Flink, consulta la documentazione di Apache Flink.

Prerequisiti

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

  • Per le metriche, installa la versione 2.18.1 o successive.
  • Per i log, installa la versione 2.17.0 o successiva.

Questa integrazione supporta le versioni di Flink 1.12.5, 1.13.6 e 1.14.4.

Configurare Ops Agent per Flink

Segui la guida per configurare Ops Agent, aggiungi gli elementi necessari per raccogliere la telemetria dalle istanze Flink e riavvia l'agente.

Configurazione di esempio

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

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

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

Per configurare un destinatario per i log flink, 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 [/opt/flink/log/flink-*-standalonesession-*.log, /opt/flink/log/flink-*-taskexecutor-*.log, /opt/flink/log/flink-*-client-*.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 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 flink.
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 logging 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 flink contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
jsonPayload.level string Livello voce di log
jsonPayload.message string Messaggio di log, inclusa l'analisi dettagliata dello stack, se fornita
jsonPayload.source string La classe Java di origine della voce di log
severity stringa (LogSeverity) Livello di voce del log (tradotto).

Per importare le metriche da Flink, devi creare un ricevitore per le metriche prodotto da Flink, 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 ricevitore per le metriche flink, specifica quanto segue campi:

Campo Predefinito Descrizione
collection_interval 60s Un valore di durata, ad esempio 30s o 5m.
endpoint http://localhost:8081 L'URL esposto da Flink.
type Questo valore deve essere flink.

Che cosa viene monitorato

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

Tipo di metrica
Tipo, Tipo
Risorse monitorate		 Etichette
workload.googleapis.com/flink.job.checkpoint.count
CUMULATIVE, INT64
gce_instance 		checkpoint
host_name
job_name
workload.googleapis.com/flink.job.checkpoint.in_progress
GAUGE, INT64
gce_instance 		host_name
job_name
workload.googleapis.com/flink.job.last_checkpoint.size
GAUGE, INT64
gce_instance 		host_name
job_name
workload.googleapis.com/flink.job.last_checkpoint.time
GAUGE, INT64
gce_instance 		host_name
job_name
workload.googleapis.com/flink.job.restart.count
CUMULATIVE, INT64
gce_instance 		host_name
job_name
workload.googleapis.com/flink.jvm.class_loader.classes_loaded
CUMULATIVE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.cpu.load
GAUGE, DOUBLE
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.cpu.time
CUMULATIVE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.gc.collections.count
CUMULATIVE, INT64
gce_instance 		garbage_collector_name
host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.gc.collections.time
CUMULATIVE, INT64
gce_instance 		garbage_collector_name
host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.memory.direct.total_capacity
GAUGE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.memory.direct.used
GAUGE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.memory.heap.committed
GAUGE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.memory.heap.max
GAUGE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.memory.heap.used
GAUGE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.memory.mapped.total_capacity
GAUGE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.memory.mapped.used
GAUGE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.memory.metaspace.committed
GAUGE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.memory.metaspace.max
GAUGE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.memory.metaspace.used
GAUGE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.memory.nonheap.committed
GAUGE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.memory.nonheap.max
GAUGE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.memory.nonheap.used
GAUGE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.jvm.threads.count
GAUGE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.memory.managed.total
GAUGE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.memory.managed.used
GAUGE, INT64
gce_instance 		host_name
resource_type
taskmanager_id
workload.googleapis.com/flink.operator.record.count
CUMULATIVE, INT64
gce_instance 		host_name
job_name
operator_name
record
subtask_index
task_name
taskmanager_id
workload.googleapis.com/flink.operator.watermark.output
GAUGE, INT64
gce_instance 		host_name
job_name
operator_name
subtask_index
task_name
taskmanager_id
workload.googleapis.com/flink.task.record.count
CUMULATIVE, INT64
gce_instance 		host_name
job_name
record
subtask_index
task_name
taskmanager_id

Verificare la configurazione

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

Per verificare che i log di Flink 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("flink")

Per verificare che le metriche Flink 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 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 che 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/flink.jvm.memory.heap.used'
| every 1m

Visualizza dashboard

Per visualizzare le metriche di Flink, devi disporre di un grafico o di una dashboard configurato. L'integrazione di Flink 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 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 installata, controlla che l'agente operativo sia in esecuzione. Se non sono disponibili dati metrici per un grafico nella dashboard, l'installazione della dashboard non va a buon fine. 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 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 Compute Engine.
  3. Individua la voce relativa a Flink e fai clic su Visualizza dettagli.
  4. Seleziona la scheda Dashboard per visualizzare un'anteprima statica. Se la dashboard è installata, puoi accedervi facendo clic su Visualizza dashboard.

Per saperne di più 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 Flink include uno o più criteri di avviso 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 installarli:

  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 relativa a Flink 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 devono sapere dove inviare le notifiche che indicano che l'avviso è stato attivato, quindi richiedono informazioni da te 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 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 ulteriori informazioni sui canali di notifica, consulta Gestisci canali di notifica.

    3. Fai clic su Crea criteri.

Per ulteriori informazioni sui criteri di avviso in Cloud Monitoring, vedi 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 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.