Author: jaredmorgs
Date: 2012-06-18 21:10:51 -0400 (Mon, 18 Jun 2012)
New Revision: 8727
Added:
epp/docs/branches/5.2/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml
epp/docs/branches/5.2/Admin_Guide/en-US/images/GateIn-RHQ-Plugin.png
Log:
https://bugzilla.redhat.com/show_bug.cgi?id=803567 - Added GateIn JON Documentation as
Chapter 5. Referred back to JON docs for more information about JON usage
Added:
epp/docs/branches/5.2/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml
===================================================================
--- epp/docs/branches/5.2/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml
(rev 0)
+++
epp/docs/branches/5.2/Admin_Guide/en-US/chapter-5-Administration_and_Monitoring.xml 2012-06-19
01:10:51 UTC (rev 8727)
@@ -0,0 +1,98 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. -->
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []>
+<chapter id="Administration_and_Monitoring">
+ <title>Administration and Monitoring</title>
+ <para>JBoss Enterprise Portal Platform provides a JBoss Operations Network
plug-in (<firstterm>GateIn JON Plug-in</firstterm>) to assist with monitoring
the platform.</para>
+ <para>The plug-in captures portlet and site statistics. A different set of
statistics are collected depending on the context of each portlet. <xref
linkend="fig-GateIn_JON_Plug-in_Interface"/> shows the basic JON
interface.</para>
+ <figure id="fig-GateIn_JON_Plug-in_Interface">
+ <title>GateIn JON Plug-in Interface</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="660px"
fileref="images/GateIn-RHQ-Plugin.png"/>
+ </imageobject>
+ <textobject>
+ <para>Screenshot of the JON console view, with the Portlets and Sites views
expanded.</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <section id="AdministrationandMonitoring-Metrics">
+ <title>Metrics</title>
+ <para>The metrics collected by the GateIn JON Plug-in include Site and Portlet
statistics. Each portlet contains statistics relevant to the individual portlet, and one
additional Throughput statistic for site portlets. Refer to <xref
linkend="table-Site_and_Portlet_Statistics"/> for a description of the
available metrics.</para>
+ <table id="table-Site_and_Portlet_Statistics">
+ <title>Site and Portlet Statistics</title>
+ <tgroup cols="2">
+ <thead>
+ <colspec colname="c1"/>
+ <colspec colname="c2"/>
+ <row>
+ <entry>
+ <para>Metric</para>
+ </entry>
+ <entry>
+ <para>Description</para>
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>Average Execution Time</para>
+ </entry>
+ <entry>
+ <para>The average execution time in seconds for a page or portlet to
render within a site.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Execution Count</para>
+ </entry>
+ <entry>
+ <para>The amount of times the portlet or site has been
accessed.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Maximum Execution Time</para>
+ </entry>
+ <entry>
+ <para>The maximum execution time in seconds for a page or portlet to
render within a site.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Minimum Execution Time</para>
+ </entry>
+ <entry>
+ <para>The minimum execution time in seconds for a page or portlet to
render within a site.</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Throughput (only for site portlets)</para>
+ </entry>
+ <entry>
+ <para>The number of requests per second for a site.</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ <section id="Administration_and_Monitoring-Operations">
+ <title>Operations</title>
+ <para>The GateIn JON Plug-in itself does not provide any operations;
it's sole purpose is reporting and statistics relating to portlets and sites. The
JBoss Operations Network AS plug-in does support many management operations, and is
included in JBoss Enterprise Portal Platform binaries. With the AS plug-in, the following
non-exhaustive list of actions are possible:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Server control: start, stop, restart.</para>
+ </listitem>
+ <listitem>
+ <para>Application control: deploy, and remove EAR and WAR
applications.</para>
+ </listitem>
+ <listitem>
+ <para>Resource control: manage other components of the platform, such as
datasources.</para>
+ </listitem>
+ </itemizedlist>
+ <para>For detailed information about JBoss Operations Network, and how it can
be used to manage platforms, refer to the JBoss Operations Network <citetitle>How to
Manage JBoss Servers</citetitle> guide available from <ulink
url="http://docs.redhat.com/docs/en-US/JBoss_Operations_Network/inde...
+ </section>
+</chapter>
Added: epp/docs/branches/5.2/Admin_Guide/en-US/images/GateIn-RHQ-Plugin.png
===================================================================
(Binary files differ)
Property changes on: epp/docs/branches/5.2/Admin_Guide/en-US/images/GateIn-RHQ-Plugin.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream