Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

Logging sample

This sample shows how to use the Logging APIs in the Windows.Foundation.Diagnostics namespace, including LoggingChannel, LoggingActivity, LoggingSession, and FileLoggingSession. These classes are designed for diagnostic logging within a modern application. These APIs were added in Windows 8.1. The LoggingChannel and LoggingActivity APIs have been extended in Windows 10 to support writing complex events using TraceLogging event encoding.

  • LoggingChannel: The LoggingChannel class is used to generate events. The core LoggingChannel APIs can create simple events - events with a name and a string value, or events with a name, a string value, and an integer value. Starting with Windows 10, the LoggingChannel class can use TraceLogging event encoding to create complex events with arbitrary structured data.
  • LoggingActivity: The LoggingActivity class is used to encapsulate an activity by writing a Start event when the activity is created and a Stop event when the activity is closed. Starting with Windows 10, the LoggingActivity class can use TraceLogging event encoding to write complex events associated with the activity and to support nested activities.
  • LoggingSession: The LoggingSession class captures events into an in-memory circular buffer with the ability to save the buffer contents to a log file on-demand.
  • FileLoggingSession: The FileLoggingSession class captures events directly to a sequence of log files, switching to a new log file when the maximum file size is reached.

The Logging classes are based on Windows ETW APIs. Events from these classes can be captured using ETW tools such as xperf. The log files are generated in ETL format so they can be viewed and processed by the Windows Performance Toolkit (WPT), as well as utilities such as tracerpt.exe or xperf.exe.

Note The Windows universal samples require Visual Studio 2015 to build and Windows 10 to execute.

To obtain information about Windows 10 development, go to the Windows Dev Center

To obtain information about Microsoft Visual Studio 2015 and the tools for developing Windows apps, go to Visual Studio 2015

Related topics

Samples

Logging Sample

Reference

LoggingChannel

LoggingActivity

LoggingSession

FileLoggingSession

System requirements

Client: Windows 10

Server: Windows Server 2016 Technical Preview

Phone: Windows 10

Build the sample

  1. If you download the samples ZIP, be sure to unzip the entire archive, not just the folder with the sample you want to build.
  2. Start Microsoft Visual Studio 2015 and select File > Open > Project/Solution.
  3. Starting in the folder where you unzipped the samples, go to the Samples subfolder, then the subfolder for this specific sample, then the subfolder for your preferred language (C++, C#, or JavaScript). Double-click the Visual Studio 2015 Solution (.sln) file.
  4. Press Ctrl+Shift+B, or select Build > Build Solution.

Run the sample

The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it.

Deploying the sample

  • Select Build > Deploy Solution.

Deploying and running the sample

  • To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging.