<?xml version="1.0" encoding="UTF-8"?>
<!--
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  - JASMINe
  - Copyright (C) 2012 Bull S.A.S.
  - Contact: jasmine@ow2.org
  -
  - This library is free software; you can redistribute it and/or
  - modify it under the terms of the GNU Lesser General Public
  - License as published by the Free Software Foundation; either
  - version 2.1 of the License, or any later version.
  -
  - This library is distributed in the hope that it will be useful,
  - but WITHOUT ANY WARRANTY; without even the implied warranty of
  - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  - Lesser General Public License for more details.
  -
  - You should have received a copy of the GNU Lesser General Public
  - License along with this library; if not, write to the Free Software
  - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
  - USA
  -
  -
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  - $Id$
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-->
<sect3 version="5.0" xml:lang="en" xml:id="jasmineprobe.indicator_types" xmlns="http://docbook.org/ns/docbook"
  xmlns:xlink="http://www.w3.org/1999/xlink"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xmlns:svg="http://www.w3.org/2000/svg"
  xmlns:mml="http://www.w3.org/1998/Math/MathML"
  xmlns:html="http://www.w3.org/1999/xhtml"
  xmlns:db="http://docbook.org/ns/docbook">

    <title>
      Indicator types
    </title>
    <para>
      Several raw indicator types are provided by JASMINe Probe.
    </para>
    <para>
      Raw indicator types are characterized by the technique used to collect the monitoring data:
      <itemizedlist>
       <listitem>
         <para><emphasis role="bold">jmx</emphasis>: use JMX to get monitoring data from MBeans registered in the target's MBean server.</para>
       </listitem>
       <listitem>
         <para><emphasis role="bold">df</emphasis>: allows to get data about file system disk availability (in p.c.); based on the Unix <emphasis>df</emphasis> command</para>
       </listitem>
       <listitem>
         <para><emphasis role="bold">lewys</emphasis>: allows to get different kind of system resource parameters (disk, memory, cpu, network); its based on lewys commands (see ..?..)</para>
       </listitem>
     </itemizedlist>
    </para>

    <para>
      Processing indicators are characterized by the <emphasis>processing operation</emphasis> and the <emphasis>source indicators</emphasis>:
      <itemizedlist>
       <listitem>
         <para><emphasis role="bold">aggregate</emphasis>: aggregates a source indicator's values</para>
       </listitem>
       <listitem>
         <para><emphasis role="bold">correlate</emphasis>: correlates several source indicators' value</para>
       </listitem>
       <listitem>
         <para><emphasis role="bold">derived</emphasis>: get a new value from a given source indicator's value ; several derived operations exist,
         as for example <emphasis>delta</emphasis>, that implements delta(v) = current(v) - previous(v), where <emphasis>v</emphasis> is the source indicator's value
         </para>
       </listitem>
       <listitem>
         <para><emphasis role="bold">slope</emphasis>: calculates slope value from two source values (delta(s1) / delta(s2) where s1 and s2 are the two source indicators)</para>
       </listitem>
     </itemizedlist>
    </para>

    <para>
      Constant indicators are characterized by their value and type.
    </para>

    <para>
      The list of the available indicator types,
      and the description of properties to be provided when defining an indicator of a given type, can be obtained using JASMINe Probe management operations (see <xref linkend="jasmineprobe.manage"/>).
    </para>
</sect3>
