mcs/class/referencesource/System.ServiceModel.Internals/System/Runtime/TraceLevelHelper.cs

   1 //----------------------------------------------------------------
   2 // Copyright (c) Microsoft Corporation.  All rights reserved.
   3 //----------------------------------------------------------------
   4
   5 namespace System.Runtime
   6 {
   7     using System;
   8     using System.Collections.Generic;
   9     using System.Text;
  10     using System.Diagnostics;
  11
  12     /// <remarks>
  13     /// Microsoft (11/15/10, CSDMain 194940) - Previously, this code first checked that the opcode was set to informational.  If not, it would check
  14     /// the opcode name for start, stop, suspend, or resume and use that or return Information otherwise.  This does not work well with the latest
  15     /// ETW changes where almost every event has a task and opcode.  With the old logic, if an opcode is set on the event with a level such as
  16     /// warning or error, the level would be incorrectly reported in diagnostic tracing as informational.  Also, start/stop/suspend/resume events
  17     /// have an overloaded meaning in diagnostic tracing that the svctraceviewer would misinterpret.  To keep diagnostic tracing from breaking, this
  18     /// class now checks for start/stop/suspend/resume opcodes and returns the level if any of those do not match.  Furthermore, any events defined
  19     /// that are shared between diagnostics and ETW should not use start/stop/suspend/resume opcodes unless explicitly intended for use in
  20     /// diagnostics tracing.
  21     /// </remarks>
  22     class TraceLevelHelper
  23     {
  24         static TraceEventType[] EtwLevelToTraceEventType = { TraceEventType.Critical, TraceEventType.Critical, TraceEventType.Error,
  25                 TraceEventType.Warning, TraceEventType.Information, TraceEventType.Verbose
  26             };
  27
  28         internal static TraceEventType GetTraceEventType(byte level, byte opcode)
  29         {
  30             switch (opcode)
  31             {
  32                 case (byte)TraceEventOpcode.Start:
  33                     return TraceEventType.Start;
  34                 case (byte)TraceEventOpcode.Stop:
  35                     return TraceEventType.Stop;
  36                 case (byte)TraceEventOpcode.Suspend:
  37                     return TraceEventType.Suspend;
  38                 case (byte)TraceEventOpcode.Resume:
  39                     return TraceEventType.Resume;
  40                 default:
  41                     return EtwLevelToTraceEventType[(int)level];
  42             }
  43         }
  44
  45         internal static TraceEventType GetTraceEventType(TraceEventLevel level)
  46         {
  47             return EtwLevelToTraceEventType[(int)level];
  48         }
  49
  50         internal static TraceEventType GetTraceEventType(byte level)
  51         {
  52             return EtwLevelToTraceEventType[(int)level];
  53         }
  54
  55         internal static string LookupSeverity(TraceEventLevel level, TraceEventOpcode opcode)
  56         {
  57             string severity;
  58             switch (opcode)
  59             {
  60                 case TraceEventOpcode.Start:
  61                     severity = "Start";
  62                     break;
  63                 case TraceEventOpcode.Stop:
  64                     severity = "Stop";
  65                     break;
  66                 case TraceEventOpcode.Suspend:
  67                     severity = "Suspend";
  68                     break;
  69                 case TraceEventOpcode.Resume:
  70                     severity = "Resume";
  71                     break;
  72                 default:
  73                     switch (level)
  74                     {
  75                         case TraceEventLevel.Critical:
  76                             severity = "Critical";
  77                             break;
  78                         case TraceEventLevel.Error:
  79                             severity = "Error";
  80                             break;
  81                         case TraceEventLevel.Warning:
  82                             severity = "Warning";
  83                             break;
  84                         case TraceEventLevel.Informational:
  85                             severity = "Information";
  86                             break;
  87                         case TraceEventLevel.Verbose:
  88                             severity = "Verbose";
  89                             break;
  90                         default:
  91                             severity = level.ToString();
  92                             break;
  93                     }
  94                     break;
  95             }
  96             return severity;
  97         }
  98     }
  99 }