129 lines
8.9 KiB
HTML
129 lines
8.9 KiB
HTML
|
<?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="task" />
|
||
|
|
<meta name="DC.Title" content="User-defined categories in Collection Services" />
|
||
|
|
<meta name="abstract" content="The user-defined categories function in Collection Services enables applications to integrate performance data collection into Collection Services." />
|
||
|
|
<meta name="description" content="The user-defined categories function in Collection Services enables applications to integrate performance data collection into Collection Services." />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzahxcollectdatacs.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzahxcolluserdefprog.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzahxcollservuserdefexample.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/qypsregcoll.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/qypsderegcoll.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/qpmrtvactivemgtcolname.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/qpmrtvmgtcolattrs.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/qpmopenmgtcol.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/qpmclosemgtcol.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/qpmopenmgtcolrepo.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/qpmclosemgtcolrepo.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/qpmreadmgtcoldata.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/qypsacno.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/qypsrcno.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="rzahxcollservuserdef" />
|
||
|
|
<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 categories in Collection Services</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzahxcollservuserdef"><a name="rzahxcollservuserdef"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">User-defined categories in Collection Services</h1>
|
||
|
|
<div><p>The user-defined categories function in Collection Services enables
|
||
|
|
applications to integrate performance data collection into Collection Services.</p>
|
||
|
|
<div class="section"><p>This allows you to gather data from an application by writing
|
||
|
|
a data collection program, registering it, and integrating it with Collection
|
||
|
|
Services. Collection Services will then call the data collection program at
|
||
|
|
every collection interval, and will store the data in the collection object.
|
||
|
|
You should use the Collection Object APIs listed below to access the data
|
||
|
|
stored in the collection object. You may access the data in real-time, as
|
||
|
|
it is being collected, or for as long as the collection object is retained.</p>
|
||
|
|
<p>To
|
||
|
|
implement this function, you need to:</p>
|
||
|
|
</div>
|
||
|
|
<ol><li class="stepexpand"><span>Develop a program to collect performance data for a new category
|
||
|
|
in Collection Services.</span></li>
|
||
|
|
<li class="stepexpand"><span>Create a job description for your collection program. The job description
|
||
|
|
QPMUSRCAT in QGPL provides an example, but does not represent default values
|
||
|
|
or recommendations.</span></li>
|
||
|
|
<li class="stepexpand"><span>Register the new category and specify the data collection program.</span> <ul><li>Register: QypsRegCollectorDataCategory</li>
|
||
|
|
<li>De-register: QypsDeregCollectorDataCategory</li>
|
||
|
|
</ul>
|
||
|
|
<p>After you register the category, Collection Services includes it in
|
||
|
|
the list of available collection categories.</p>
|
||
|
|
</li>
|
||
|
|
<li class="stepexpand"><span>Add the category to your Collection Services profile, and then
|
||
|
|
cycle Collection Services</span></li>
|
||
|
|
<li class="stepexpand"><span>Develop a program to query the collection object.</span> <ul><li>Retrieve active management collection object name: QpmRtvActiveMgtcolName
|
||
|
|
(Used only for querying the collection object in real-time)</li>
|
||
|
|
<li>Retrieve management collection object attributes: QpmRtvMgtcolAttrs</li>
|
||
|
|
<li>Open management collection object: QpmOpenMgtcol</li>
|
||
|
|
<li>Close management collection object: QpmCloseMgtcol</li>
|
||
|
|
<li>Open management collection object repository: QpmOpenMgtcolRepo</li>
|
||
|
|
<li>Close management collection object repository: QpmCloseMgtcolRepo</li>
|
||
|
|
<li>Read management collection object data: QpmReadMgtcolData</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ol>
|
||
|
|
<div class="section"><p>Your customized collection program now runs at each collection
|
||
|
|
interval, and the collected data is archived in the collection objects.</p>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> By
|
||
|
|
using the code examples, you agree to the terms of the <a href="codedisclaimer.htm">Code license and disclaimer information</a>.</div>
|
||
|
|
<p>You
|
||
|
|
can also implement the Java™ versions of these APIs. The required Java classes
|
||
|
|
are included in ColSrv.jar, in the integrated file system (IFS) directory
|
||
|
|
QIBM/ProdData/OS400/CollectionServices/lib. Java applications should include this file
|
||
|
|
in their classpath. For more information about the Java implementation, download the <a href="colobj_Javadoc_zip.zip">javadocs</a> in a .zip file.</p>
|
||
|
|
<p><strong>Query the collection object in real-time</strong></p>
|
||
|
|
<p>If your application
|
||
|
|
needs to query the collection object in real-time, it will need to synchronize
|
||
|
|
the queries with Collection Services. To do this, the application should create
|
||
|
|
a data queue and register it with Collection Services. Once registered, the
|
||
|
|
collector sends a notification for each collection interval and for the end
|
||
|
|
of the collection cycle. The application should maintain the data queue, including
|
||
|
|
removing the data queue when finished, and handling abnormal termination.
|
||
|
|
To register and deregister the data queue, refer to the following API:</p>
|
||
|
|
<ul><li>Add collector notification: QypsAddCollectorNotification</li>
|
||
|
|
<li>Remove collector notification: QypsRmvCollectorNotification</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<ul class="ullinks">
|
||
|
|
<li class="ulchildlink"><strong><a href="rzahxcolluserdefprog.htm">Collection program recommendations and requirements</a></strong><br />
|
||
|
|
Collection Services calls the data collection program once during the start of a collection cycle, once for each collection interval, and again at the end of the collection cycle.</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzahxcollservuserdefexample.htm">Example: Implementing user-defined categories</a></strong><br />
|
||
|
|
Look here for sample programs that illustrate how you can use the provided APIs to integrate customized data collections 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="relref"><strong>Related reference</strong><br />
|
||
|
|
<div><a href="../apis/qypsregcoll.htm">QypsRegCollectorDataCategory API</a></div>
|
||
|
|
<div><a href="../apis/qypsderegcoll.htm">QypsDeregCollectorDataCategory API</a></div>
|
||
|
|
<div><a href="../apis/qpmrtvactivemgtcolname.htm">QpmRtvActiveMgtcolName API</a></div>
|
||
|
|
<div><a href="../apis/qpmrtvmgtcolattrs.htm">QpmRtvMgtcolAttrs API</a></div>
|
||
|
|
<div><a href="../apis/qpmopenmgtcol.htm">QpmOpenMgtcol API</a></div>
|
||
|
|
<div><a href="../apis/qpmclosemgtcol.htm">QpmCloseMgtcol API</a></div>
|
||
|
|
<div><a href="../apis/qpmopenmgtcolrepo.htm">QpmOpenMgtcolRepo API</a></div>
|
||
|
|
<div><a href="../apis/qpmclosemgtcolrepo.htm">QpmCloseMgtcolRepo API</a></div>
|
||
|
|
<div><a href="../apis/qpmreadmgtcoldata.htm">QpmReadMgtcolData API</a></div>
|
||
|
|
<div><a href="../apis/qypsacno.htm">QypsAddCollectorNotification API</a></div>
|
||
|
|
<div><a href="../apis/qypsrcno.htm">QypsRmvCollectorNotification API</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|