Log de aplica��es .NET atrav�s do Event Viewer

O monitoramento de aplicaç�es num ambiente corporativo � uma tarefa extremamente importante, fornecendo meios para que administradores de sistemas possam atuar diante de eventos inesperados em tais softwares. A t�cnica que garante a geraç�o das informaç�es necess�rias para atividades deste tipo � conhecida pelo nome de instrumentaç�o.

Muitas vezes, a gravaç�o de dados que descrevem o que vem acontecendo em uma aplicaç�o acaba por ser relegada a um segundo plano. Isto se deve a uma s�rie de raz�es bem conhecidas por aqueles que est�o familiarizados com a �rea de TI, passando desde pela press�o na entrega mais r�pida de projetos, ou at� mesmo pelo pr�prio desconhecimento/esquecimento dos envolvidos na construç�o/implantaç�o de um sistema em se atentar a esses detalhes.

Al�m disso, quando se considera o cen�rio atual, � um fato bastante comum que muitas organizaç�es tamb�m estejam sujeitas a rigorosas auditorias em seus processos. Um bom exemplo disso s�o companhias com aç�es negociadas em bolsas de valores. Em tais casos, diversas medidas decorrentes de regulamentaç�es financeiras precisar�o ser adotadas, incluindo nisto a gravaç�o de dados que possibilitem rastrear eventos que aconteceram em aplicaç�es de uso cotidiano.

Ao conjunto de registros que descrevem as mais diversas ocorr�ncias dentro de um sistema d�-se o nome de log. Diversas s�o as abordagens que podem ser empregadas na gravaç�o de informaç�o deste g�nero:

Uma das t�cnicas mais comuns consiste na criaç�o de tabelas de log em bases relacionais. Embora isso seja uma boa soluç�o na maioria dos casos, uma prov�vel indisponibilidade do servidor de dados impedir� que se registrem informaç�es (inclusive a geraç�o de um registro que identifique a pr�pria indisponibilidade do banco);
Outra possibilidade seria a gravaç�o de informaç�es em arquivos de texto ou ainda, no formato XML. Existem at� mesmo ferramentas e frameworks que oferecem funcionalidades neste sentido, sendo que o log4net (http://logging.apache.org/log4net/) uma alternativa gratuita bastante difundida;
Um terceiro caminho seria o uso de alguma estrutura pr�pria de um sistema operacional. No caso espec�fico da plataforma Windows, o componente conhecido como Event Viewer (Figura 1) representa uma boa soluç�o nesse sentido. Permitindo o acesso ao log de forma local e tamb�m remotamente, uma interface gr�fica possibilita que administradores de sistema visualizem detalhes das diferentes mensagens registradas.

Figura 1: Visualizador de Eventos do Windows 7

OBSERVAÇ�O: Em computadores com o Windows 7 instalado, o Visualizador de Eventos pode ser acessado a partir do menu Iniciar > Ferramentas Administrativas > Visualizador de Eventos.

O objetivo deste artigo � justamente demonstrar como informaç�es podem ser gravadas no Event Viewer do Windows. Buscando cumprir essa meta, ser�o apresentados alguns exemplos de c�digo que fazem uso de estruturas do .NET voltadas a demandas deste tipo.

Manipulando informaç�es do Event Viewer em .NET

Os recursos que permitem a gravaç�o de informaç�es no Visualizador de Eventos do Windows existem desde a vers�o 2.0 do .NET Framework, encontrando-se definidos no namespace System.Diagnostics. O exemplo aqui abordado faz uso das seguintes estruturas:

EventLog: classe que disponibiliza funcionalidades para que aplicaç�es .NET interajam com o Event Viewer, com isto acontecendo atrav�s da gravaç�o de mensagens (tamb�m conhecidas como entradas/entries) ou, at� mesmo, a partir da leitura de informaç�es de log previamente registradas;
EventLogEntryType: enumeration que identifica o tipo de um registro armazenado no log de eventos.

Na Tabela 1 est�o indicados os valores poss�veis para o enumeration EventLogEntryType.

Valor	Descriç�o
Error	Indica a ocorr�ncia de algum erro como perda de dados ou falha na execuç�o de uma funcionalidade.
Warning	Embora n�o seja propriamente uma falha, mensagens deste tipo representam alertas de problemas que podem resultar em erros no futuro.
Information	Entrada de car�ter informativo, indicando normalmente a ocorr�ncia com sucesso de um determinado evento.
SuccessAudit	Comumente associado a eventos de segurança, pode ser utilizado para registrar que uma tentativa de logon foi bem sucedida.
FailureAudit	Tamb�m relativo a quest�es de segurança, este valor indica que uma operaç�o n�o teve �xito. Um exemplo disto � a tentativa de acesso a um arquivo para o qual n�o se possui permiss�o.

Tabela 1: Valores poss�veis para o enumeration EventLogEntryType

Na Listagem 1 � apresentada a implementaç�o da classe est�tica EventViewerHelper. Este tipo utiliza os mecanismos de log j� mencionados nesta seç�o, sendo que a gravaç�o de informaç�es descrevendo eventos de uma aplicaç�o acontecer� por meio da operaç�o RegistrarMensagem.

Quanto ao funcionamento do m�todo est�tico RegistrarMensagem, � poss�vel destacar:

Essa construç�o receber� como informaç�es a aplicaç�o que originou a entraada no log (par�metro �origemMensagem�), o conte�do da mensagem em quest�o (par�metro �conteudoMensagem�) e ainda, o tipo da mensagem (par�metro �tipoMensagem�);
Inicialmente � invocado o m�todo SourceExists da classe EventLog. Esta aç�o tem por objetivo determinar se a origem das mensagens (nome da aplicaç�o) j� est� cadastrada no Event Viewer;
Caso o retorno da operaç�o SourceExists seja falso, � realizada ent�o uma chamada ao m�todo CreateEventSource, para que assim se crie as informaç�es necess�rias para a gravaç�o dos registros de log. CreateEventSource recebe como par�metros o nome da aplicaç�o em que � gerando o log, al�m da identificaç�o da seç�o em que constar�o tais mensagens (o valor �Application� indica que ao se acessar o Visualizador de Eventos os registros estar�o vis�veis a partir de um item chamado �Aplicaç�o�, considerando para isto que o Windows esteja configurado para o idioma portugu�s);
Por fim, uma inst�ncia do tipo EventLog � criada. A propriedade Source deste objeto � preenchida com o nome da aplicaç�o e, em seguida, � realizada uma chamada ao m�todo WriteEntry. Esta �ltima operaç�o recebe como par�metros o conte�do da mensagem a ser persistida, bem como o tipo correspondente (enumeration EventLogEntryType).

Listagem 1: Classe EventViewerHelper


using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Diagnostics;

namespace TesteEventViewer
{
    public static class EventViewerHelper
    {
        public static void RegistrarMensagem(
            string origemMensagem,
            string conteudoMensagem,
            EventLogEntryType tipoMensagem)
        {
            if (!EventLog.SourceExists(origemMensagem))
            {
                EventLog.CreateEventSource(
                    origemMensagem,
                    "Application");
            }

            EventLog log = new EventLog();
            log.Source = origemMensagem;
            log.WriteEntry(conteudoMensagem, tipoMensagem);
        }
    }
}

A Listagem 2 apresenta um exemplo de utilizaç�o da classe EventViewerHelper. O m�todo Main desta aplicaç�o aciona o m�todo RegistrarMensagem, visando com isto gravar no log do Windows uma notificaç�o de que o sistema considerado foi executado num determinado momento (conforme indicado na Figura 2).

Listagem 2: Exemplo de trecho de c�digo que faz uso da classe EventViewerHelper

Figura 2: Mensagem de log gravada no Event Viewer

OBSERVAÇ�O: caso se realizem testes a partir do Visual Studio e que envolvam a gravaç�o de informaç�es no Event Viewer, executar este aplicativo como �Administrador�, pois do contr�rio ocorrer� uma falha de segurança.

Conclus�o

Procurei com este artigo demonstrar como o mecanismo de log do Windows pode ser usado a partir de aplicaç�es .NET. Este recurso pode ser particularmente �til em soluç�es que envolvam a implementaç�o de serviços executados periodicamente; a gravaç�o de informaç�es no Event Viewer ajudaria ent�o administradores de sistema a monitorarem os softwares ativos, conseguindo assim determinar se a operaç�o dos mesmos est� dentro do esperado.

Outra consideraç�o importante a ser feita � a respeito do que dever� ou n�o ser salvo no Visualizador de Eventos. Para a gravaç�o de informaç�es que envolvam operaç�es realizadas numa base relacional, recomenda-se o uso de uma tabela no pr�prio banco; esta medida contribui para evitar um volume grande de mensagens, sendo que muitas n�o acrescentariam detalhes significativos aos respons�veis por acompanhar o funcionamento de um software.

Espero que o conte�do aqui abordado possa lhe auxiliar em algum momento. At� uma pr�xima oportunidade!

Log de aplica��es .NET atrav�s do Event Viewer

Veja neste artigo como registrar, a partir de aplicações construídas sob o .NET Framework, mensagens de log no Visualizador de Eventos do Windows (utilitário este também conhecido como Event Viewer).

Manipulando informaç�es do Event Viewer em .NET

Conclus�o

Artigos relacionados