Yahoo! Developer Network Home - Help

YDN Site Search

# YUI Library Examples: ProfilerViewer Control (beta): Using Profiler and ProfilerViewer to Profile non-YUI Code

# ProfilerViewer Control (beta): Using Profiler and ProfilerViewer to Profile non-YUI Code

The ProfilerViewer Control (and the Profiler that drives it) is code-agnostic: It can be used as easily to profile your own code or third-party code as it can to profile YUI modules. In this example, we use Profiler and ProfilerViewer to profile the DP Syntax Highlighter script that the YUI Project uses for code highlighting on our website.

To lighten the initial YUI footprint on the page (and minimize the impact of YUI on the script being profiled), this example takes the following steps:

1. YUI Loader and Profiler are loaded first, along with the script being profiled. By putting only a tiny amount of YUI code on the page, we should be able to run DP Syntax Highlighter without its performance being impacted much by YUI.
2. Once DP Syntax Highlighter has run, a button allows you to actuate ProfilerViewer, loading its dependencies on-demand in the process.

View example in new window.

## Profiling non-YUI Code with Minimal YUI Dependencies

In the introduction to this example, we note that the goal here is to profile non-YUI code while loading (at the outset) only the bare minimum of YUI components (YUI Loader and Profiler, in this case). By keeping the initial YUI footprint small, we can be sure that YUI iteslf is having the smallest possible impact on the code were looking at. So, in this example we load that minimal footprint, profile the code we want to test, and only then bring in YUI ProfilerViewer and its other YUI dependencies. This approach is a good one to take when you're profiling projects that are not based on YUI or where you want to minimize the impact ProfilerViewer could have on your profiling data.

Here's how we accomplish the steps outlined above. (Note: It's the script-based code-highlighting used below that's being profiled in this example.)

First, we load the minimal dependencies for profiling code with YUI Profiler. To that, we add the DP Syntax Highlighter code (ie, the code that we'll be profiling).

<link rel="stylesheet" type="text/css" href="assets/dpSyntaxHighlighter.css"> <script type="text/javascript" src="../../build/yuiloader/yuiloader-beta-min.js"></script> <script type="text/javascript" src="../../build/profiler/profiler-beta-min.js"></script> <script type="text/javascript" src="assets/dpSyntaxHighlighter.js"></script>

Next, we set up a simple initialization function that (a) sets up the code we want to profile then (b) executes the code:

YAHOO.example.pv.init = function() { //profile the Syntax Highlighter; note: we want to register the //object for profiling before we execute the highlighting code: YAHOO.tool.Profiler.registerConstructor("dp.sh.Highlighter"); YAHOO.tool.Profiler.registerObject("dpSyntaxHighlighter", dp, true); //Highlight code: dp.SyntaxHighlighter.HighlightAll('code'); }; YAHOO.example.pv.init();

At this point, we've told Profiler what parts of Syntax Highlighter we want profiled and we've then run Syntax Highlighter, capturing data about its performance. And we've done all this with the smallest possible amount of YUI code on the page. Note that Profiler is loaded now, but ProfilerViewer and all of the YUI infrastructure it leverages — like Element, DataTable and Charts — is still absent.

Now it's time to set up a button that brings in the YUI ProfilerViewer and all of its dependencies. That button executes the following code:

//When the showProfile button is clicked, use YUI Loader to get all required //dependencies and then show the profile: YAHOO.example.pv.showProfilerViewer = function() { //disable the button once it's clicked: document.getElementById("showProfile").onclick = ""; document.getElementById("showProfile").className += " disabled"; //private function renders the viewer once dependencies are loaded: var showViewer = function() { //instantiate ProfilerViewer with desired options: var pv = new YAHOO.widget.ProfilerViewer("", { visible: true, //expand the viewer mmediately after instantiation showChart: true, base:"../../build/", swfUrl: "../../build/charts/assets/charts.swf" }); }; //private function gets dependencies for ProfilerViewer: var getProfilerViewer = function() { var loader = new YAHOO.util.YUILoader({ base: "../../build/", require: ["profilerviewer"], //YUI Loader will handle all dependencies //for us. Nice! onSuccess: showViewer }); loader.insert(); }; //fire getProfilerViewer to trigger the loading and display of the viewer //console: getProfilerViewer(); };

You can use similar strategies to leverage YUI's Profiler and ProfilerViewer on your projects — even those that aren't based on YUI.

The full script souce for this example follows:

YAHOO.namespace("example.pv"); YAHOO.example.pv.init = function() { //profile the Syntax Highlighter; note: we want to register the //object for profiling before we execute the highlighting code: YAHOO.tool.Profiler.registerConstructor("dp.sh.Highlighter"); YAHOO.tool.Profiler.registerObject("dpSyntaxHighlighter", dp, true); //Highlight code: dp.SyntaxHighlighter.HighlightAll('code'); }; //When the showProfile button is clicked, use YUI Loader to get all required //dependencies and then show the profile: YAHOO.example.pv.showProfilerViewer = function() { //disable button: document.getElementById("showProfile").onclick = ""; document.getElementById("showProfile").className += " disabled"; //private function renders the viewer once dependencies are loaded: var showViewer = function() { //instantiate ProfilerViewer with desired options: var pv = new YAHOO.widget.ProfilerViewer("", { visible: true, //expand the viewer mmediately after instantiation showChart: true, base:"../../build/", swfUrl: "../../build/charts/assets/charts.swf" }); }; //private function gets dependencies for ProfilerViewer: var getProfilerViewer = function() { var loader = new YAHOO.util.YUILoader({ base: "../../build/", require: ["profilerviewer"], //YUI Loader will handle all dependencies //for us. Nice! onSuccess: showViewer }); loader.insert(); }; //fire getProfilerViewer to trigger the loading and display of the viewer //console: getProfilerViewer(); }; YAHOO.example.pv.init();

### ProfilerViewer Control (beta) Examples:

- Simple Profiling
- Using the ProfilerViewer API while Profiling the YUI Menu Control
- Using Profiler and ProfilerViewer to Profile non-YUI Code
- Skinning the ProfilerViewer Control
- ProfilerViewer Internationalization: Spanish
- ProfilerViewer Internationalization: German

### More ProfilerViewer Control (beta) Resources:

- User's Guide (external)
- API Documentation
- Cheat Sheet PDF (external)

Copyright © 2008 Yahoo! Inc. All rights reserved.

Privacy Policy - Terms of Service - Copyright Policy - Job Openings