nbw-bt/Umsetzung/Perl/Kieker.htm

111 lines
4.1 KiB
HTML
Raw Permalink Normal View History

<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Kieker - wraps Kieker Monitoring functions</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body style="background-color: white">
<!-- INDEX BEGIN -->
<div name="index">
<p><a name="__index__"></a></p>
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#description">DESCRIPTION</a></li>
<li><a href="#methods">METHODS</a></li>
<ul>
<li><a href="#_object___kieker__new__">$object = Kieker-&gt;<code>new()</code></a></li>
<li><a href="#_object__entryevent__functionname___packagename__">$object-&gt;EntryEvent($functionName, $packageName);</a></li>
<li><a href="#_object__exitevent__functionname___packagename__">$object-&gt;ExitEvent($functionName, $packageName);</a></li>
</ul>
<li><a href="#bugs">BUGS</a></li>
<li><a href="#copyright_and_licence">COPYRIGHT and LICENCE</a></li>
</ul>
<hr name="index" />
</div>
<!-- INDEX END -->
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>Kieker - wraps Kieker Monitoring functions</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<pre>
use Kieker;
my $kieker = Kieker-&gt;new(); # Creates a new monitoring instance</pre>
<pre>
$kieker-&gt;EntryEvent('Foo','Bar'); # Produces a new EntryEvent</pre>
<pre>
$kieker-&gt;ExitEvent('Foo','Bar'); # Produces a new ExitEvent</pre>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p>This module encapsulates the Kieker monitoring functions in one module. Upon
creation the controlling and writing parts are loaded and the singleton
instances are stored.
After that Events can be constructed and written to the active writer.</p>
<p>
</p>
<hr />
<h1><a name="methods">METHODS</a></h1>
<p>
</p>
<h2><a name="_object___kieker__new__">$object = Kieker-&gt;<code>new()</code></a></h2>
<p>Creates a new Kieker object. Currently takes no parameters for configuration.
Returns the object.</p>
<p>
</p>
<h2><a name="_object__entryevent__functionname___packagename__">$object-&gt;EntryEvent($functionName, $packageName);</a></h2>
<p>Creates and sends out a EntryEvent for a specified functionName in a specified
package. Uses the current timestamp. Returns nothing.</p>
<p>
</p>
<h2><a name="_object__exitevent__functionname___packagename__">$object-&gt;ExitEvent($functionName, $packageName);</a></h2>
<p>Creates and sends out a ExitEvent for a specified functionName in a specified
package. Uses the current timestamp. Returns nothing.</p>
<p>
</p>
<hr />
<h1><a name="bugs">BUGS</a></h1>
<p>The package is probably full of bugs and is likely to break on every possible
occasion. If you find any please let me know via email.</p>
<p>
</p>
<hr />
<h1><a name="copyright_and_licence">COPYRIGHT and LICENCE</a></h1>
<p>Copyright 2013 Nis Börge Wechselberg, Kiel, Germany, <a href="mailto:nbw@informatik.uni-kiel.de">nbw@informatik.uni-kiel.de</a></p>
<p>The MIT License (MIT)</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the &quot;Software&quot;),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.</p>
</body>
</html>