[platform/core/dotnet/build-tools.git] /

<?xml version="1.0"?>\r
<doc>\r
    <assembly>\r
        <name>Microsoft.Extensions.Logging.EventSource</name>\r
    </assembly>\r
    <members>\r
        <member name="T:Microsoft.Extensions.Logging.EventSource.EventSourceLogger">\r
            <summary>\r
            A logger that writes messages to EventSource instance.\r
            </summary>\r
            <remarks>\r
            On Windows platforms EventSource will deliver messages using Event Tracing for Windows (ETW) events.\r
            On Linux EventSource will use LTTng (http://lttng.org) to deliver messages.\r
            </remarks>\r
        </member>\r
        <member name="T:Microsoft.Extensions.Logging.EventSource.EventSourceLogger.ActivityScope">\r
            <summary>\r
            ActivityScope is just a IDisposable that knows how to send the ActivityStop event when it is\r
            desposed.  It is part of the BeginScope() support.\r
            </summary>\r
        </member>\r
        <member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLogger.GetExceptionInfo(System.Exception)">\r
            <summary>\r
            'serializes' a given exception into an ExceptionInfo (that EventSource knows how to serialize)\r
            </summary>\r
            <param name="exception">The exception to get information for.</param>\r
            <returns>ExceptionInfo object represending a .NET Exception</returns>\r
            <remarks>ETW does not support a concept of a null value. So we use an un-initialized object if there is no exception in the event data.</remarks>\r
        </member>\r
        <member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLogger.GetProperties(System.Object)">\r
            <summary>\r
            Converts an ILogger state object into a set of key-value pairs (That can be send to a EventSource)\r
            </summary>\r
        </member>\r
        <member name="T:Microsoft.Extensions.Logging.EventSource.EventSourceLoggerProvider">\r
            <summary>\r
            The provider for the <see cref="T:Microsoft.Extensions.Logging.EventSource.EventSourceLogger"/>.\r
            </summary>\r
        </member>\r
        <member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLoggerProvider.#ctor(Microsoft.Extensions.Logging.EventSource.LoggingEventSource)">\r
            <inheritdoc />\r
        </member>\r
        <member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLoggerProvider.CreateLogger(System.String)">\r
            <inheritdoc />\r
        </member>\r
        <member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLoggerProvider.Dispose">\r
            <inheritdoc />\r
        </member>\r
        <member name="T:Microsoft.Extensions.Logging.EventSource.ExceptionInfo">\r
            <summary>\r
            Represents information about exceptions that is captured by EventSourceLogger\r
            </summary>\r
        </member>\r
        <member name="T:Microsoft.Extensions.Logging.EventSource.LoggingEventSource">\r
             <summary>\r
             The LoggingEventSource is the bridge from all ILogger based logging to EventSource/EventListener logging.\r
            \r
             You turn this logging on by enabling the EventSource called\r
            \r
                  Microsoft-Extensions-Logging\r
            \r
             When you enabled the EventSource, the EventLevel you set is translated in the obvious way to the level\r
             associated with the ILogger (thus Debug = verbose, Informational = Informational ... Critical == Critical)\r
            \r
             This allows you to filter by event level in a straightforward way.\r
            \r
             For finer control you can specify a EventSource Argument called\r
            \r
             FilterSpecs\r
            \r
             The FilterSpecs argument is a semicolon separated list of specifications.   Where each specification is\r
            \r
             SPEC =                          // empty spec, same as *\r
                  | NAME                     // Just a name the level is the default level\r
                  | NAME : LEVEL            // specifies level for a particular logger (can have a * suffix).\r
            \r
             Where Name is the name of a ILoggger (case matters), Name can have a * which acts as a wildcard\r
             AS A SUFFIX.   Thus Net* will match any loggers that start with the 'Net'.\r
            \r
             The LEVEL is a number or a LogLevel string. 0=Trace, 1=Debug, 2=Information, 3=Warning,  4=Error, Critical=5\r
             This specifies the level for the associated pattern.  If the number is not specified, (first form\r
             of the specification) it is the default level for the EventSource.\r
            \r
             First match is used if a particular name matches more than one pattern.\r
            \r
             In addition the level and FilterSpec argument, you can also set EventSource Keywords.  See the Keywords\r
             definition below, but basically you get to decide if you wish to have\r
            \r
               * Keywords.Message - You get the event with the data in parsed form.\r
               * Keywords.JsonMessage - you get an event with the data in parse form but as a JSON blob (not broken up by argument ...)\r
               * Keywords.FormattedMessage - you get an event with the data formatted as a string\r
            \r
             It is expected that you will turn only one of these keywords on at a time, but you can turn them all on (and get\r
             the same data logged three different ways.\r
            \r
             Example Usage\r
            \r
             This example shows how to use an EventListener to get ILogging information\r
            \r
             class MyEventListener : EventListener {\r
                 protected override void OnEventSourceCreated(EventSource eventSource) {\r
                     if (eventSource.Name == "Microsoft-Extensions-Logging") {\r
                         // initialize a string, string dictionary of arguments to pass to the EventSource.\r
                         // Turn on loggers matching App* to Information, everything else (*) is the default level (which is EventLevel.Error)\r
                         var args = new Dictionary&lt;string, string&gt;() { { "FilterSpecs", "App*:Information;*" } };\r
                         // Set the default level (verbosity) to Error, and only ask for the formatted messages in this case.\r
                         EnableEvents(eventSource, EventLevel.Error, LoggingEventSource.Keywords.FormattedMessage, args);\r
                     }\r
                 }\r
                 protected override void OnEventWritten(EventWrittenEventArgs eventData) {\r
                     // Look for the formatted message event, which has the following argument layout (as defined in the LoggingEventSource.\r
                     // FormattedMessage(LogLevel Level, int FactoryID, string LoggerName, string EventId, string FormattedMessage);\r
                     if (eventData.EventName == "FormattedMessage")\r
                         Console.WriteLine("Logger {0}: {1}", eventData.Payload[2], eventData.Payload[4]);\r
                 }\r
             }\r
             </summary>\r
        </member>\r
        <member name="T:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords">\r
            <summary>\r
            This is public from an EventSource consumer point of view, but since these defintions\r
            are not needed outside this class\r
            </summary>\r
        </member>\r
        <member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords.Meta">\r
            <summary>\r
            Meta events are events about the LoggingEventSource itself (that is they did not come from ILogger\r
            </summary>\r
        </member>\r
        <member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords.Message">\r
            <summary>\r
            Turns on the 'Message' event when ILogger.Log() is called.   It gives the information in a programmatic (not formatted) way\r
            </summary>\r
        </member>\r
        <member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords.FormattedMessage">\r
            <summary>\r
            Turns on the 'FormatMessage' event when ILogger.Log() is called.  It gives the formatted string version of the information.\r
            </summary>\r
        </member>\r
        <member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords.JsonMessage">\r
            <summary>\r
            Turns on the 'MessageJson' event when ILogger.Log() is called.   It gives  JSON representation of the Arguments.\r
            </summary>\r
        </member>\r
        <member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Instance">\r
            <summary>\r
             The one and only instance of the LoggingEventSource.\r
            </summary>\r
        </member>\r
        <member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.FormattedMessage(Microsoft.Extensions.Logging.LogLevel,System.Int32,System.String,System.Int32,System.String,System.String)">\r
            <summary>\r
            FormattedMessage() is called when ILogger.Log() is called. and the FormattedMessage keyword is active\r
            This only gives you the human readable formatted message.\r
            </summary>\r
        </member>\r
        <member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Message(Microsoft.Extensions.Logging.LogLevel,System.Int32,System.String,System.Int32,System.String,Microsoft.Extensions.Logging.EventSource.ExceptionInfo,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})">\r
            <summary>\r
            Message() is called when ILogger.Log() is called. and the Message keyword is active\r
            This gives you the logged information in a programmatic format (arguments are key-value pairs)\r
            </summary>\r
        </member>\r
        <member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.ActivityStart(System.Int32,System.Int32,System.String,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})">\r
            <summary>\r
            ActivityStart is called when ILogger.BeginScope() is called\r
            </summary>\r
        </member>\r
        <member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.OnEventCommand(System.Diagnostics.Tracing.EventCommandEventArgs)">\r
            <inheritdoc />\r
        </member>\r
        <member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.SetFilterSpec(System.String)">\r
            <summary>\r
            Set the filtering specification.  null means turn off all loggers.   Empty string is turn on all providers.\r
            </summary>\r
            <param name="filterSpec">The filter specification to set.</param>\r
        </member>\r
        <member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.ParseFilterSpec(System.String,Microsoft.Extensions.Logging.LogLevel)">\r
             <summary>\r
             Given a set of specifications  Pat1:Level1;Pat1;Level2 ... Where\r
             Pat is a string pattern (a logger Name with a optional trailing wildcard * char)\r
             and Level is a number 0 (Trace) through 5 (Critical).\r
            \r
             The :Level can be omitted (thus Pat1;Pat2 ...) in which case the level is 1 (Debug).\r
            \r
             A completely empty string act like * (all loggers set to Debug level).\r
            \r
             The first specification that 'loggers' Name matches is used.\r
             </summary>\r
        </member>\r
        <member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.TryParseLevel(Microsoft.Extensions.Logging.LogLevel,System.String,Microsoft.Extensions.Logging.LogLevel@)">\r
            <summary>\r
            Parses the level specification (which should look like :N where n is a  number 0 (Trace)\r
            through 5 (Critical).   It can also be an empty string (which means 1 (Debug) and ';' marks\r
            the end of the specification. This specification should start at spec[curPos]\r
            It returns the value in 'ret' and returns true if successful.  If false is returned ret is left unchanged.\r
            </summary>\r
        </member>\r
        <member name="T:Microsoft.Extensions.Logging.EventSourceLoggerFactoryExtensions">\r
            <summary>\r
            Extension methods for the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> class.\r
            </summary>\r
        </member>\r
        <member name="M:Microsoft.Extensions.Logging.EventSourceLoggerFactoryExtensions.AddEventSourceLogger(Microsoft.Extensions.Logging.ILoggingBuilder)">\r
            <summary>\r
            Adds an event logger named 'EventSource' to the factory.\r
            </summary>\r
            <param name="builder">The extension method argument.</param>\r
            <returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>\r
        </member>\r
        <member name="T:Microsoft.Extensions.Logging.NullExternalScopeProvider">\r
            <summary>\r
            Scope provider that does nothing.\r
            </summary>\r
        </member>\r
        <member name="P:Microsoft.Extensions.Logging.NullExternalScopeProvider.Instance">\r
            <summary>\r
            Returns a cached instance of <see cref="T:Microsoft.Extensions.Logging.NullExternalScopeProvider"/>.\r
            </summary>\r
        </member>\r
        <member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#ForEachScope``1(System.Action{System.Object,``0},``0)">\r
            <inheritdoc />\r
        </member>\r
        <member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#Push(System.Object)">\r
            <inheritdoc />\r
        </member>\r
        <member name="T:Microsoft.Extensions.Logging.NullScope">\r
            <summary>\r
            An empty scope without any logic\r
            </summary>\r
        </member>\r
        <member name="M:Microsoft.Extensions.Logging.NullScope.Dispose">\r
            <inheritdoc />\r
        </member>\r
    </members>\r
</doc>\r