Tracciatura su File¶

Le informazioni inerenti le comunicazioni gestite dal gateway vengono registrate su una base dati di tracciamento (Tracciamento) e sono consultabili tramite una console di monitoraggio (Introduzione).

È possibile estendere il normale tracciamento su database, attivando il tracciamento su file.

La nuova funzionalità consente il tracciamento su file di tutte le informazioni relative alle comunicazioni gestite da GovWay. Il successivo processamento del file da strumenti esterni (es. FileBeat) permette così una facile integrazione con sistemi di tracciamento esterni (es. Logstash, Kafka, …).

La funzionalità consente una completa personalizzazione delle informazioni da riportare su file di log, permettendo anche di definirne il formato e l’ordine in cui vengono salvate. È inoltre possibile suddividere le informazioni in più file di log in modo da facilitare l’invio di informazioni selezionate a destinazioni diverse.

Le informazioni possono essere riversate in uno o più topic, dove ad ogni topic corrisponde tipicamente un file di log. Di seguito un esempio di file prodotto:

"req"|"b6cdd758-342c-4599-ae95-33a781730b3f"|"govway"|"2020-06-26 12:46:50:629"|"+0200"|"192.168.1.2"|"HTTP/1.1"|"POST"|"https://server:8446/example"|"application/soap+xml; charset=UTF-8; action=\"test/\""|"10490"|"200"
"req"|"2a9dc253-9dd5-458b-8689-edee7c9ba139"|"govway"|"2020-06-26 12:47:50:561"|"+0200"|"192.168.1.2"|"HTTP/1.1"|"POST"|"https://server:8446/app2"|"application/soap+xml; charset=UTF-8; action=\"test/\""|"1090"|"503"
"req"|"eeedb92b-66b5-451e-8266-ade2cf1f34ce"|"govway"|"2020-06-26 12:47:53:291"|"+0200"|"192.168.1.19"|"HTTP/1.1"|"POST"|"https://server:8446/example"|"application/soap+xml; charset=UTF-8; action=\"test/\""|"11230"|"200"
"req"|"b4355a45-71cc-4293-b3b7-a4622af8ea84"|"govway"|"2020-06-26 12:48:00:102"|"+0200"|"192.168.1.22"|"HTTP/1.1"|"POST"|"https://server:8446/example"|"application/soap+xml; charset=UTF-8; action=\"test/\""|"17999"|"200"

Per attivare la funzionalità a livello globale abilitare la proprietà “org.openspcoop2.pdd.transazioni.fileTrace.enabled” nel file di configurazione locale “/etc/govway/govway_local.properties” (assumendo sia /etc/govway la directory di configurazione indicata in fase di installazione). Una volta attivata, si deve indicare, attraverso la proprietà “org.openspcoop2.pdd.transazioni.fileTrace.config”, dove reperire il file di configurazione che definisce il formato dei log prodotti dal gateway (formato descritto in Configurazione dei Topic). Di seguito un estratto della configurazione.

# ================================================
# FileTrace
# Indicazione se la funzionalità è abilitata o meno
org.openspcoop2.pdd.transazioni.fileTrace.enabled=true
#
...
#
# File di Configurazione
# Il file può essere indicato con un path assoluto o relativo rispetto alla directory di configurazione
org.openspcoop2.pdd.transazioni.fileTrace.config=govway.fileTrace.properties
# ================================================

Per attivare la funzionalità e/o modificare la configurazione utilizzata di FileTrace su una singola API si possono registrare le seguenti Proprietà sull’erogazione o sulla fruizione:

fileTrace.enabled : consente di attivare o disattivare la funzionalità (i valori associabili alla proprietà sono “true” o “false”);
fileTrace.config : consente di indicare il path su file system dove risiede la configurazione della tracciatura su file; il file indicato può essere un path assoluto o relativo rispetto alla directory di configurazione (per il formato fare riferimento alla sezione Configurazione dei Topic);
fileTrace.dumpBinario.enabled: consente di attivare o disattivare la registrazione dei messaggi scambiati con il client: richiesta ingresso e risposta uscita (i valori associabili alla proprietà sono “true” o “false”);
fileTrace.dumpBinario.payload.enabled e fileTrace.dumpBinario.headers.enabled: sovrascrivono la proprietà “fileTrace.dumpBinario.enabled” fornendo la possibilità di configurare puntualmente il tipo di informazione scambiata con il client (payload o headers) che sarà resa disponibile per la tracciatura (per default entrambi);
fileTrace.dumpBinario.connettore.enabled: consente di attivare o disattivare la registrazione dei messaggi scambiato con l’implementazione di backend dell’API: richiesta uscita e risposta ingresso (i valori associabili alla proprietà sono “true” o “false”);
fileTrace.dumpBinario.connettore.payload.enabled e fileTrace.dumpBinario.connettore.headers.enabled: sovrascrivono la proprietà “fileTrace.dumpBinario.connettore.enabled” fornendo la possibilità di configurare puntualmente il tipo di informazione scambiata con il backend (payload o headers) che sarà resa disponibile per la tracciatura (per default entrambi).

Nota

Solamente se la registrazione (fileTrace.dumpBinario.enabled e/o fileTrace.dumpBinario.connettore.enabled) è abilitata sarà possibile accedere ai contenuti dei messaggi come descritto nella sezione Informazioni Tracciabili.

Nella sezione Configurazione dei Topic viene descritto il formato del file di configurazione, mentre nella sezione Informazioni Tracciabili sono riportate tutte le informazioni disponibili.