Como: Configurar opções de rastreamento

Depois que seu aplicativo tiver sido distribuído, você pode habilitar ou desabilitar a saída de rastreamento, configurando as opções de rastreamento em seu aplicativo. Configurar um switch significa alterar seu valor de uma fonte externa, depois que tiver sido inicializado. Você pode alterar os valores dos objetos switch usando o arquivo de configuração. Você configurar um switch de rastreamento para ativar e desativar a ele ou para definir o seu nível, determinando a quantidade e tipo de mensagens ele passa para os ouvintes.

Os switches são configurados usando o arquivo. config. Para um aplicativo da Web, ele é o arquivo web.config associado ao projeto. Em um aplicativo do Windows, este arquivo é nomeado (nome do aplicativo). exe. Em um aplicativo implantado, esse arquivo deve residir na mesma pasta do executável.

Quando seu aplicativo executa o código que cria uma instância de um switch pela primeira vez, ele verifica o arquivo de configuração do nível de rastreamento de informações sobre o switch nomeado. O sistema de rastreamento examina o arquivo de configuração apenas uma vez para qualquer switch específico — a primeira vez que seu aplicativo cria o switch.

Em um aplicativo implantado, você pode habilitar o código de rastreamento reconfigurando o switch objetos quando seu aplicativo não está em execução. Geralmente, isso envolve ligar os objetos de switch e desativar ou alterando os níveis de rastreamento e reiniciar o seu aplicativo.

Quando você cria uma instância de um switch, também inicializá-lo especificando dois argumentos: um displayName argumento e um Descrição argumento. O displayName argumento dos conjuntos de construtor de Switch.DisplayName propriedade da Switch instância de classe. O displayName é o nome que é usado para configurar o switch no arquivo. config e o Descrição argumento deve retornar uma breve descrição do switch e quais mensagens controles.

Para além de especificar o nome de um switch para configurar, você deve também especificar um valor para o switch. Esse valor é um inteiro. Para BooleanSwitch, o valor 0 corresponde à Off, e qualquer valor diferente de zero corresponde a em. Para TraceSwitch, que correspondem a 0,1,2,3 e 4 Off, erro, Aviso, informações, e Verbose, respectivamente. Qualquer número maior que 4 é tratado como Verbosee qualquer número menor que zero é tratado como Off.

Observação

No.NET Framework versão 2.0, você pode usar o texto para especificar o valor de um switch.Por exemplo, true para um BooleanSwitch ou o texto que representa um valor de enumeração como Error para um TraceSwitch.A linha <add name="myTraceSwitch" value="Error" /> é equivalente a <add name="myTraceSwitch" value="1" />.

Em ordem para usuários finais possam configurar opções de rastreamento do aplicativo, você deve fornecer a documentação detalhada nos switches em seu aplicativo. Você deve detalhar quais opções controlam o que e como ativar e desativar a eles. Você também deve fornecer o seu usuário final com um arquivo. config que tem ajuda apropriada nos comentários.

Para criar e configurar opções de rastreamento

1. Crie seus comutadores no código. Para obter mais informações, consulte Criando e inicializando Switches de rastreamento.

2. Se o seu projeto não contém um arquivo de configuração (App. config ou Web. config), depois do projeto menu, selecione Add New Item.

   • Visual Basic: No Add New Item caixa de diálogo caixa, escolha Arquivo de configuração do aplicativo.

     O arquivo de configuração do aplicativo é criado e aberto. Este é um documento XML cujo elemento raiz é<configuration>.

   • C# Visual: No Add New Item caixa de diálogo caixa, escolha Arquivo XML. Este arquivo de nome App. config. No editor de XML, após a declaração XML, adicione o seguinte XML:

     <configuration>
     </configuration>
     

     Quando seu projeto é compilado, o arquivo app. config é copiado para a pasta de saída do projeto e é renomeado applicationname. exe.

3. Após a <configuration> , mas antes de marcar o </configuration> marca, adicione o XML apropriado para configurar opções. Os exemplos a seguintes demonstram uma BooleanSwitch com um DisplayName propriedade de DataMessageSwitch e um TraceSwitch com um DisplayName propriedade de TraceLevelSwitch.

   <system.diagnostics>
      <switches>
         <add name="DataMessagesSwitch" value="0" />
         <add name="TraceLevelSwitch" value="0" />
      </switches>
   </system.diagnostics>
   

   Nessa configuração, a ambos os switches são desativados.

4. Se você precisar ativar um BooleanSwitch, como DataMessagesSwitch mostrado no exemplo anterior, alterar o valor a qualquer inteiro diferente de 0.

5. Se você precisar ativar um TraceSwitch, como TraceLevelSwitch mostrado no exemplo anterior, alterar o valor para a configuração do nível adequada (de 1 a 4).

6. Adicione comentários ao arquivo. config para que o usuário final tenha uma compreensão clara de que os valores para alterar para configurar as opções apropriadamente.

   O exemplo a seguir mostra como o código final, incluindo comentários, pode parecer:

   <system.diagnostics>
      <switches>
         <!-- This switch controls data messages. In order to receive data 
            trace messages, change value="0" to value="1" -->
         <add name="DataMessagesSwitch" value="0" />
         <!-- This switch controls general messages. In order to 
            receive general trace messages change the value to the 
            appropriate level. "1" gives error messages, "2" gives errors 
            and warnings, "3" gives more detailed error information, and 
            "4" gives verbose trace information -->
         <add name="TraceLevelSwitch" value="0" />
      </switches>
   </system.diagnostics>
   

Consulte também

Tarefas

Como: Adicionar instruções de rastreamento ao código do aplicativo

Referência

Rastreamento e esquema configurações Debug

Conceitos

Introdução à instrumentação e rastreamento

Opções de rastreamento.

Outros recursos

Rastreamento e intrumentando aplicações