Using Instrumentation And Troubleshooting To Develop High-Q PowerPoint Presentation, PPT - DocSlides

Using Instrumentation And Troubleshooting To Develop High-Quality Software

 Ricky Buch Program Manager Microsoft Corporation

 Kevin Michael Woley Program Manager Microsoft Corporation

PC50

Solving software problems in Windows Instrumentation and Troubleshooting platformWindows InstrumentationEvent and Counter platformWindows 7 improvementsDesign principlesWindows TroubleshootingKey FeaturesArchitectureDeployment

Agenda

When software is inconsistent with expectationsWhy are software problems bad?Lower customer satisfactionReduced profitSoftware problems can be caused byDesign IssuesConfiguration conflicts

Software Problems

Address in standard, structured wayMinimize development costProgrammatic analysisEnable problem detection and resolutionWindows provides two platforms that address above criteriaInstrumentation PlatformTroubleshooting Platform

Solving Software Problems

Windows Instrumentation: Performance Counters And Events

Kevin Michael

Woley

Program Manager

Microsoft Corporation

The purpose of instrumentationDiagnose and debug problemsManage and maintain softwareInstrumentation is used byDevelopersEx: Measuring performance of an applicationSystem administrators and IT ProfessionalsEx: Determining system workload characteristics

Instrumentation Overview

Instrumentation exposes internal OS and application state

in a discoverable, easily consumable, standardized way

Key FeaturesHigh-performance, low overhead, highly scalableNative and Managed APIsDynamic enablement of data collectionData delivered in real-time or persisted in files

Windows Instrumentation

Performance CountersEventsExample UsagesExpose processing ratesMeasure performanceGeneral notificationsErrors and warningsTrace actions for debuggingData TypesStrictly NumericalNo restrictionData ConsumptionPolled in real-timeWritten to a log fileDelivered in real-timeWritten to a log fileBuffered in memory

Applications can make use of

both

Performance Counters and Events

Instrumentation Consumption

Kevin Michael Woley

demo

Event AudienceDeveloperDeveloper; IT ProfessionalSystem AdministratorTechnologyWPPETWEvent LogEvent ControlManualManualAlways OnMax Event RateHigh (10^4 / sec)High (10^4 / sec)Medium (10^2 - 10^4 / sec)Features Easy Implementation Requires symbol-like files to decode Declaratively defined in manifests Programmatic Consumption Discoverability Localizable Strings Flexible Data Model Higher dev cost than WPPSame Features of ETW plus: Remote Collection Data Query Support Inbox Tool Support Centralized event logs Reduced logging rate

Windows Event Overview

Common API Set and Development Model

Windows 7 Instrumentation Improvements

New Version 2.0 Kernel Mode APIsDeclaratively defined in XMLLeverages Version 2.0 infrastructure from VistaFundamental Quality InvestmentsEnhanced performance, scalability, and robustnessSeveral new system counters exposing Windows internalsImproved design-time validationScriptable Consumption using PowerShellConsume live counters (get-counter)Read and write counter log files (import-counter/export-counter)

Performance Counter

Improvements In Windows 7

Fundamental Quality InvestmentsEnhanced performance, scalability, and robustnessSeveral new Windows events and event providersEvent DevelopmentImproved design-time validationAutomatically generate code from XMLEvent ConsumptionScriptable consumption using PowerShell (get-event)Discover and read ETW or Eventlog events locally or remotelyPortable event log file decodingImproved data formattingWindows Performance Toolkit Improvements

ETW/Event Log

Improvements In Windows 7

Instrumentation Implementation

And Design

Design for the appropriate audienceProvide meaningful event messages and counter descriptionsProvide actionable events and counters for System Administrators and IT ProfessionalsUse recommended interfacesPerformance Counters Version 2.0Managed – System.Diagnostics.PerformanceDataUser Mode – PerfSet*(), PerfIncrement*(), etc.Kernel Mode – PcwRegister(), PcwCreateInstance(), etc.Manifest-based ETW and Event Log APIsManaged – System.Diagnostics.EventingUser Mode – EventWrite(), etc.Kernel Mode – EtwWrite(), etc.

Instrumentation Design Considerations

Design your application’s events and counters with a goal in mind

Windows Instrumentation Design Workflow

Design

1

Design

Create

Instrumentation

Manifest (ECMangen)

XML Manifest

2

Instrumentation

Definition

CTRPP / MC

preprocessors

.

rc

.c

.h

3

Generate

Code

Instrument

provider APIs

New

provider

code

4

Instrument

Build

New

Provider

5

Build

5

Steps

Win7:

Event Logging Code Generation & Improved Manifest Validation

Instrumentation Implementation

Kevin Michael Woley

demo

Windows Troubleshooting

Ricky Buch

Program Manager

Microsoft Corporation

Automating Troubleshooting

Spend less time fixing problemsDeflect calls or reduce minutes-per-incidentDifferent types of software problemsDesign issuesConfiguration conflictsTroubleshooting configurationVerify if desired user state can be supportedSet configuration to support desired state

Windows 7 Troubleshooting Approach

Troubleshooting is the process of detecting and resolving a problem

Windows 7 troubleshoots configuration problems using Troubleshooting PacksA Troubleshooting Pack is a program thatLaunched by the user or an applicationDetects and resolves configuration issuesVerifies that configuration has been set properly

Windows 7 Troubleshooting Implementation

Troubleshooting

Packs detect and resolve configuration problems

Troubleshooting Pack – UI

Ricky Buch

demo

Easy to DiscoverInbox or online help documentationWindows Troubleshooting InterfaceSimple to ExecuteEach pack uses a standard wizard user interfaceSingle-click problem resolutionSecureSigned by a certificate to ensure pack integrity

End-User

Troubleshooting Features

Easy to DeployDeploy as .cab files onto a file share or websiteFlexible ExecutionRun interactively or in unattended modeRun on local or remote machinesSecureSigned by a certificate to ensure pack integrityGroup Policy can control which packs can execute

System-Administrator Troubleshooting Features

Troubleshooting Pack – PowerShell

Ricky Buch

demo

Easy to DevelopPacks use Windows PowerShellDetection, resolution and verification codeCapturing user input and relaying progressCan be deployed with applicationSimple to DebugErrors and exceptions from PowerShell scripts captured in a debug reportSecureSigned by a certificate to ensure pack integrity

Developer

Troubleshooting Features

Troubleshooting Pack consists of metadata and script files

Troubleshooting Platform executes the

Troubleshooting PackLeverages the PowerShell runtime to execute scriptsInteracts with the GUI or command-lineGenerates reports for analysis

Architecture Overview

Trouble-shooting Packs

Troubleshooting Platform

PowerShell

GUI

Reports

CMD

Diagram Of A Troubleshooting Pack

Identification Metadata

Resolution Scripts

Verification Scripts

Localized Resources

Trouble-shooting Pack

Name and description

List of configuration issues Security signature Checks current configuration with expected configuration Sets the current configuration to what is expectedVerifies that current configuration is now what is expected Contains localized display strings in MUI format

Detection Scripts

Diagram Of Component Interaction

Troubleshooting Platform

PowerShell Runtime

Reports

GUI

CMD

Identification Metadata

Detection Scripts

Resolution Scripts

Verification Scripts

Localized Resources

Detect a problem

Get input from user

Provide progress

Write to the report

Identify configuration issuesDevelop troubleshooting PowerShell scriptsTroubleshooting toolkitGraphical authoring environment Links to Graphical PowerShell editorSigns each pack with a certificatePackages the Troubleshooting Pack for deployment

Authoring Troubleshooting Packs

Troubleshooting Pack Authoring

Ricky Buch

demo

Windows willShip critical packs inboxTarget additional packs using Windows Online Troubleshooting ServiceYou shouldShip troubleshooting packs with your client softwarePost troubleshooting packs onlineLink to packs from your help documentation

Deploying Troubleshooting Packs

Troubleshooting Packs offer multiple deployment options.

Conclusion

Windows Instrumentation and Troubleshooting Platforms provideCentralized, standard, structured platforms to improve manageabilityConsistent ways to debug and diagnose software problemsDetection and resolution of configuration problems

Solving Software Problems

Review and revise your existing debugging techniquesAdd or upgrade existing debug messages with the appropriate Windows Event or Performance Counter technologiesReview “An Overview of Windows Troubleshooting” whitepaperDevelop and deploy an appropriate troubleshooting pack with your application

Call To Action

Additional software quality sessions on videoDriving for software quality through customer feedbackDeveloping compatible applications for WindowsHands On Analysis with Windows Performance ToolkitBest practices for signing and verifying code on Windows 7Meet us at the Windows Fundamentals booth!

Related Content

Evals & Recordings

Please fill

out your evaluation for this session at:

This session will be available as

a recording at:

www.microsoftpdc.com

Please use the microphones provided

Q

&

A

© 2008 Microsoft Corporation. All rights reserved. Microsoft, Windows, Windows Vista and other product names are or may be registered trademarks and/or trademarks in the U.S. and/or other countries.

The information herein is for informational purposes only and represents the current view of Microsoft Corporation as of the date of this presentation. Because Microsoft must respond to changing market conditions, it should not be interpreted to be a commitment on the part of Microsoft, and Microsoft cannot guarantee the accuracy of any information provided after the date of this presentation. MICROSOFT MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN THIS PRESENTATION.