Procedura per eseguire il log delle operazioni del modulo FEP

Da SIGLAkb.

Introduzione

       La metodologia di tracciatura descritta in questo paragrafo SOSTITUISCE quella precedente, che utilizza i file .config, ed è applicabile per la versione 1.0.10 e successive di FEP

Log delle operazioni del modulo FEP

Dp-ingranaggio3.png Allo scopo di approfondire l’analisi di una funzione del modulo FEP è possibile attivare la tracciatura delle operazioni eseguite per fornire al servizio di supporto tecnico informazioni dettagliate.
La tracciatura delle operazioni si attiva mediante la configurazione di un opportuno file ini, ed è eseguita in un file di testo.
Questa metodologia di tracciatura è utilizzabile con le applicazioni

  • Configurazione di SIGLA Ultimate/Start Edition/Cloud
  • SIGLA Ultimate/Start Edition/Cloud
  • Configurazione FEP StandAlone
  • FEP StandAlone
  • Servizio di acquisizione fatture emesse per FEP (anche se usato da console)

Il file ini deve necessariamente avere il nome DPSLogger.ini e risiedere nella cartella dati applicazioni di tutti gli utenti\DeltaPhiSIGLA\DPSLogger (normalmente C:\ProgramData\DeltaPhiSIGLA\DPSLogger).
I file di tracciatura, per i log configurati, saranno creati nella stessa cartella (dati applicazioni di tutti gli utenti\DeltaPhiSIGLA\DPSLogger) con il nome impostato nel file DPSLogger.ini o con quello di default, indicato in tabella.
Il file DPSLogger.ini può contenere i seguenti dati di configurazione[1]:

Sezione Chiave Valore ammesso Note
GLOBALS     Questa sezione è quella relativa alle impostazioni di default, le chiavi di questa sezione vengono utilizzate come valore predefinito per tutte le tracciature (applicazioni) configurate in questo file. Il valore delle omonime chiavi della singola configurazione hanno rilevanza maggiore rispetto a questo dato.
Si faccia attenzione al fatto che, anche volendo usare i soli parametri di configurazione lobale, la sezione relativa all'applicazione da loggare deve essere presente nel file, anche vuota. Altrimenti il log non sarà creato in nessun caso. La sezione GLOBALS è opzionale.
GLOBALS ACTIVATE y
s
n
Consente di abilitare o disabilitare le fasi di tracciatura. I valori impostabili sono 'y' o 's' per attivare il log, ed 'n' per disattivarlo. Il valore del parametro e' case insensitive.
GLOBALS LEVEL I livelli di tracciatura ammessi sono
i -> per solo info
w -> per solo warning
e -> solo errori
d -> debug (traccia tutti i precedenti)
Indica il livello di tracciatura da applicare al log. Il valore del parametro e' case insensitive.
GLOBALS TYPE Valori accettati[2]
Text
SQLite
Indica quale tipo dii tracciatura deve essere eseguita. Con il valore 'Text' si indica la volontà di ottenere la tracciatura in un file di testo. 'SQLite' invece per un database di tipo SQLite.
       
CONFIG32     Questa sezione consente di impostare i dati di configurazione della tracciatura per la Configurazione di SIGLA Ultimate/Start Edition/Cloud. Le eventuali chiavi di questa sezione prevalgono su quelle presenti in GLOBALS.
CONFIG32 ACTIVATE y
s
n
Consente di abilitare o disabilitare le fasi di tracciatura. I valori impostabili sono 'y' o 's' per attivare il log, ed 'n' per disattivarlo. Il valore del parametro e' case insensitive.
CONFIG32 LEVEL I livelli di tracciatura ammessi sono
i -> per solo info
w -> per solo warning
e -> solo errori
d -> debug (traccia tutti i precedenti)
Indica il livello di tracciatura da applicare al log. Il valore del parametro e' case insensitive.
CONFIG32 TYPE Valori accettati
Text
SQLite
Indica quale tipo dii tracciatura deve essere eseguita. Con il valore 'Text' si indica la volontà di ottenere la tracciatura in un file di testo. 'SQLite' invece per un database di tipo SQLite.
CONFIG32 FILENAME Nome file Indica il nome del file di tracciatura da creare, privo di percorso. Di default viene utilizzato il nome della sezione con estensione .log (in questo caso CONFIG32.log)
CONFIG32 LAYOUT Stinga layout valida[3] ${callsite:className=true:includeNamespace=false:skipFrames=1} | ${callsite-filename:includeSourcePath=false:skipFrames=1}:${callsite-linenumber:skipFrames=1} | ${level:uppercase=true} | ${message}
CONFIG32 CREATESQL Statement di creazione tabella Contiene lo statement sql di creazione, della tabella di tracciatura, nel caso il log sia salvato in una database SQLite. Di default viene utilizzato
CREATE TABLE LOG (FUNCTION CHAR(128), SOURCECS CHAR(128), THREADID INTEGER, LOGLEVEL CHAR(32), MESSAGE TEXT, TIME_STAMP TIMESTAMP)
CONFIG32 INSERTSQL Statement di inserimento in tabella Contiene lo statement sql di inserimento, nella tabella di tracciatura, nel caso il log sia salvato in una database SQLite. Di default viene utilizzato
INSERT INTO LOG (FUNCTION, SOURCECS, THREADID, LOGLEVEL, MESSAGE, TIME_STAMP) values(?,?,?,?,?,?)
CONFIG32 PARAMx Impostazione parametri per INSERTSQL PARAMx, dove x è un numero da 0 ad n, usati per configurare tutti i parametri della query di inserimento dati. Di default vengono usati sei parametri (da 0 a 5)

PARAM0=FUNCTION;${callsite:className=true:includeNamespace=false:skipFrames=1}
PARAM1=SOURCECS;${callsite-filename:includeSourcePath=false:skipFrames=1}:${callsite-linenumber:skipFrames=1}
PARAM2=THREADID;${threadid:skipFrames=1}
PARAM3=LOGLEVEL;${level:uppercase=true}
PARAM4=MESSAGE;${message}
PARAM5=TIME_STAMP;${longdate}

CONFIG32 ACTIVATE_IMAP y
s
n
Consente di abilitare o disabilitare le fasi di tracciatura dei messaggi imap, se il protocollo è utilizzato dall'applicazione, tra client e server-mail. I valori impostabili sono 'y' o 's' per attivare il log, ed 'n' per disattivarlo. Il valore del parametro e' case insensitive
CONFIG32 ACTIVATE_SMTP y
s
n
Consente di abilitare o disabilitare le fasi di tracciatura dei messaggi smtp, se il protocollo è utilizzato dall'applicazione, tra client e server-mail. I valori impostabili sono 'y' o 's' per attivare il log, ed 'n' per disattivarlo. Il valore del parametro e' case insensitive

La sezione CONFIG32 può essere replicata, o sostituita, con elementi, con identiche chiavi, per la tracciatura da applicazioni diverse.

Sezione Applicazione
SIGLA32 E' la sezione che attiva la tracciatura per SIGLA Ultimate e Cloud
START32 E' la sezione che attiva la tracciatura per SIGLA Start Edition
FEP32 E' la sezione che attiva il log per FEP StandAlone
CFG32 E' la sezione che attiva il log per la Configurazione di FEP StandAlone
DPDASHBOARDSRV E' la sezione che attiva il log per il servizio di acquisizione fatture emesse per FEP
DPDASHBOARDSRV_CONSOLE E' la sezione che attiva il log per l'acquisizione fatture emesse per FEP quando eseguito da console


  1. In tabella sono riportati i dati di configurazione generale (GLOBALS) e quelli per la Configurazione di SIGLA Ultimate/Start Edition/Cloud (CONFIG32). Le altre applicazioni configurabili sono descritte nella seconda tabella e dispongono delle stesse chiavi di CONFIG32.
  2. Di default la tracciatura per tutte le applicazioni è salvata in un file di testo. Solo il servizio di acquisizione FE per FEP, anche eseguito come console, utilizza database di tipo SQLite
  3. Per l'elenco dei valori utilizzabili si veda la documentazione della libreria NLog


File di esempio

File DPSLogger.ini

Il file riportato attiva la tracciatura per tutte le applicazioni per cui è disponibile.

[GLOBALS]
ACTIVATE=y
LEVEL=d
TYPE=Text

[SIGLA32]
FILENAME=SIGLA32.log
ACTIVATE_IMAP=y
ACTIVATE_SMTP=y

[START32]
FILENAME=START32.log
ACTIVATE_IMAP=y
ACTIVATE_SMTP=y

[CONFIG32]
FILENAME=CONFIG32.log
ACTIVATE_IMAP=y
ACTIVATE_SMTP=y

[FEP32]
FILENAME=FEP32.log
ACTIVATE_IMAP=y
ACTIVATE_SMTP=y

[CFG32]
FILENAME=FEP32.log
ACTIVATE_IMAP=y
ACTIVATE_SMTP=y

[DPDASHBOARDSRV]
TYPE=SQLite
FILENAME=DPDASHBOARDSRV.db

[DPDASHBOARDSRV_CONSOLE]
TYPE=SQLite
FILENAME=DPDASHBOARDSRV_CONSOLE.db

N.B.: questa nuova tipologia di tracciatura prevede che i log siano creati nella cartella dati applicazioni di tutti gli utenti\DeltaPhiSIGLA\DPSLogger (normalmente C:\ProgramData\DeltaPhiSIGLA\DPSLogger).

L'utilizzo dei file .config è sconsigliato in quanto utilizzato da un metodo di tracciatura obsoleto.