Configurazione dell'agente operativo

Questo documento fornisce dettagli sulle configurazioni predefinite e personalizzate di Ops Agent. Leggi questo documento se una delle seguenti condizioni si applica a te:

Modello di configurazione

Ops Agent utilizza una configurazione predefinita integrata; non puoi modificarla direttamente. Devi invece creare un file di sostituzioni che vengono unite alla configurazione integrata al riavvio dell'agente.

I componenti di base della configurazione sono i seguenti:

  • receivers: questo elemento descrive ciò che viene raccolto dall'agente.
  • processors: questo elemento descrive in che modo l'agente può modificare le informazioni raccolte.
  • service: questo elemento collega i ricevitori e gli elaboratori per creareflussi di dati, chiamati pipeline. L'elemento service contiene un elemento pipelines, che può contenere più pipeline.

La configurazione integrata è composta da questi elementi e utilizzi gli stessi elementi per sostituirla.

Configurazione integrata

La configurazione integrata per Ops Agent definisce la raccolta predefinita per i log e le metriche. Di seguito è riportata la configurazione integrata per Linux e Windows:

Linux

Per impostazione predefinita, Ops Agent raccoglie i log syslog basati su file e le metriche dell'host.

Per ulteriori informazioni sulle metriche raccolte, consulta Metriche importate dai destinatari.

logging:
  receivers:
    syslog:
      type: files
      include_paths:
      - /var/log/messages
      - /var/log/syslog
  service:
    pipelines:
      default_pipeline:
        receivers: [syslog]
metrics:
  receivers:
    hostmetrics:
      type: hostmetrics
      collection_interval: 60s
  processors:
    metrics_filter:
      type: exclude_metrics
      metrics_pattern: []
  service:
    pipelines:
      default_pipeline:
        receivers: [hostmetrics]
        processors: [metrics_filter]

Windows

Per impostazione predefinita, Ops Agent raccoglie i log eventi di Windows dai canali System, Application e Security, nonché le metriche dell'host, le metriche IIS e le metriche di SQL Server.

Per ulteriori informazioni sulle metriche raccolte, consulta Metriche importate dai destinatari.

logging:
  receivers:
    windows_event_log:
      type: windows_event_log
      channels: [System, Application, Security]
  service:
    pipelines:
      default_pipeline:
        receivers: [windows_event_log]
metrics:
  receivers:
    hostmetrics:
      type: hostmetrics
      collection_interval: 60s
    iis:
      type: iis
      collection_interval: 60s
    mssql:
      type: mssql
      collection_interval: 60s
  processors:
    metrics_filter:
      type: exclude_metrics
      metrics_pattern: []
  service:
    pipelines:
      default_pipeline:
        receivers: [hostmetrics, iis, mssql]
        processors: [metrics_filter]

Queste configurazioni sono descritte più dettagliatamente in Configurazione del logging e Configurazione delle metriche.

Configurazione specificata dall'utente

Per eseguire l'override della configurazione integrata, devi aggiungere nuovi elementi di configurazione al file di configurazione utente. Inserisci la configurazione per l'Ops Agent nei seguenti file:

  • Per Linux: /etc/google-cloud-ops-agent/config.yaml
  • Per Windows: C:\Program Files\Google\Cloud Operations\Ops Agent\config\config.yaml

Qualsiasi configurazione specificata dall'utente viene unita alla configurazione integrata al riavvio dell'agente.

Per eseguire l'override di un destinatario, un elaboratore o una pipeline integrati, ridefiniscili nel file config.yaml dichiarandoli con lo stesso identificatore. A partire dalla versione 2.31.0 di Ops Agent, puoi anche configurare la funzionalità di rotazione dei log dell'agente. Per ulteriori informazioni, consulta Configurare la rotazione dei log in Ops Agent.

Ad esempio, la configurazione integrata per le metriche include un hostmetrics ricevitore che specifica un intervallo di raccolta di 60 secondi. Per impostare l'intervallo di raccolta delle metriche dell'host su 30 secondi, includi un ricevitore delle metriche chiamato hostmetrics nel file config.yaml che imposta il valore collection_interval su 30 secondi, come mostrato nell'esempio seguente:

metrics:
  receivers:
    hostmetrics:
      type: hostmetrics
      collection_interval: 30s

Per altri esempi di modifica delle configurazioni integrate, consulta Configurazione della registrazione e Configurazione delle metriche. Puoi anche disattivare la raccolta dei dati di log o delle metriche. Queste modifiche sono descritte negli esempi di configurazioni service per il logging e le configurazioni service per le metriche.

Puoi utilizzare questo file per impedire all'agente di raccogliere i log di autoanalisi e di inviarli a Cloud Logging. Per ulteriori informazioni, consulta la pagina relativa alla raccolta dei log di autoanalisi.

Utilizzando questo file, puoi anche configurare la funzionalità di rotazione dei log dell'agente. Per ulteriori informazioni, consulta Configurare la rotazione dei log in Ops Agent.

Non puoi configurare Ops Agent per esportare log o metriche in servizi diversi da Cloud Logging e Cloud Monitoring.

Configurazioni di logging

La configurazione logging utilizza il modello di configurazione descritto in precedenza:

  • receivers: questo elemento descrive i dati da raccogliere dai file di log. Questi dati vengono mappati in un modello <timestamp, record>.
  • processors: questo elemento facoltativo descrive in che modo l'agente può modificare le informazioni raccolte.
  • service: questo elemento collega i ricevitori e gli elaboratori per creareflussi di dati, chiamati pipeline. L'elemento service contiene un elemento pipelines, che può includere più definizioni di pipeline.

Ogni ricevitore e ogni elaboratore può essere utilizzato in più pipeline.

Le sezioni seguenti descrivono ciascuno di questi elementi.

Ops Agent invia i log a Cloud Logging. Non puoi configurarlo per esportare i log in altri servizi. Tuttavia, puoi configurare Cloud Logging per esportare i log. Per ulteriori informazioni, vedi Indirizzare i log alle destinazioni supportate.

Ricevitori di log

L'elemento receivers contiene un insieme di destinatari, ciascuno identificato da un RECEIVER_ID. Un destinatario descrive come recuperare i log, ad esempio tramite il monitoraggio dei file, l'utilizzo di una porta TCP o dal log eventi di Windows.

Struttura dei ricevitori di log

Ogni destinatario deve avere un identificatore, RECEIVER_ID, e includere un elemento type. I tipi validi sono:

  • files: raccogli i log monitorando i file sul disco.
  • fluent_forward (versioni di Ops Agent 2.12.0 e successive): raccoglie i log inviati tramite il protocollo Fluent Forward su TCP.
  • tcp (versioni di Ops Agent 2.3.0 e successive): collecting logs in JSON format by listening to a TCP port.
  • Solo su Linux:
    • syslog: raccogli i messaggi Syslog tramite TCP o UDP.
    • systemd_journald (versioni di Ops Agent 2.4.0 e successive): raccogli i log del diario systemd dal servizio systemd-journald.
  • Solo Windows:
    • windows_event_log: raccogli i log eventi di Windows utilizzando l'API Log eventi di Windows.
  • Applicazioni di terze parti per la ricezione dei log

La struttura receivers ha il seguente aspetto:

receivers:
  RECEIVER_ID:
    type: files
    ...
  RECEIVER_ID_2:
    type: syslog
    ...

A seconda del valore dell'elemento type, potrebbero essere disponibili altre opzioni di configurazione, come segue:

  • files ricevitori:

    • include_paths: obbligatorio. Un elenco di percorsi del file system da leggere tramite il tailing di ciascun file. Nei percorsi è possibile utilizzare un carattere jolly (*), ad esempio /var/log/*.log (Linux) o C:\logs\*.log (Windows).

      Per un elenco dei file di log delle applicazioni Linux più comuni, consulta File di log di Linux comuni.

    • exclude_paths: facoltativo. Un elenco di pattern di percorsi del file system da escludere dall'insieme corrispondente a include_paths.

    • record_log_file_path: facoltativo. Se impostato su true, il percorso del file specifico da cui è stato ottenuto il record del 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.

    • wildcard_refresh_interval: facoltativo. L'intervallo di aggiornamento dei percorsi dei file con caratteri jolly in include_paths. Specificato come durata, ad esempio 30s, 2m. Questa proprietà può essere utile in caso di throughput elevato dei log, in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito. Se non specificato, l'intervallo predefinito è 60 secondi.

  • fluent_forward ricevitori:

    • listen_host: facoltativo. Un indirizzo IP su cui ascoltare. Il valore predefinito è 127.0.0.1.

    • listen_port: facoltativo. Una porta su cui ascoltare. Il valore predefinito è 24224.

  • Ricevitori syslog (solo per Linux):

    • transport_protocol: valori supportati: tcp, udp.

    • listen_host: un indirizzo IP su cui ascoltare.

    • listen_port: una porta su cui ascoltare.

  • tcp ricevitori:

    • format: obbligatorio. Formato dei log. Valore supportato: json.

    • listen_host: facoltativo. Un indirizzo IP su cui ascoltare. Il valore predefinito è 127.0.0.1.

    • listen_port: facoltativo. Una porta su cui ascoltare. Il valore predefinito è 5170.

  • windows_event_log ricevitori (solo per Windows):

    • channels: obbligatorio. Un elenco di canali del log eventi di Windows da cui leggere i log.

    • receiver_version: facoltativo. Controlla quale API di log eventi di Windows utilizzare. I valori supportati sono 1 e 2. Il valore predefinito è 1.

    • render_as_xml: facoltativo. Se impostato su true, tutti i campi del log eventi, tranne jsonPayload.Message e jsonPayload.StringInserts, vengono visualizzati come documento XML in un campo di stringa denominato jsonPayload.raw_xml. Il valore predefinito è false. Non può essere impostato su true se receiver_version è 1.

Esempi di ricevitori di log

Esempio di ricevitore files:

receivers:
  RECEIVER_ID:
    type: files

    include_paths: [/var/log/*.log]
    exclude_paths: [/var/log/not-this-one.log]
    record_log_file_path: true

Esempio di ricevitore fluent_forward:

receivers:
  RECEIVER_ID:
    type: fluent_forward

    listen_host: 127.0.0.1
    listen_port: 24224

Ricevitore syslog di esempio (solo Linux):

receivers:
  RECEIVER_ID:
    type: syslog

    transport_protocol: tcp
    listen_host: 0.0.0.0
    listen_port: 5140

Esempio di ricevitore tcp:

receivers:
  RECEIVER_ID:
    type: tcp

    format: json
    listen_host: 127.0.0.1
    listen_port: 5170

Ricevitore windows_event_log di esempio (solo Windows):

receivers:
  RECEIVER_ID:
    type: windows_event_log

    channels: [System,Application,Security]

Esempio di ricevitore windows_event_log che sostituisce il ricevitore integrato per utilizzare la versione 2:

receivers:
  windows_event_log:
    type: windows_event_log

    channels: [System,Application,Security]
    receiver_version: 2

Esempio di ricevitore systemd_journald:

receivers:
  RECEIVER_ID:
    type: systemd_journald

Campi speciali nei payload strutturati

Per i processori e i ricevitori che possono importare dati strutturati (i ricevitori fluent_forward e tcp e il processore parse_json), puoi impostare campi speciali nell'input che verranno mappati a campi specifici nell'oggetto LogEntry scritto dall'agente nell'API Logging.

Quando Ops Agent riceve dati di log strutturati esterni, inserisce i campi di primo livello nel campo jsonPayload di LogEntry, a meno che il nome del campo non sia elencato nella tabella seguente:

Campo record Campo LogEntry

Opzione 1


"timestamp": {
  "seconds": CURRENT_SECONDS,
  "nanos": CURRENT_NANOS,
}

Opzione 2


{
  "timestampSeconds": CURRENT_SECONDS,
  "timestampNanos": CURRENT_NANOS,
}
 		timestamp
receiver_id (non è un campo del record) logName
logging.googleapis.com/httpRequest (HttpRequest) httpRequest
logging.googleapis.com/severity (stringa) severity
logging.googleapis.com/labels (struct of string:string) labels
logging.googleapis.com/operation (struct) operation
logging.googleapis.com/sourceLocation (struct) sourceLocation
logging.googleapis.com/trace (stringa) trace
logging.googleapis.com/spanId (stringa) spanId

Gli eventuali campi dei record strutturati rimanenti fanno ancora parte della jsonPayload struttura.

File di log di Linux comuni

La tabella seguente elenca i file di log comuni per le applicazioni Linux più utilizzate:

Applicazione File di log comuni
apache Per informazioni sui file di log di Apache, consulta Monitoraggio delle applicazioni di terze parti: server web Apache.
cassandra Per informazioni sui file di log di Cassandra, consulta Monitoraggio delle applicazioni di terze parti: Cassandra.
chef /var/log/chef-server/bookshelf/current
/var/log/chef-server/chef-expander/current
/var/log/chef-server/chef-pedant/http-traffic.log
/var/log/chef-server/chef-server-webui/current
/var/log/chef-server/chef-solr/current
/var/log/chef-server/erchef/current
/var/log/chef-server/erchef/erchef.log.1
/var/log/chef-server/nginx/access.log
/var/log/chef-server/nginx/error.log
/var/log/chef-server/nginx/rewrite-port-80.log
/var/log/chef-server/postgresql/current
gitlab /home/git/gitlab/log/application.log
/home/git/gitlab/log/githost.log
/home/git/gitlab/log/production.log
/home/git/gitlab/log/satellites.log
/home/git/gitlab/log/sidekiq.log
/home/git/gitlab/log/unicorn.stderr.log
/home/git/gitlab/log/unicorn.stdout.log
/home/git/gitlab-shell/gitlab-shell.log
jenkins /var/log/jenkins/jenkins.log
jetty /var/log/jetty/out.log
/var/log/jetty/*.request.log
/var/log/jetty/*.stderrout.log
joomla /var/www/joomla/logs/*.log
magento /var/www/magento/var/log/exception.log
/var/www/magento/var/log/system.log
/var/www/magento/var/report/*
mediawiki /var/log/mediawiki/*.log
memcached Per informazioni sui file di log di Memcached, consulta Monitoraggio delle applicazioni di terze parti: Memcached.
mongodb Per informazioni sui file di log di MongoDB, consulta Monitoraggio delle applicazioni di terze parti: MongoDB.
mysql Per informazioni sui file di log di MySQL, consulta Monitoraggio delle applicazioni di terze parti: MySQL.
nginx Per informazioni sui file di log di nginx, consulta Monitoraggio delle applicazioni di terze parti: nginx.
postgres Per informazioni sui file di log di PostgreSQL, consulta Monitoraggio di applicazioni di terze parti: PostgreSQL.
burattino /var/log/puppet/http.log
/var/log/puppet/masterhttp.log
puppet-enterprise /var/log/pe-activemq/activemq.log
/var/log/pe-activemq/wrapper.log
/var/log/pe-console-auth/auth.log
/var/log/pe-console-auth/cas_client.log
/var/log/pe-console-auth/cas.log
/var/log/pe-httpd/access.log
/var/log/pe-httpd/error.log
/var/log/pe-httpd/other_vhosts_access.log
/var/log/pe-httpd/puppetdashboard.access.log
/var/log/pe-httpd/puppetdashboard.error.log
/var/log/pe-httpd/puppetmasteraccess.log
/var/log/pe-mcollective/mcollective_audit.log
/var/log/pe-mcollective/mcollective.log
/var/log/pe-puppet-dashboard/certificate_manager.log
/var/log/pe-puppet-dashboard/event-inspector.log
/var/log/pe-puppet-dashboard/failed_reports.log
/var/log/pe-puppet-dashboard/live-management.log
/var/log/pe-puppet-dashboard/mcollective_client.log
/var/log/pe-puppet-dashboard/production.log
/var/log/pe-puppetdb/pe-puppetdb.log
/var/log/pe-puppet/masterhttp.log
/var/log/pe-puppet/rails.log
rabbitmq Per informazioni sui file di log di RabbitMQ, consulta Monitoraggio delle applicazioni di terze parti: RabbitMQ.
redis Per informazioni sui file di log di Redis, consulta Monitoraggio delle applicazioni di terze parti: Redis.
redmine /var/log/redmine/*.log
sale /var/log/salt/key
/var/log/salt/master
/var/log/salt/minion
/var/log/salt/syndic.loc
solr Per informazioni sui file di log di Apache Solr, consulta Monitoraggio delle applicazioni di terze parti: Apache Solr.
sugarcrm /var/www/*/sugarcrm.log
syslog /var/log/syslog
/var/log/messages
tomcat Per informazioni sui file di log di Apache Tomcat, consulta Monitoraggio delle applicazioni di terze parti: Apache Tomcat.
zookeeper Per informazioni sui file di log di Apache ZooKeeper, consulta Monitoraggio delle applicazioni di terze parti: Apache ZooKeeper.

Etichette importate predefinite

Per impostazione predefinita, i log possono contenere le seguenti etichette in LogEntry:

Campo Valore di esempio Descrizione
labels."compute.googleapis.com/resource_name" test_vm Il nome della macchina virtuale da cui ha avuto origine questo log. Scritto per tutti i log.
labels."logging.googleapis.com/instrumentation_source" agent.googleapis.com/apache_access Il valore del destinatario type da cui ha origine il log, preceduto da agent.googleapis.com/. Scritto solo dai destinatari delle integrazioni di terze parti.

Processori di logging

L'elemento facoltativo processors contiene un insieme di istruzioni di elaborazione, ciascuna identificata da un PROCESSOR_ID. Un elaboratore descrive come manipolare le informazioni raccolte da un destinatario.

Ogni elaboratore deve avere un identificatore univoco e includere un elemento type. I tipi validi sono:

  • parse_json: analizza i log strutturati in formato JSON.
  • parse_multiline: analizza i log su più righe. (solo Linux)
  • parse_regex: analizza i log in formato testo tramite pattern regex per trasformarli in log strutturati in formato JSON.
  • exclude_logs: escludi i log che corrispondono alle regole specificate (a partire dalla versione 2.9.0).
  • modify_fields: imposta/trasforma i campi nelle voci di log (a partire dalla versione 2.14.0).

La struttura processors ha il seguente aspetto:

processors:
  PROCESSOR_ID:
    type: parse_json
    ...
  PROCESSOR_ID_2:
    type: parse_regex
    ...

A seconda del valore dell'elemento type, sono disponibili altre opzioni di configurazione, come segue.

Processore parse_json

Struttura di configurazione

processors:
  PROCESSOR_ID:
    type: parse_json

    time_key:    <field name within jsonPayload>
    time_format: <strptime format string>

Il processore parse_json analizza il JSON di input nel campo jsonPayload del LogEntry. Altre parti del LogEntry possono essere analizzate impostando alcuni campi di primo livello speciali.

  • time_key: facoltativo. Se la voce di log fornisce un campo con un timestamp, questa opzione specifica il nome del campo. Il valore estratto viene utilizzato per impostare il campo timestamp del LogEntry risultante e viene rimosso dal payload.

    Se viene specificata l'opzione time_key, devi specificare anche quanto segue:

    • time_format: obbligatorio se viene utilizzato time_key. Questa opzione specifica il formato del campo time_key in modo che possa essere riconosciuto e analizzato correttamente. Per informazioni dettagliate sul formato, consulta la guida di strptime(3).
Configurazione di esempio
processors:
  PROCESSOR_ID:
    type: parse_json

    time_key:    time
    time_format: "%Y-%m-%dT%H:%M:%S.%L%Z"

Processore parse_multiline

Struttura di configurazione

processors:
  PROCESSOR_ID:
    type: parse_multiline

    match_any:
    - type: <type of the exceptions>
      language: <language name>

  • match_any: obbligatorio. Un elenco di una o più regole.

    • type: obbligatorio. È supportato un solo valore:

      • language_exceptions: consente al processore di concatenare le eccezioni in un unico LogEntry, in base al valore dell'opzione language.

    • language: obbligatorio. È supportato un solo valore:

      • java: concatena le eccezioni Java comuni in un'unica LogEntry.
      • python: concatena le eccezioni Python comuni in un'unica LogEntry.
      • go: concatena le eccezioni Go comuni in un'unica LogEntry.
Configurazione di esempio
logging:
  receivers:
    custom_file1:
      type: files
      include_paths:
      - /tmp/test-multiline28
  processors:
    parse_java_multiline:
      type: parse_multiline
      match_any:
      - type: language_exceptions
        language: java
    extract_structure:
      type: parse_regex
      field: message
      regex: "^(?<time>[\d-]*T[\d:.Z]*) (?<severity>[^ ]*) (?<file>[^ :]*):(?<line>[\d]*) - (?<message>(.|\\n)*)$"
      time_key: time
      time_format: "%Y-%m-%dT%H:%M:%S.%L"
    move_severity:
      type: modify_fields
      fields:
        severity:
          move_from: jsonPayload.severity
  service:
    pipelines:
      pipeline1:
        receivers: [custom_file1]
        processors: [parse_java_multiline, extract_structure, move_severity]

Se utilizzi la configurazione precedente e hai un file di log con i seguenti contenuti:

2022-10-17T22:00:00.187512963Z ERROR HelloWorld:16 - javax.servlet.ServletException: Something bad happened
    at com.example.myproject.OpenSessionInViewFilter.doFilter(OpenSessionInViewFilter.java:60)
    at org.mortbay.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1157)
    at com.example.myproject.ExceptionHandlerFilter.doFilter(ExceptionHandlerFilter.java:28)
    at org.mortbay.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1157)
    at com.example.myproject.OutputBufferFilter.doFilter(OutputBufferFilter.java:33)
Caused by: com.example.myproject.MyProjectServletException
    at com.example.myproject.MyServlet.doPost(MyServlet.java:169)
    at javax.servlet.http.HttpServlet.service(HttpServlet.java:727)
    at javax.servlet.http.HttpServlet.service(HttpServlet.java:820)
    at org.mortbay.jetty.servlet.ServletHolder.handle(ServletHolder.java:511)
    at org.mortbay.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1166)
    at com.example.myproject.OpenSessionInViewFilter.doFilter(OpenSessionInViewFilter.java:30)
    ... 27 common frames omitted

L'agente importa i log in Cloud Logging nel seguente formato:

{
  "insertId": "...",
  "jsonPayload": {
    "line": "16",
    "message": "javax.servlet.ServletException: Something bad happened\n    at com.example.myproject.OpenSessionInViewFilter.doFilter(OpenSessionInViewFilter.java:60)\n    at org.mortbay.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1157)\n    at com.example.myproject.ExceptionHandlerFilter.doFilter(ExceptionHandlerFilter.java:28)\n    at org.mortbay.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1157)\n    at com.example.myproject.OutputBufferFilter.doFilter(OutputBufferFilter.java:33)\nCaused by: com.example.myproject.MyProjectServletException\n    at com.example.myproject.MyServlet.doPost(MyServlet.java:169)\n    at javax.servlet.http.HttpServlet.service(HttpServlet.java:727)\n    at javax.servlet.http.HttpServlet.service(HttpServlet.java:820)\n    at org.mortbay.jetty.servlet.ServletHolder.handle(ServletHolder.java:511)\n    at org.mortbay.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1166)\n    at com.example.myproject.OpenSessionInViewFilter.doFilter(OpenSessionInViewFilter.java:30)\n    ... 27 common frames omitted\n",
    "file": "HelloWorld"
  },
  "resource": {
    "type": "gce_instance",
    "labels": {
      "instance_id": "...",
      "project_id": "...",
      "zone": "..."
    }
  },
  "timestamp": "2022-10-17T22:00:00.187512963Z",
  "severity": "ERROR",
  "labels": {
    "compute.googleapis.com/resource_name": "..."
  },
  "logName": "projects/.../logs/custom_file",
  "receiveTimestamp": "2022-10-18T03:12:38.430364391Z"
}

Processore parse_regex

Struttura di configurazione

processors:
  PROCESSOR_ID:
    type: parse_regex

    regex: <regular expression>

    time_key:    <field name within jsonPayload>
    time_format: <format string>

  • time_key: facoltativo. Se la voce di log fornisce un campo con un timestamp, questa opzione specifica il nome del campo. Il valore estratto viene utilizzato per impostare il campo timestamp del LogEntry risultante e viene rimosso dal payload.

    Se viene specificata l'opzione time_key, devi specificare anche quanto segue:

    • time_format: obbligatorio se viene utilizzato time_key. Questa opzione specifica il formato del campo time_key in modo che possa essere riconosciuto e analizzato correttamente. Per informazioni dettagliate sul formato, consulta la guida di strptime(3).

  • regex: obbligatorio. L'espressione regolare per l'analisi del campo. L'espressione deve includere i nomi delle chiavi per le sottoespressioni corrispondenti, ad esempio "^(?<time>[^ ]*) (?<severity>[^ ]*) (?<msg>.*)$".

    Il testo corrispondente ai gruppi di cattura denominati verrà inserito nei campi del campo jsonPayload di LogEntry. Per aggiungere ulteriore struttura ai log, utilizza il processore modify_fields.

    Per un insieme di espressioni regolari per l'estrazione di informazioni dai file di log delle applicazioni Linux comuni, vedi File di log Linux comuni.

Configurazione di esempio
processors:
  PROCESSOR_ID:
    type: parse_regex

    regex:       "^(?<time>[^ ]*) (?<severity>[^ ]*) (?<msg>.*)$"
    time_key:    time
    time_format: "%Y-%m-%dT%H:%M:%S.%L%Z"

Processore exclude_logs

Struttura di configurazione:

type: exclude_logs
match_any:
  - <filter>
  - <filter>

La configurazione di primo livello per questo elaboratore contiene un singolo campo, match_any, che contiene un elenco di regole di filtro.

  • match_any: obbligatorio. Un elenco di una o più regole. Se una voce di log corrisponde a una regola, Ops Agent non la importa.

    I log importati da Ops Agent seguono la struttura LogEntry. I nomi dei campi sono sensibili alle maiuscole. Puoi specificare regole solo in base ai seguenti campi e ai relativi sottocampi:

    • httpRequest
    • jsonPayload
    • labels
    • operation
    • severity
    • sourceLocation
    • trace
    • spanId

    La seguente regola di esempio

    severity =~ "(DEBUG|INFO)"

    utilizza un'espressione regolare per escludere tutti i log di livello DEBUG e INFO.

    Le regole rispettano la sintassi del linguaggio di query di Cloud Logging, ma supportano solo un sottoinsieme delle funzionalità supportate dal linguaggio di query di Logging:

    • Operatori di confronto: =, !=, :, =~, !~. Sono supportati solo i confronti di stringhe.
    • Operatore di navigazione: .. Ad esempio jsonPayload.message.
    • Operatori booleani: AND, OR, NOT.
    • Raggruppamento di espressioni con ( ).

Configurazione di esempio

processors:
  PROCESSOR_ID:
    type: exclude_logs
    match_any:
    - '(jsonPayload.message =~ "log spam 1" OR jsonPayload.message =~ "log spam 2") AND severity = "ERROR"'
    - 'jsonPayload.application = "foo" AND severity = "INFO"'

modify_fields Processore

Il processore modify_fields consente di personalizzare la struttura e i contenuti delle voci di log.

Struttura di configurazione

type: modify_fields
fields:
  <destination field>:
    # Source
    move_from: <source field>
    copy_from: <source field>
    static_value: <string>
    
    # Mutation
    default_value: <string>
    map_values:
      <old value>: <new value>
    type: {integer|float}
    omit_if: <filter>

La configurazione di primo livello per questo elaboratore contiene un singolo campo, fields, che contiene una mappa dei nomi dei campi di output e delle traduzioni corrispondenti. Per ogni campo di output, viene applicata un'origine facoltativa e zero o più operazioni di mutazione.

Tutti i nomi di campo utilizzano la sintassi separata da punti del linguaggio di query di Cloud Logging. I filtri utilizzano il linguaggio di query di Cloud Logging.

Tutte le trasformazioni vengono applicate in parallelo, il che significa che le origini e i filtri agiscono sulla voce di log di input originale e pertanto non possono fare riferimento al nuovo valore di altri campi modificati dallo stesso elaboratore.

Opzioni di origine: è consentita al massimo un'origine specificata.

  • Nessuna origine specificata

    Se non viene specificato alcun valore di origine, il valore esistente nel campo di destinazione verrà modificato.

  • move_from: <source field>

    Il valore di <source field> verrà utilizzato come origine per il campo di destinazione. Inoltre, <source field> verrà rimosso dalla voce di log. Se un campo di origine viene fatto riferimento sia da move_from sia da copy_from, il campo di origine verrà comunque rimosso.

  • copy_from: <source field>

    Il valore di <source field> verrà utilizzato come origine per il campo di destinazione. <source field> non verrà rimosso dalla voce del log, a meno che non venga fatto riferimento anche a un'operazione move_from o se non viene modificato in altro modo.

  • static_value: <string>

    La stringa statica <string> verrà utilizzata come origine per il campo di destinazione.

Opzioni di mutazione: a un singolo campo è possibile applicare zero o più operatori di mutazione. Se vengono forniti più operatori, verranno sempre applicati nel seguente ordine.

  1. default_value: <string>

    Se il campo di origine non esiste, il valore di output verrà impostato su <string>. Se il campo di origine esiste già (anche se contiene una stringa vuota), il valore originale non viene modificato.

  2. map_values: <map>

    Se il valore di input corrisponde a una delle chiavi in <map>, il valore di output verrà sostituito con il valore corrispondente della mappa.

  3. map_values_exclusive: {true|false}

    Se il valore <source field> non corrisponde a nessuna delle chiavi specificate nelle coppie map_values, il campo di destinazione verrà forzato su un valore non impostato se map_values_exclusive è true o lasciato invariato se map_values_exclusive è false.

  4. type: {integer|float}

    Il valore inserito verrà convertito in un numero intero o in un numero in virgola mobile. Se la stringa non può essere convertita in un numero, il valore di output non verrà impostato. Se la stringa contiene un numero decimale, ma il tipo è specificato come integer, il numero verrà troncato a un numero intero.

    Tieni presente che l'API Cloud Logging utilizza JSON e pertanto non supporta un numero intero a 64 bit completo. Se è necessario un numero intero a 64 bit (o superiore), deve essere archiviato come stringa nella voce di log.

  5. omit_if: <filter>

    Se il filtro corrisponde al record del log di input, il campo di output verrà impostato su non impostato. Questo può essere utilizzato per rimuovere i valori segnaposto, ad esempio:

    httpRequest.referer:
  move_from: jsonPayload.referer
  omit_if: httpRequest.referer = "-"

Configurazioni di esempio

Il programma di elaborazione parse_json trasforma un file JSON contenente

{
  "http_status": "400",
  "path": "/index.html",
  "referer": "-"
}

in una struttura LogEntry con il seguente aspetto:

{
  "jsonPayload": {
    "http_status": "400",
    "path": "/index.html",
    "referer": "-"
  }
}

che può essere trasformato con modify_fields in questo LogEntry:

{
  "httpRequest": {
    "status": 400,
    "requestUrl": "/index.html",
  }
}

utilizzando questa configurazione di Ops Agent:

logging:
  receivers:
    in:
      type: files
      include_paths:
      - /var/log/http.json
  processors:
    parse_json:
      type: parse_json
    set_http_request:
      type: modify_fields
      fields:
        httpRequest.status:
          move_from: jsonPayload.http_status
          type: integer
        httpRequest.requestUrl:
          move_from: jsonPayload.path
        httpRequest.referer:
          move_from: jsonPayload.referer
          omit_if: jsonPayload.referer = "-"
  service:
    pipelines:
      pipeline:
        receivers: [in]
        processors: [parse_json, set_http_request]

Questa configurazione legge i log in formato JSON da /var/log/http.json e compila parte della struttura httpRequest dai campi dei log.

Servizio di logging

Il servizio di logging personalizza la modalità dettagliata per i log di Ops Agent e collega i ricevitori e gli elaboratori di log in pipeline. La sezione service contiene i seguenti elementi:

  • log_level
  • pipelines

Livello di dettaglio dei log

Il campo log_level, disponibile con Ops Agent 2.6.0 e versioni successive, consente di personalizzare il livello di dettaglio per i log del sottomodulo di logging di Ops Agent. Il valore predefinito è info. Le opzioni disponibili sono: error, warn, info, debug, trace.

La seguente configurazione personalizza la modalità di dettaglio dei log per il sottomodulo di logging impostandola su debug:

logging:
  service:
    log_level: debug

Pipeline di log

Il campo pipelines può contenere più ID e definizioni di pipeline. Ogni valore pipeline è costituito dai seguenti elementi:

  • receivers: obbligatorio per le nuove pipeline. Un elenco di ID dei destinatari, come descritto in Log dei destinatari. L'ordine degli ID dei destinatari nell'elenco non è importante. La pipeline raccoglie i dati da tutti i destinatari elencati.

  • processors: facoltativo. Un elenco di ID dei processori, come descritto in Processori di log. L'ordine degli ID dei processori nell'elenco è importante. Ogni record viene eseguito tramite i processori nell'ordine elencato.

Esempi di configurazioni di logging service

Una configurazione service ha la seguente struttura:

service:
  log_level: CUSTOM_LOG_LEVEL
  pipelines:
    PIPELINE_ID:
      receivers:  [...]
      processors: [...]
    PIPELINE_ID_2:
      receivers:  [...]
      processors: [...]

Per impedire all'agente di raccogliere e inviare voci /var/log/message o /var/log/syslog, ridefinisci la pipeline predefinita con un elenco receivers vuoto e nessun elaboratore. Questa configurazione non interrompe il sottocomponente di logging dell'agente, perché l'agente deve essere in grado di raccogliere i log per il sottocomponente di monitoraggio. L'intera configurazione del logging vuota è la seguente:

logging:
  service:
    pipelines:
      default_pipeline:
        receivers: []

La seguente configurazione service definisce una pipeline con l'ID custom_pipeline:

logging:
  service:
    pipelines:
      custom_pipeline:
        receivers:
        - RECEIVER_ID
        processors:
        - PROCESSOR_ID

Configurazioni delle metriche

La configurazione metrics utilizza il modello di configurazione descritto in precedenza:

  • receivers: un elenco di definizioni del ricevitore. Un receiver descrive la fonte delle metriche, ad esempio le metriche di sistema come cpu o memory. I destinatari in questo elenco possono essere condivisi tra più pipeline.
  • processors: un elenco di definizioni di processor. Un processor descrive come modificare le metriche raccolte da un destinatario.
  • service: contiene una sezione pipelines che è un elenco di definizioni pipeline. Un pipeline collega un elenco di receivers e un elenco di processors per formare il flusso di dati.

Le sezioni seguenti descrivono ciascuno di questi elementi.

Ops Agent invia le metriche a Cloud Monitoring. Non puoi configurarlo per esportare le metriche in altri servizi.

Destinatari delle metriche

L'elemento receivers contiene un insieme di definizioni del ricevitore. Un ricevitore descrive da dove recuperare le metriche, ad esempio cpu e memory. Un destinatario può essere condiviso tra più pipeline.

Struttura dei ricevitori delle metriche

Ogni destinatario deve avere un identificatore, RECEIVER_ID, e includere un elemento type. I tipi integrati validi sono:

  • hostmetrics
  • iis (solo Windows)
  • mssql (solo Windows)

Un ricevente può anche specificare l'opzione di operazione collection_interval. Il valore è nel formato di una durata, ad esempio 30s o 2m. Il valore predefinito è 60s.

Ciascuno di questi tipi di ricevitori raccoglie un insieme di metriche. Per informazioni sulle metriche specifiche incluse, consulta Metriche importate dai ricevitori.

Puoi creare un solo destinatario per ogni tipo. Ad esempio, non puoi definire due destinatari di tipo hostmetrics.

Modificare l'intervallo di raccolta nei destinatari delle metriche

Alcuni carichi di lavoro critici potrebbero richiedere avvisi rapidi. Riducendo l'intervallo di raccolta per le metriche, puoi configurare avvisi più sensibili. Per informazioni su come vengono valutati gli avvisi, consulta Comportamento dei criteri di avviso basati su metriche.

Ad esempio, il seguente ricevitore modifica l'intervallo di raccolta per le metriche dell'host (l'ID ricevitore è hostmetrics) dal valore predefinito di 60 secondi a 10 secondi:

metrics:
  receivers:
    hostmetrics:
      type: hostmetrics
      collection_interval: 10s

Puoi anche sostituire l'intervallo di raccolta per i ricevitori delle metriche iis e mssql di Windows utilizzando la stessa tecnica.

Metriche importate dai destinatari

Le metriche importate dall'Ops Agent hanno identificatori che iniziano con il seguente pattern: agent.googleapis.com/GROUP. Il componente GROUP identifica un insieme di metriche correlate; ha valori come cpu, network e altri.

Il ricevitore hostmetrics

Il ricevitore hostmetrics importa i seguenti gruppi di metriche. Per maggiori informazioni, consulta la sezione collegata per ciascun gruppo nella pagina Metriche di Ops Agent.

Gruppo Metrica
cpu Carico della CPU a intervalli di 1 minuto
Carico della CPU a intervalli di 5 minuti
Carico della CPU a intervalli di 15 minuti
Utilizzo della CPU, con etichette per il numero e lo stato della CPU
Percentuale di utilizzo della CPU, con etichette per il numero e lo stato della CPU
disk Byte del disco letti, con etichetta per il dispositivo
Byte del disco scritti, con etichetta per il dispositivo
Tempo di I/O del disco, con etichetta per il dispositivo
Tempo di I/O ponderato del disco, con etichetta per il dispositivo
Operazioni in attesa sul disco, con etichetta per il dispositivo
Operazioni unite sul disco, con etichette per il dispositivo e la direzione
Operazioni sul disco, con etichette per il dispositivo e la direzione
Tempo di operazione del disco, con etichette per il dispositivo e la direzione
Utilizzo del disco, con etichette per il dispositivo e lo stato
Utilizzo del disco, con etichette per il dispositivo e lo stato
gpu
Solo Linux; consulta Informazioni sulle metriche gpu per altre informazioni importanti. 		Numero corrente di byte di memoria GPU utilizzati, per stato
Quantità massima di memoria GPU, in byte, allocata dal processo
Percentuale di tempo nel ciclo di vita del processo durante la quale uno o più kernel sono stati in esecuzione sulla GPU
Percentuale di tempo, dall'ultimo campione, durante la quale la GPU è stata attiva
interface
Solo Linux 		Conteggio totale degli errori di rete
Conteggio totale dei pacchetti inviati tramite la rete
Numero totale di byte inviati tramite la rete
memory Utilizzo della memoria, con etichetta per lo stato (buffered, cache, free, slab, used)
Percentuale di utilizzo della memoria, con etichetta per lo stato (buffered, cache, free, slab, used)
network Conteggio delle connessioni TCP, con etichette per la porta e lo stato TCP
swap Scambia le operazioni di I/O, con etichetta per la direzione
Scambia i byte utilizzati, con etichette per il dispositivo e lo stato
Scambia la percentuale utilizzata, con etichette per il dispositivo e lo stato
pagefile
Solo Windows 		Percentuale corrente del file di pagina utilizzato in base allo stato
processes Conteggio dei processi, con etichetta per lo stato
Conteggio dei processi forcati
I/O di lettura disco per processo, con etichette per il nome del processo + altre
I/O di scrittura disco per processo, con etichette per il nome del processo + altre
Utilizzo RSS per processo, con etichette per il nome del processo + altre
Utilizzo VM per processo, con etichette per il nome del processo + altre
Il ricevitore iis (solo Windows)

Il ricevitore iis (solo Windows) importa le metriche del gruppo iis. Per ulteriori informazioni, consulta la pagina Metriche dell'agente.

Gruppo Metrica
iis
Solo Windows 		Connessioni attualmente aperte a IIS
Byte di rete trasferiti da IIS
Connessioni aperte a IIS
Richieste effettuate a IIS
Il ricevitore mssql (solo Windows)

Il ricevitore mssql (solo Windows) importa le metriche del gruppo mssql. Per maggiori informazioni, consulta la pagina Metriche di Ops Agent.

Gruppo Metrica
mssql
Solo Windows 		Connessioni attualmente aperte a SQL Server
Transazioni totali di SQL Server al secondo
Transazioni di scrittura di SQL Server al secondo

Processori delle metriche

L'elemento processor contiene un insieme di definizioni di processor. Un elaboratore descrive le metriche del tipo di destinatario da escludere. L'unico tipo supportato è exclude_metrics, che accetta un'opzione metrics_pattern. Il valore è un elenco di glob che corrispondono ai tipi di metriche di Ops Agent che vuoi escludere dal gruppo raccolto da un destinatario. Ad esempio:

Esempio di processore delle metriche

L'esempio seguente mostra il processore exclude_metrics fornito nelle configurazioni predefinite. Questo elaboratore fornisce un valore metrics_pattern vuoto, pertanto non esclude alcuna metrica.

processors:
  metrics_filter:
    type: exclude_metrics
    metrics_pattern: []

Per disattivare la raccolta di tutte le metriche dei processi da parte di Ops Agent, aggiungi quanto segue al file config.yaml:

metrics:
  processors:
    metrics_filter:
      type: exclude_metrics
      metrics_pattern:
      - agent.googleapis.com/processes/*

Ciò esclude la raccolta delle metriche dei processi nel metrics_filter processore che si applica alla pipeline predefinita nel servizio metrics.

Servizio di generazione di metriche

Il servizio delle metriche personalizza la modalità dettagliata per i log del modulo delle metriche di Ops Agent e collega i ricevitori e gli elaboratori delle metriche in pipeline. La sezione service ha due elementi: log_level e pipelines.

Livello di dettaglio delle metriche

log_level, disponibile con le versioni 2.6.0 e successive di Ops Agent, consente di personalizzare la complessità per i log del sottomodulo delle metriche di Ops Agent. Il valore predefinito è info. Le opzioni disponibili sono: error, warn, info, debug.

Pipeline di metriche

La sezione service ha un singolo elemento, pipelines, che può contenere più definizioni e ID pipeline. Ogni definizione pipeline è costituita dai seguenti elementi:

  • receivers: obbligatorio per le nuove pipeline. Un elenco di ID dei destinatari, come descritto in Destinatari di Metrics. L'ordine degli ID dei destinatari nell'elenco non è importante. La pipeline raccoglie i dati da tutti i destinatari elencati.

  • processors: facoltativo. Un elenco di ID dei processori, come descritto in Processori delle metriche. L'ordine degli ID dei processori nell'elenco è importante. Ogni punto metrico viene eseguito tramite i processori in ordine elencato.

Esempi di configurazioni delle metriche service

Una configurazione service ha la seguente struttura:

service:
  log_level: CUSTOM_LOG_LEVEL
  pipelines:
    PIPELINE_ID:
      receivers:  [...]
      processors: [...]
    PIPELINE_ID_2:
      receivers:  [...]
      processors: [...]

Per disattivare l'importazione integrata delle metriche host, ridefinisci la pipeline predefinita con un elenco receivers vuoto e senza elaboratori. L'intera configurazione delle metriche è la seguente:

metrics:
  service:
    pipelines:
      default_pipeline:
        receivers: []

L'esempio seguente mostra la configurazione service integrata per Windows:

metrics:
  service:
    pipelines:
      default_pipeline:
        receivers:
        - hostmetrics
        - iis
        - mssql
        processors:
        - metrics_filter

La seguente configurazione di service personalizza la modalità di dettaglio dei log per il sottomodulo metriche in modo che sia debug:

metrics:
  service:
    log_level: debug

Raccolta di log personali

Per impostazione predefinita, i log di autocontrollo di Fluent Bit di Ops Agent vengono inviati a Cloud Logging. Questi log possono includere molte informazioni e il volume aggiuntivo potrebbe aumentare i costi di utilizzo di Cloud Logging.

Puoi disattivare la raccolta di questi log autocontenuti, a partire dalla versione 2.44.0 di Ops Agent, utilizzando l'opzione default_self_log_file_collection.

Per disattivare la raccolta dei log autonomi, aggiungi una sezione global al file di configurazione specificato dall'utente e imposta l'opzione default_self_log_file_collection sul valore false:

logging:  ...
metrics:  ...
global:
  default_self_log_file_collection: false

Configurazione della rotazione dei log

A partire dalla versione 2.31.0 di Ops Agent, puoi anche configurare la funzionalità di rotazione dei log dell'agente utilizzando i file di configurazione. Per ulteriori informazioni, consulta Configurare la rotazione dei log in Ops Agent.