Creare logger di inoltro

  • Articolo

I logger di inoltro migliorano l'efficienza della registrazione, perché consentono di scegliere gli eventi da monitorare quando si compilano progetti in un sistema multiprocessore. L'abilitazione dei logger di inoltro impedisce che gli eventi indesiderati sovraccarichino il logger centrale, rallentando le compilazioni e occupando spazio nel log.

Per creare un logger di inoltro è possibile implementare l'interfaccia IForwardingLogger, quindi implementare manualmente i metodi corrispondenti oppure usare la classe ConfigurableForwardingLogger e i metodi preconfigurati corrispondenti. La seconda soluzione è in genere sufficiente per la maggior parte delle applicazioni.

Registrare gli eventi e adottare misure

Un logger di inoltro raccoglie informazioni sugli eventi di compilazione man mano che vengono segnalati dal motore di compilazione secondario, un processo di lavoro creato dal processo di compilazione principale durante una compilazione in un sistema multiprocessore. Il logger di inoltro seleziona gli eventi da inoltrare al logger centrale, in base alle istruzioni impostate.

È necessario registrare i logger di inoltro per la gestione degli eventi da monitorare. Per eseguire la registrazione per gli eventi, i logger devono eseguire l'override del metodo Initialize. Questo metodo ora include il parametro facoltativo nodecount, che può essere impostato sul numero di processori del sistema. Per impostazione predefinita, il valore è 1.

Ad esempio è possibile monitorare eventi quali TargetStarted, ProjectStarted e ProjectFinished.

In un ambiente multiprocessore, è probabile che i messaggi di evento non vengano ricevuti in ordine. Pertanto è necessario valutare gli eventi usando il gestore eventi nel logger di inoltro e programmarlo per determinare gli eventi da passare al redirector per l'inoltro al logger centrale. A tale scopo è possibile usare la classe BuildEventContext collegata a ogni messaggio per identificare gli eventi da inoltrare, quindi passare i nomi degli eventi alla classe ConfigurableForwardingLogger (o a una sottoclasse). Se si usa questo metodo, non è necessario altro codice specifico per inoltrare gli eventi.

Specificare un logger di inoltro

Dopo che il logger di inoltro è stato compilato in un assembly, è necessario indicare a MSBuild di usarlo durante le compilazioni. A tale scopo, usare le opzioni -FileLogger, -FileLoggerParameters, e -DistributedFileLogger insieme a MSBuild.exe. L'opzione -FileLogger comunica a MSBuild.exe che il logger è collegato direttamente. L'opzione -DistributedFileLogger indica che è presente un file di log per ogni nodo. L'opzione -FileLoggerParameters consente di impostare parametri per il logger di inoltro. Per informazioni sul queste e altre opzioni di MSBuild.exe, vedere Riferimenti alla riga di comando.

Logger compatibili con più processori

Quando si compila un progetto in un sistema multiprocessore, i messaggi di compilazione di ogni processore non vengono disposti automaticamente in una sequenza unificata. È necessario stabilire una priorità di raggruppamento dei messaggi usando la classe BuildEventContext associata a ogni messaggio. Per altre informazioni sulla compilazione in ambienti a più processori, vedere Registrazione in un ambiente a più processori.

Contenuto correlato