HP Caliper Advisor Rule Writer Guide

About This Document

This document describes how to use the HP Caliper Advisor to write your own

performance rules.

NOTE: For the latest version of this document, go to the HP Caliper Web site at the

following URL and click on Documentation in the Product Information box:

http://hp.com/go/caliper

Intended Audience

This document is written for software developers who are using HP Caliper and want

to write their own performance rules to be used by the HP Caliper Advisor. This Guide

assumes that you are familiar with HP Caliper.

If you merely want to run the Advisor to get advice for your applications, you do not

need to use this document.

Document Organization

This Guide contains the following chapters and appendixes:

• “Overview: HP Caliper Advisor and Analysis Rules” (p. 13) provides a brief

introduction to the HP Caliper Advisor and introduces analysis rules.

• “Running the HP Caliper Advisor” (p. 19) helps you get started using the Advisor.

Note: All the information in this chapter pertains to users who will be running the

Advisor. It is a duplicate of some of the information in the chapter “Using the HP

Caliper Advisor” in the HP Caliper User Guide and is placed in this Guide for the

convenience of rule writers.

• “How the HP Caliper Advisor Works” (p. 27) explains in detail how the Advisor

works.

• “HP Caliper Advisor Accessor Functions” (p. 37) describes the Advisor accessor

functions.

• “HP Caliper Advisor Advice Function” (p. 53) describes the Advisor advice

function.

• “Writing Rules for the HP Caliper Advisor” (p. 57) gives tips on how to write

good rules for the Advisor.

• “Python Scripting Language: Overview” (p. 65) gives a brief summary of the

features of Python that are relevant to writing rules.

• “Function Reference Information” (p. 71) provides reference information about

the accessor functions in easily accessible table format.