ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzahx_5.4.0.1/rzahxcollservusertran.htm

121 lines
8.4 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="concept" />
<meta name="DC.Title" content="User-defined transactions" />
<meta name="abstract" content="Collection Services and performance explorer collect performance data that you define in your applications." />
<meta name="description" content="Collection Services and performance explorer collect performance data that you define in your applications." />
<meta name="DC.Relation" scheme="URI" content="rzahxcollectdatacs.htm" />
<meta name="DC.Relation" scheme="URI" content="rzahxcollservusertranexcplus.htm" />
<meta name="DC.Relation" scheme="URI" content="rzahxcollservusertranexjava.htm" />
<meta name="DC.Relation" scheme="URI" content="../apis/qypestrt.htm" />
<meta name="DC.Relation" scheme="URI" content="../apis/qypeendt.htm" />
<meta name="DC.Relation" scheme="URI" content="../apis/qypelogt.htm" />
<meta name="DC.Relation" scheme="URI" content="../apis/qypeaddt.htm" />
<meta name="DC.Relation" scheme="URI" content="rzahxqapmusrtns.htm" />
<meta name="DC.Relation" scheme="URI" content="rzahxpexparent.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 1998, 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1998, 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzahxcollservusertran" />
<meta name="DC.Language" content="en-us" />
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>User-defined transactions</title>
</head>
<body id="rzahxcollservusertran"><a name="rzahxcollservusertran"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">User-defined transactions</h1>
<div><p>Collection Services and performance explorer collect performance
data that you define in your applications.</p>
<p>With the provided APIs, you can integrate transaction data into the regularly
scheduled sample data collections using Collection Services, and get trace-level
data about your transaction by running performance explorer.</p>
<p>For detailed descriptions and usage notes, refer to the following API descriptions:</p>
<ul><li>Start transaction: QYPESTRT, qypeStartTransaction API</li>
<li>End transaction: QYPEENDT, qypeEndTransaction API</li>
<li>Log transaction: QYPELOGT, qypeLogTransaction API (Used only by performance
explorer)</li>
<li>Add trace point: QYPEADDT, qypeAddTracePoint API (Used only
by performance explorer)</li>
</ul>
<div class="note"><span class="notetitle">Note:</span> You only need to instrument your application once. Collection Services
and performance explorer use the same API calls to gather different types
of performance data.</div>
<div class="section"><h4 class="sectiontitle">Integrating user-defined transaction data into Collection
Services</h4><p>You can select user-defined transactions as a category
for collection in the Collection Services configuration. Collection Services
then collects the transaction data at every collection interval and stores
that data in the collection object. The <span class="cmdname">Create Performance Data (CRTPFRDTA)</span> command
exports this data to the user-defined transaction performance database file,
QAPMUSRTNS. Collection Services organizes the data by transaction type. You
can specify as many transaction types as you require; however, Collection
services will only report the first fifteen transaction types. Data for additional
transaction types is combined and stored as a *OTHER transaction type. At
every collection interval, Collection Services creates one record for each
type of transaction for each unique job. For a detailed description, refer
to the usage notes in the Start transaction API.</p>
<p>Collection Services
gathers general transaction data, such as the transaction response time. You
can also include up to 16 optional application-defined counters that can track
application specific data like the number of SQL statements used for the transaction,
or other incremental measurements. Your application should use the Start transaction
API to indicate the beginning of a new transaction, and should include a corresponding
End transaction API to deliver the transaction data to Collection Services.</p>
</div>
<div class="section"><h4 class="sectiontitle">Collecting trace information for user-defined transactions
with performance explorer</h4><p>You can use the start, end, and log transaction
APIs during a performance explorer session to create a trace record. Performance
Explorer stores system resource utilization, such as CPU utilization, I/O
and seize/lock activity, for the current thread in these trace records. Additionally,
you may choose to include application-specific performance data, and then
send it to performance explorer in each of these APIs. You can also use the
add trace point API to identify application-specific events for which performance
explorer should collect trace data.</p>
<p>To start a performance explorer
session for your transactions, specify *USRTRNS on the (OSEVT) parameter of
your Performance Explorer definition. After entering the ENDPEX command, performance
explorer writes the data supplied by the application to the QMUDTA field in
the QAYPEMIUSR performance explorer database file. System-supplied performance
data for the start, end, and any log records is stored in the QAYPEMIUSR and
QAYPETIDX database files.</p>
</div>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="rzahxcollservusertranexcplus.htm">C++ example: Integrating user-defined transactions into Collection Services</a></strong><br />
This C++ example program shows how to use the Start transaction and End transaction APIs to integrate user-defined transaction performance data into Collection Services.</li>
<li class="ulchildlink"><strong><a href="rzahxcollservusertranexjava.htm">Java example: Integrating user-defined transactions into Collection Services</a></strong><br />
This Java™ example program shows how to use the Start transaction
and End transaction APIs to integrate user-defined transaction performance
data into Collection Services.</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzahxcollectdatacs.htm" title="Use Collection Services to collect performance data for later analysis by the Performance Tools for iSeries licensed program or other performance report applications, iSeries Navigator monitors, and the graph history function. (If you prefer viewing real-time performance data, system monitors provide an easy-to-use graphical interface for monitoring system performance.)">Collection Services</a></div>
</div>
<div class="relconcepts"><strong>Related concepts</strong><br />
<div><a href="rzahxpexparent.htm" title="Collects more detailed information about a specific application, program or system resource, and provides detailed insight into a specific performance problem. This includes the capability both to perform several types and levels of traces and to run detailed reports.">Performance explorer</a></div>
</div>
<div class="relref"><strong>Related reference</strong><br />
<div><a href="../apis/qypestrt.htm">QYPESTRT, qypeStartTransaction API</a></div>
<div><a href="../apis/qypeendt.htm">QYPEENDT, qypeEndTransaction API</a></div>
<div><a href="../apis/qypelogt.htm">QYPELOGT, qypeLogTransaction API</a></div>
<div><a href="../apis/qypeaddt.htm">QYPEADDT, qypeAddTracePoint API</a></div>
</div>
<div class="relinfo"><strong>Related information</strong><br />
<div><a href="rzahxqapmusrtns.htm">Performance data files: QAPMUSRTNS</a></div>
</div>
</div>
</body>
</html>