110 lines
4.2 KiB
HTML
110 lines
4.2 KiB
HTML
|
<?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::Controlling - Provides Controlling mechanisms to Kieker Modules</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="#_control___kieker__controlling__instance___">$control = Kieker::Controlling-><code>instance()</code>;</a></li>
|
||
|
|
<li><a href="#my__orderid____control__getorderindex__trace__">my $orderId = $control-><code>getOrderIndex($trace)</code>;</a></li>
|
||
|
|
<li><a href="#my__trace____control__gettrace___">my $trace = $control-><code>getTrace()</code>;</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::Controlling - Provides Controlling mechanisms to Kieker Modules</p>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a name="synopsis">SYNOPSIS</a></h1>
|
||
|
|
<pre>
|
||
|
|
use Kieker::Controlling;
|
||
|
|
my $control = Kieker::Controlling->instance(); # Get controlling instance</pre>
|
||
|
|
<pre>
|
||
|
|
my $trace = $control->getTrace(); # Get current traceID</pre>
|
||
|
|
<pre>
|
||
|
|
my $orderId = $control->getOrderIndex($trace); # Get current orderIndex</pre>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a name="description">DESCRIPTION</a></h1>
|
||
|
|
<p>This module provides controlling methods for Kieker. The main functions are
|
||
|
|
providing consistent trace and orderIDs. When new traces are created the
|
||
|
|
corresponding traceEvents are created and written.</p>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a name="methods">METHODS</a></h1>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<h2><a name="_control___kieker__controlling__instance___">$control = Kieker::Controlling-><code>instance()</code>;</a></h2>
|
||
|
|
<p>Returns the singleton instance of Kieker::Controlling. If no instance is defined
|
||
|
|
a new instance is created.</p>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<h2><a name="my__orderid____control__getorderindex__trace__">my $orderId = $control-><code>getOrderIndex($trace)</code>;</a></h2>
|
||
|
|
<p>Returns the current orderIndex and increments the count. If this is the first
|
||
|
|
request a new traceEvent is created and written to the log.</p>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<h2><a name="my__trace____control__gettrace___">my $trace = $control-><code>getTrace()</code>;</a></h2>
|
||
|
|
<p>Returns the current traceID. In this version it uses the threadID and relies on
|
||
|
|
special Apache configuration.</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 "Software"),
|
||
|
|
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 "AS IS", 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>
|