Author: smumford
Date: 2010-10-20 21:53:21 -0400 (Wed, 20 Oct 2010)
New Revision: 13974
Added:
docs/enterprise/trunk/Tuning_Guide/en-US/Revision_History.xml
docs/enterprise/trunk/Tuning_Guide/en-US/Tuning_Guide.ent
docs/enterprise/trunk/Tuning_Guide/publican.cfg
Modified:
docs/enterprise/trunk/Tuning_Guide/en-US/Author_Group.xml
docs/enterprise/trunk/Tuning_Guide/en-US/Book_Info.xml
docs/enterprise/trunk/Tuning_Guide/en-US/Feedback.xml
docs/enterprise/trunk/Tuning_Guide/en-US/Preface.xml
docs/enterprise/trunk/Tuning_Guide/en-US/Tuning_Guide.xml
docs/enterprise/trunk/Tuning_Guide/en-US/clustering.xml
docs/enterprise/trunk/Tuning_Guide/en-US/hibernate.xml
docs/enterprise/trunk/Tuning_Guide/en-US/identity.xml
docs/enterprise/trunk/Tuning_Guide/en-US/jbossweb.xml
docs/enterprise/trunk/Tuning_Guide/en-US/jvm.xml
docs/enterprise/trunk/Tuning_Guide/en-US/overview.xml
Log:
JBEPP-559: Added syntax highlighting and update for new publican version
Modified: docs/enterprise/trunk/Tuning_Guide/en-US/Author_Group.xml
===================================================================
--- docs/enterprise/trunk/Tuning_Guide/en-US/Author_Group.xml 2010-10-21 00:55:16 UTC (rev
13973)
+++ docs/enterprise/trunk/Tuning_Guide/en-US/Author_Group.xml 2010-10-21 01:53:21 UTC (rev
13974)
@@ -1,10 +1,13 @@
-<?xml version='1.0'?>
+<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Tuning_Guide.ent">
+%BOOK_ENTITIES;
]>
-
<authorgroup>
<author>
<firstname>Red Hat</firstname>
- <surname></surname>
+ <surname></surname>
+
</author>
</authorgroup>
+
Modified: docs/enterprise/trunk/Tuning_Guide/en-US/Book_Info.xml
===================================================================
--- docs/enterprise/trunk/Tuning_Guide/en-US/Book_Info.xml 2010-10-21 00:55:16 UTC (rev
13973)
+++ docs/enterprise/trunk/Tuning_Guide/en-US/Book_Info.xml 2010-10-21 01:53:21 UTC (rev
13974)
@@ -1,29 +1,37 @@
-<?xml version='1.0'?>
-<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Tuning_Guide.ent">
+%BOOK_ENTITIES;
]>
+<bookinfo id="book-Tuning_Guide-Tuning_Guide">
+ <title>Tuning Guide</title>
+ <edition>1</edition>
+ <pubsnumber>1.5</pubsnumber>
+ <productname>JBoss Enterprise Portal Platform</productname>
+ <productnumber>4.3</productnumber>
+ <pubdate>Jan, 2009</pubdate>
+ <isbn>N/A</isbn>
+ <abstract>
+ <para>
+ This Installation Guide documents tuning of JBoss Enterprise Portal Platform
+ </para>
-<bookinfo id="Tuning_Guide_JBoss_Enterprise_Portal_Platform">
- <title>Tuning Guide</title>
- <edition>1.0</edition>
- <pubsnumber>4</pubsnumber>
- <productname>JBoss Enterprise Portal Platform</productname>
- <productnumber>4.3</productnumber>
- <pubdate>Jan, 2009</pubdate>
- <isbn>N/A</isbn>
- <abstract><para>This Installation Guide documents tuning of JBoss Enterprise
Portal Platform</para>
</abstract>
- <corpauthor>
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="Common_Content/images/redhat-logo.svg" />
- </imageobject>
- </inlinemediaobject>
+ <corpauthor>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="Common_Content/images/redhat-logo.svg"
format="SVG" />
+ </imageobject>
+
+ </inlinemediaobject>
+
</corpauthor>
- <copyright>
+ <copyright>
<year>&YEAR;</year>
- <holder>&HOLDER;</holder>
+ <holder>&HOLDER;</holder>
+
</copyright>
- <xi:include href="Common_Content/Legal_Notice.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Author_Group.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Common_Content/Legal_Notice.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Author_Group.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</bookinfo>
Modified: docs/enterprise/trunk/Tuning_Guide/en-US/Feedback.xml
===================================================================
--- docs/enterprise/trunk/Tuning_Guide/en-US/Feedback.xml 2010-10-21 00:55:16 UTC (rev
13973)
+++ docs/enterprise/trunk/Tuning_Guide/en-US/Feedback.xml 2010-10-21 01:53:21 UTC (rev
13974)
@@ -1,21 +1,17 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Tuning_Guide.ent">
+%BOOK_ENTITIES;
]>
-
-<section id="sect-JBoss_Portlet_Bridge_Overview-We_Need_Feedback">
+<section id="sect-Tuning_Guide-We_Need_Feedback">
<title>We Need Feedback!</title>
- <indexterm>
+ <indexterm>
<primary>feedback</primary>
- <secondary>contact information for this manual</secondary>
+ <secondary>contact information for this manual</secondary>
+
</indexterm>
- <para>
- If you find a typographical error in this manual, or if you have thought of a way to
make this manual
- better, we would love to hear from you! Submit a report in <ulink
url="http://jira.jboss.com/jira/browse/JBEPP">JIRA</ulink...
- against the Version: <emphasis>&JBEPPVERS;</emphasis>, Component:
<emphasis>Documentation</emphasis>.
- When submitting a bug report, be sure to mention the manual's identifier:
Portal_User_Guide
- If you have a suggestion for improving the documentation, try to be as specific as
possible when
- describing it. If you have found an error, please include the section number and some
of the
- surrounding text so we can find it easily.
+ <para>
+ If you find a typographical error in this manual, or if you have thought of a way to
make this manual better, we would love to hear from you! Submit a report in <ulink
url="http://jira.jboss.com/jira/browse/JBEPP">JIRA</ulink... against the
Version: <emphasis>&JBEPPVERS;</emphasis>, Component:
<emphasis>Documentation</emphasis>. When submitting a bug report, be sure to
mention the manual's identifier: Portal_User_Guide If you have a suggestion for
improving the documentation, try to be as specific as possible when describing it. If you
have found an error, please include the section number and some of the surrounding text so
we can find it easily.
</para>
</section>
Modified: docs/enterprise/trunk/Tuning_Guide/en-US/Preface.xml
===================================================================
--- docs/enterprise/trunk/Tuning_Guide/en-US/Preface.xml 2010-10-21 00:55:16 UTC (rev
13973)
+++ docs/enterprise/trunk/Tuning_Guide/en-US/Preface.xml 2010-10-21 01:53:21 UTC (rev
13974)
@@ -1,13 +1,13 @@
-<?xml version='1.0'?>
+<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Tuning_Guide.ent">
+%BOOK_ENTITIES;
]>
-
-<preface id="Portal_User_Guide-Preface">
+<preface id="pref-Tuning_Guide-Preface">
<title>Preface</title>
- <xi:include href="Common_Content/Conventions.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Feedback.xml"
xmlns:xi="http://www.w3.org/2001/XInclude">
- <xi:fallback
xmlns:xi="http://www.w3.org/2001/XInclude">
- <xi:include href="Common_Content/Feedback.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- </xi:fallback>
- </xi:include>
+ <xi:include href="Common_Content/Conventions.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Feedback.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"> <xi:fallback
xmlns:xi="http://www.w3.org/2001/XInclude"> <xi:include
href="Common_Content/Feedback.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </xi:fallback>
+ </xi:include>
</preface>
+
Added: docs/enterprise/trunk/Tuning_Guide/en-US/Revision_History.xml
===================================================================
--- docs/enterprise/trunk/Tuning_Guide/en-US/Revision_History.xml
(rev 0)
+++ docs/enterprise/trunk/Tuning_Guide/en-US/Revision_History.xml 2010-10-21 01:53:21 UTC
(rev 13974)
@@ -0,0 +1,51 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Tuning_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<appendix id="appe-Tuning_Guide-Revision_History">
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>1-1.2</revnumber>
+ <date>Thu 21 Oct 2010</date>
+ <author>
+ <firstname>Scott</firstname>
+ <surname>Mumford</surname>
+ <email>smumford(a)redhat.com</email>
+
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Added syntax highlighting and updated for new Publican
version.</member>
+
+ </simplelist>
+
+ </revdescription>
+
+ </revision>
+ <revision>
+ <revnumber>1-1.0</revnumber>
+ <date></date>
+ <author>
+ <firstname></firstname>
+ <surname></surname>
+ <email></email>
+
+ </author>
+ <revdescription>
+ <simplelist>
+ <member></member>
+
+ </simplelist>
+
+ </revdescription>
+
+ </revision>
+
+ </revhistory>
+
+ </simpara>
+</appendix>
+
Added: docs/enterprise/trunk/Tuning_Guide/en-US/Tuning_Guide.ent
===================================================================
--- docs/enterprise/trunk/Tuning_Guide/en-US/Tuning_Guide.ent (rev
0)
+++ docs/enterprise/trunk/Tuning_Guide/en-US/Tuning_Guide.ent 2010-10-21 01:53:21 UTC (rev
13974)
@@ -0,0 +1,5 @@
+<!ENTITY PRODUCT "Documentation">
+<!ENTITY BOOKID "Portal_Tuning_Guide">
+<!ENTITY YEAR "2008">
+<!ENTITY HOLDER "Red Hat">
+<!ENTITY JBEPPVERS "4.3">
Modified: docs/enterprise/trunk/Tuning_Guide/en-US/Tuning_Guide.xml
===================================================================
--- docs/enterprise/trunk/Tuning_Guide/en-US/Tuning_Guide.xml 2010-10-21 00:55:16 UTC (rev
13973)
+++ docs/enterprise/trunk/Tuning_Guide/en-US/Tuning_Guide.xml 2010-10-21 01:53:21 UTC (rev
13974)
@@ -1,16 +1,17 @@
-<?xml version='1.0'?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Tuning_Guide.ent">
+%BOOK_ENTITIES;
]>
-
<book>
<xi:include href="Book_Info.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Preface.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="overview.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="jbossweb.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="hibernate.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="identity.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="clustering.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="jvm.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
-
+ <xi:include href="Preface.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="overview.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="jbossweb.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="hibernate.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="identity.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="clustering.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="jvm.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Revision_History.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>
Modified: docs/enterprise/trunk/Tuning_Guide/en-US/clustering.xml
===================================================================
--- docs/enterprise/trunk/Tuning_Guide/en-US/clustering.xml 2010-10-21 00:55:16 UTC (rev
13973)
+++ docs/enterprise/trunk/Tuning_Guide/en-US/clustering.xml 2010-10-21 01:53:21 UTC (rev
13974)
@@ -1,86 +1,70 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="clustering">
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Tuning_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Tuning_Guide-Clustering_Tuning">
<title>Clustering Tuning</title>
+ <section
id="sect-Tuning_Guide-Clustering_Tuning-Enable_Buddy_Replication_for_Portal_and_Portlet_SessionClustering">
+ <title> Enable Buddy Replication for Portal and Portlet Session
Clustering</title>
+ <para>
+ Portal and Portlet Session are merely wrappers around HttpSession so most of HTTP
session clustering optimization applies to JBPP as well. EPP uses clustering configuration
of JBoss Web so changes go to <filename>
jboss-web-cluster.sar/META-INF/jboss-service.xml </filename> . To enable buddy
replication, change the value of <emphasis>buddyReplicationEnabled</emphasis>
to true.
+ </para>
- <section id="buddy-repl">
- <title> Enable Buddy Replication for Portal and Portlet
Session Clustering</title>
- <para>
- Portal and Portlet Session are merely wrappers around
- HttpSession so most of HTTP session clustering optimization
- applies to JBPP as well. EPP uses clustering configuration of
- JBoss Web so changes go to
- <filename>
- jboss-web-cluster.sar/META-INF/jboss-service.xml
- </filename>
- . To enable buddy replication, change the value of
- <emphasis>buddyReplicationEnabled</emphasis>
- to true.
- </para>
</section>
-
- <section id="hib-cache">
+
+ <section
id="sect-Tuning_Guide-Clustering_Tuning-Hibernate_and_JBoss_Cache_Configuration">
<title>Hibernate and JBoss Cache Configuration</title>
- <para>
- EPP uses JBoss Cache as a second level cache for Hibernate and
- this configuration is not defined in JBoss Cache definition used
- for Portal and Portlet Session. Instead the configuration is
- defined at
- <filename>
- jboss-portal-ha.sar/META-INF/jboss-service.xml
- </filename>
- </para>
- </section>
- <section id="opt-lock">
- <title>Optimistic Locking (OL)</title>
- <para>Our tests have shown that optimistic locking performs better
- under heavy load and it scales (horizontally) better as
- well. However, your use case may not show the same behavior
- and for you pessimistic locking may be a better
- configuration. To enable optimistic locking, modify
- TreeCache mbean definition as follows:
- <programlisting>
- <attribute
name="NodeLockingScheme">OPTIMISTIC</attribute>
- <attribute
name="CacheMode">INVALIDATION_SYNC</attribute>
- </programlisting>
+ <para>
+ EPP uses JBoss Cache as a second level cache for Hibernate and this configuration is
not defined in JBoss Cache definition used for Portal and Portlet Session. Instead the
configuration is defined at <filename>
jboss-portal-ha.sar/META-INF/jboss-service.xml </filename>
+ </para>
- <note><para>
- If you have not disabled query cache, then you should
- not use INVALIATION_SYNC as CACHE_MODE. Use REPL_SYNC
- instead.</para>
+ </section>
+
+ <section
id="sect-Tuning_Guide-Clustering_Tuning-Optimistic_Locking_OL">
+ <title>Optimistic Locking (OL)</title>
+ <para>
+ Our tests have shown that optimistic locking performs better under heavy load and it
scales (horizontally) better as well. However, your use case may not show the same
behavior and for you pessimistic locking may be a better configuration. To enable
optimistic locking, modify TreeCache mbean definition as follows:
+<programlisting language="XML" role="XML"><attribute
name="NodeLockingScheme">OPTIMISTIC</attribute>
+<attribute
name="CacheMode">INVALIDATION_SYNC</attribute>
+</programlisting>
+ <note>
+ <para>
+ If you have not disabled query cache, then you should not use INVALIATION_SYNC as
CACHE_MODE. Use REPL_SYNC instead.
+ </para>
+
</note>
- </para>
- </section>
- <section id="pess-lock">
- <title>Pessimistic Locking (PL)</title>
- <para>
- When using Pessimistic Locking (PL), change isolation level
- to READ_COMMITTED (RC). Please see <ulink
url="http://lists.jboss.org/pipermail/jbosscache-dev/2008-July/00240...
- to see why it is okay to relax the isolation level from
- REPEATABLE_READ (RR). As expected, RC has better performance than RR.
- </para>
- </section>
- <section id="cache-evic">
- <title>Cache Eviction Policy</title>
- <para>
- If you disabled lazy loading, then you can control number of
- objects and time they can reside in memory by configuring
- EvictionPolicyConfig attribute of TreeCache at
- <filename>
- jboss-portal- ha.sar/META-INF/jboss-service.xml
- </filename>
+ </para>
- <programlisting>
- <attribute name="EvictionPolicyConfig">
- <config>
- <attribute
name="wakeUpIntervalSeconds">5</attribute>
- <region name="/_default_">
- <attribute name="maxNodes">5000</attribute>
- <attribute
name="timeToLiveSeconds">1000</attribute>
- </region>
- </config>
- </attribute>
- </programlisting>
- </para>
- </section>
+ </section>
+
+ <section
id="sect-Tuning_Guide-Clustering_Tuning-Pessimistic_Locking_PL">
+ <title>Pessimistic Locking (PL)</title>
+ <para>
+ When using Pessimistic Locking (PL), change isolation level to READ_COMMITTED (RC).
Please see <ulink
url="http://lists.jboss.org/pipermail/jbosscache-dev/2008-July/00240...
/> to see why it is okay to relax the isolation level from REPEATABLE_READ (RR). As
expected, RC has better performance than RR.
+ </para>
+
+ </section>
+
+ <section
id="sect-Tuning_Guide-Clustering_Tuning-Cache_Eviction_Policy">
+ <title>Cache Eviction Policy</title>
+ <para>
+ If you disabled lazy loading, then you can control number of objects and time they can
reside in memory by configuring EvictionPolicyConfig attribute of TreeCache at
<filename> jboss-portal- ha.sar/META-INF/jboss-service.xml </filename>
+<programlisting language="XML" role="XML"><attribute
name="EvictionPolicyConfig">
+ <config>
+ <attribute
name="wakeUpIntervalSeconds">5</attribute>
+ <region name="/_default_">
+ <attribute
name="maxNodes">5000</attribute>
+ <attribute
name="timeToLiveSeconds">1000</attribute>
+ </region>
+ </config>
+</attribute>
+</programlisting>
+
+ </para>
+
+ </section>
+
</chapter>
+
Modified: docs/enterprise/trunk/Tuning_Guide/en-US/hibernate.xml
===================================================================
--- docs/enterprise/trunk/Tuning_Guide/en-US/hibernate.xml 2010-10-21 00:55:16 UTC (rev
13973)
+++ docs/enterprise/trunk/Tuning_Guide/en-US/hibernate.xml 2010-10-21 01:53:21 UTC (rev
13974)
@@ -1,105 +1,100 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="hibernate">
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Tuning_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Tuning_Guide-Hibernate_Tuning">
<title>Hibernate Tuning</title>
- <section id="lazy-loading">
+ <section
id="sect-Tuning_Guide-Hibernate_Tuning-EnableDisable_Lazy_Loading">
<title>Enable/Disable Lazy Loading</title>
- <para>
- EPP assumes that number of portal pages and portlets window will
- be large and hence does not cache these objects. As a result,
- there could be many direct DB connection. But depending on use
- case, lazy loading should be turned on and off partially or in
- its entirety. Modify
- <filename>
- deploy/jboss-portal[-ha].sar/conf/hibernate/*/domain.hbm.xml
- </filename>
- and change
- <emphasis>lazy=”extra”</emphasis>
- to
- <emphasis>lazy=”true”</emphasis>
- or
- <emphasis>lazy=”false”</emphasis>
- <orderedlist numeration="upperroman">
- <listitem>
- <para>
- Modify attribute for the class
- org.jboss.portal.core.impl.model.portal.ObjectNode
- <programlisting>
- <map name="children" inverse="true"
cascade="none" fetch="select" lazy="true">
- <cache usage="transactional" /> //[“read-write” in non
clustered]
- <key column="PARENT_KEY" />
- <map-key type="org.jboss.portal.jems.hibernate.MagicString"
column="NAME" />
- <one-to-many
class="org.jboss.portal.core.impl.model.portal.ObjectNode" />
- </map>
- </programlisting>
- </para>
- </listitem>
- <listitem>
- <para>
- Enable caching for displayNames for the class
- org.jboss.portal.core.impl.model.portal.PortalObjectImpl
- <programlisting>
- <map name="displayNames" cascade="none"
fetch="select" lazy="true"
- table="JBP_PORTAL_OBJECT_DNAMES">
- <cache usage="transactional" />// [“read-write” in non
clustered]
- <key column="INSTANCE_PK" />
- <map-key type="locale" column="LOCALE" />
- <element type="string" column="TEXT" />
- </map>
- </programlisting>
- </para>
- </listitem>
- <listitem>
- <para>
- Same as above for
- <filename>hibernate/instance/domain.hbm.xml</filename>
- for displayNames map.
- </para>
- </listitem>
- <listitem>
- <para>
- Enable/disable lazy loading for set “users” in
- <filename>hibernate/user/domain.hbm.xml</filename>
- </para>
- </listitem>
- <listitem>
- <para>
- Disabling lazy loading implies there will be many
- objects in memory. You can control how many objects
- would need to reside in memory at a time and for how
- long before they are evicted by modifying values at
- <filename>conf/hibernate/*/ehcache.xml</filename>
- in non clustered configuration. These parameters would
- need to be changed as per the use case. For clustered
- configuration, see the chapter on <xref linkend="clustering">
clustering
- configuration.</xref>
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
+ <para>
+ EPP assumes that number of portal pages and portlets window will be large and hence
does not cache these objects. As a result, there could be many direct DB connection. But
depending on use case, lazy loading should be turned on and off partially or in its
entirety. Modify <filename>
deploy/jboss-portal[-ha].sar/conf/hibernate/*/domain.hbm.xml </filename> and change
<emphasis>lazy=”extra”</emphasis> to
<emphasis>lazy=”true”</emphasis> or
<emphasis>lazy=”false”</emphasis> <orderedlist
numeration="upperroman">
+ <listitem>
+ <para>
+ Modify attribute for the class org.jboss.portal.core.impl.model.portal.ObjectNode
- <section id="query-cache">
- <title>Enable/Disable Query Cache</title>
- <para>
- EPP no longer uses query cache. Unless EPP is customized to use
- query cache, it should be disabled by turning the value of
- property "cache.use_query_cache" to false in following files:
-
- <itemizedlist>
- <listitem><para><filename>hibernate/instance/hibernate.cfg.xml
</filename></para></listitem>
- <listitem><para><filename>hibernate/portal/hibernate.cfg.xml
</filename></para></listitem>
- <listitem><para><filename>hibernate/portlet/hibernate.cfg.xml</filename></para></listitem>
- <listitem><para><filename>hibernate/user/hibernate.cfg.xml</filename></para></listitem>
- </itemizedlist>
+<programlisting language="XML" role="XML"><map
name="children" inverse="true" cascade="none"
fetch="select" lazy="true">
+ <cache usage="transactional" /> //[“read-write” in non
clustered]
+ <key column="PARENT_KEY" />
+ <map-key type="org.jboss.portal.jems.hibernate.MagicString"
column="NAME" />
+ <one-to-many
class="org.jboss.portal.core.impl.model.portal.ObjectNode" />
+</map>
+</programlisting>
- Disabling query cache also allows to
use<emphasis>INVALIDATION_SYNC</emphasis> as
- CACHE_MODE when using optimistic locking with JBoss Cache and
- Hibernate as explained in the clustering section.
- </para>
- </section>
-</chapter>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enable caching for displayNames for the class
org.jboss.portal.core.impl.model.portal.PortalObjectImpl
+<programlisting language="XML" role="XML"><map
name="displayNames" cascade="none" fetch="select"
lazy="true"
+ table="JBP_PORTAL_OBJECT_DNAMES">
+ <cache usage="transactional" />// [“read-write” in non
clustered]
+ <key column="INSTANCE_PK" />
+ <map-key type="locale" column="LOCALE" />
+ <element type="string" column="TEXT" />
+</map>
+</programlisting>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Same as above for
<filename>hibernate/instance/domain.hbm.xml</filename> for displayNames map.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enable/disable lazy loading for set “users” in
<filename>hibernate/user/domain.hbm.xml</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Disabling lazy loading implies there will be many objects in memory. You can
control how many objects would need to reside in memory at a time and for how long before
they are evicted by modifying values at
<filename>conf/hibernate/*/ehcache.xml</filename> in non clustered
configuration. These parameters would need to be changed as per the use case. For
clustered configuration, see the chapter on <xref
linkend="chap-Tuning_Guide-Clustering_Tuning" />
+ </para>
+
+ </listitem>
+
+ </orderedlist>
+
+ </para>
+
+ </section>
+
+ <section
id="sect-Tuning_Guide-Hibernate_Tuning-EnableDisable_Query_Cache">
+ <title>Enable/Disable Query Cache</title>
+ <para>
+ EPP no longer uses query cache. Unless EPP is customized to use query cache, it should
be disabled by turning the value of property "cache.use_query_cache" to false in
following files:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <filename>hibernate/instance/hibernate.cfg.xml </filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <filename>hibernate/portal/hibernate.cfg.xml </filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <filename>hibernate/portlet/hibernate.cfg.xml</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <filename>hibernate/user/hibernate.cfg.xml</filename>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ Disabling query cache also allows to
use<emphasis>INVALIDATION_SYNC</emphasis> as CACHE_MODE when using optimistic
locking with JBoss Cache and Hibernate as explained in the clustering section.
+ </para>
+
+ </section>
+
+</chapter>
+
Modified: docs/enterprise/trunk/Tuning_Guide/en-US/identity.xml
===================================================================
--- docs/enterprise/trunk/Tuning_Guide/en-US/identity.xml 2010-10-21 00:55:16 UTC (rev
13973)
+++ docs/enterprise/trunk/Tuning_Guide/en-US/identity.xml 2010-10-21 01:53:21 UTC (rev
13974)
@@ -1,15 +1,17 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="identity">
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Tuning_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Tuning_Guide-Identity">
<title>Identity</title>
- <section id="cache-login-cred">
+ <section id="sect-Tuning_Guide-Identity-Cache_Login_Credentials">
<title>Cache Login Credentials</title>
- <para>
- EPP uses JaasSecurityManagerService to obtain current users
- roles that are cached by JAAS during authentication. So altering
- cache invalidation can affect performance. Please see the details at
- <ulink
-
url="http://wiki.jboss.org/wiki/CachingLoginCredentials">
- </ulink>.
- </para>
+ <para>
+ EPP uses JaasSecurityManagerService to obtain current users roles that are cached by
JAAS during authentication. So altering cache invalidation can affect performance. Please
see the details at <ulink
url="http://wiki.jboss.org/wiki/CachingLoginCredentials"> </ulink>.
+ </para>
+
</section>
+
</chapter>
+
Modified: docs/enterprise/trunk/Tuning_Guide/en-US/jbossweb.xml
===================================================================
--- docs/enterprise/trunk/Tuning_Guide/en-US/jbossweb.xml 2010-10-21 00:55:16 UTC (rev
13973)
+++ docs/enterprise/trunk/Tuning_Guide/en-US/jbossweb.xml 2010-10-21 01:53:21 UTC (rev
13974)
@@ -1,36 +1,35 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="jbossweb">
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Tuning_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Tuning_Guide-JBoss_Web_Tuning">
<title>JBoss Web Tuning</title>
- <section id="jboss-web">
- <title> HTTP/AJP connector threads </title>
- <para>
- Increase number of HTTP/AJP connector threads. It's recommended
- to set this value to <emphasis> 250 * n </emphasis> where n is number of
CPU in your
- server. Depending on nature of your application, this can be set
- higher or lower. Modify value of maxThreads in in
- <filename>deploy/jboss-web.deployer/server.xml</filename>
+ <section
id="sect-Tuning_Guide-JBoss_Web_Tuning-_HTTPAJP_connector_threads_">
+ <title> HTTP/AJP connector threads </title>
+ <para>
+ Increase number of HTTP/AJP connector threads. It's recommended to set this value
to <emphasis> 250 * n </emphasis> where n is number of CPU in your server.
Depending on nature of your application, this can be set higher or lower. Modify value of
maxThreads in in <filename>deploy/jboss-web.deployer/server.xml</filename>
+<programlisting language="XML" role="XML"><Connector
port="8009" address="${jboss.bind.address}"
+protocol="AJP/1.3" emptySessionPath="true"
enableLookups="false"
+redirectPort="8443" maxThreads="1500" />
+</programlisting>
- <programlisting>
- <Connector port="8009"
address="${jboss.bind.address}"
- protocol="AJP/1.3" emptySessionPath="true"
enableLookups="false"
- redirectPort="8443" maxThreads="1500" />
- </programlisting>
- </para>
+ </para>
+
</section>
+
+ <section
id="sect-Tuning_Guide-JBoss_Web_Tuning-_Global_Session_Timeout_">
+ <title> Global Session Timeout </title>
+ <para>
+ Reduce global session timeout to your need. The default value of 30 min is too high
for most use cases. A lower session timeout results into a more consistent memory
footprint and more consistent throughput. Modify
<filename>deploy/jboss-web.deployer/conf/web.xml</filename>
+<programlisting language="XML"
role="XML"><session-config>
+ <session-timeout>15</session-timeout>
+</session-config>
+</programlisting>
- <section id="session-timeout">
- <title> Global Session Timeout </title>
- <para>
- Reduce global session timeout to your need. The default value of
- 30 min is too high for most use cases. A lower session timeout
- results into a more consistent memory footprint and more
- consistent throughput. Modify
- <filename>deploy/jboss-web.deployer/conf/web.xml</filename>
- <programlisting>
- <session-config>
- <session-timeout>15</session-timeout>
- </session-config>
- </programlisting>
- </para>
- </section>
+ </para>
+
+ </section>
+
</chapter>
+
Modified: docs/enterprise/trunk/Tuning_Guide/en-US/jvm.xml
===================================================================
--- docs/enterprise/trunk/Tuning_Guide/en-US/jvm.xml 2010-10-21 00:55:16 UTC (rev 13973)
+++ docs/enterprise/trunk/Tuning_Guide/en-US/jvm.xml 2010-10-21 01:53:21 UTC (rev 13974)
@@ -1,27 +1,25 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="jvm">
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Tuning_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Tuning_Guide-JVM_Tuning">
<title>JVM Tuning</title>
- <section id="large-page">
+ <section id="sect-Tuning_Guide-JVM_Tuning-Use_Large_Pages">
<title>Use Large Pages</title>
- <para>
- When using 64 bit Linux systems , use Linux's large memory page
- support. Without large page support, increasing heap size may
- not increase your performance. Modify JAVA_OPTS under
- <filename>$JBOSS_HOME/bin/run.conf</filename>
- to add -XX:+ UseLargePages. Please see EAP tuning guide or the
- description at
- <ulink
-
url="http://jbossworld.com/downloads/pdf/thursday/JBOSS_10-1050am_JB...
- </ulink>
- for the details.
- </para>
- </section>
+ <para>
+ When using 64 bit Linux systems , use Linux's large memory page support. Without
large page support, increasing heap size may not increase your performance. Modify
JAVA_OPTS under <filename>$JBOSS_HOME/bin/run.conf</filename> to add -XX:+
UseLargePages. Please see EAP tuning guide or the description at <ulink
url="http://jbossworld.com/downloads/pdf/thursday/JBOSS_10-1050am_JB...
</ulink> for the details.
+ </para>
- <section id="gc">
+ </section>
+
+ <section
id="sect-Tuning_Guide-JVM_Tuning-Garbage_Collection_GC_Tuning">
<title>Garbage Collection (GC) Tuning</title>
- <para>
- Depending on nature of your application, adding <emphasis>
XX:+UseConcMarkSweepGC -XX:+UseParNewGC </emphasis>
- may optimize GC collection behavior.
- </para>
+ <para>
+ Depending on nature of your application, adding <emphasis>
XX:+UseConcMarkSweepGC -XX:+UseParNewGC </emphasis> may optimize GC collection
behavior.
+ </para>
+
</section>
+
</chapter>
+
Modified: docs/enterprise/trunk/Tuning_Guide/en-US/overview.xml
===================================================================
--- docs/enterprise/trunk/Tuning_Guide/en-US/overview.xml 2010-10-21 00:55:16 UTC (rev
13973)
+++ docs/enterprise/trunk/Tuning_Guide/en-US/overview.xml 2010-10-21 01:53:21 UTC (rev
13974)
@@ -1,20 +1,20 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="overview">
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Tuning_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-Tuning_Guide-Overview">
<title>Overview</title>
- <section id="Overview">
- <title>Overview</title>
- <para>
- Since JBoss Enterprise Portal Platform (EPP) uses many services
- of JBoss Enterprise Application Platform (EAP), all tunings and
- configurations that are recommended for EAP apply to EPP as well
- hence most of those tunings will not be covered here. Following
- is a guideline that may help achieve best out of EPP.
- </para>
+ <section id="sect-Tuning_Guide-Overview-Overview">
+ <title>Overview</title>
+ <para>
+ Since JBoss Enterprise Portal Platform (EPP) uses many services of JBoss Enterprise
Application Platform (EAP), all tunings and configurations that are recommended for EAP
apply to EPP as well hence most of those tunings will not be covered here. Following is a
guideline that may help achieve best out of EPP.
+ </para>
+ <para>
+ This document is intended for Portlet Developers, Portal administrators, and those
wishing to implement/extend the JBoss Portal framework.
+ </para>
- <para>
- This document is intended for Portlet Developers, Portal
- administrators, and those wishing to implement/extend the JBoss
- Portal framework.
- </para>
- </section>
+ </section>
+
</chapter>
+
Added: docs/enterprise/trunk/Tuning_Guide/publican.cfg
===================================================================
--- docs/enterprise/trunk/Tuning_Guide/publican.cfg (rev 0)
+++ docs/enterprise/trunk/Tuning_Guide/publican.cfg 2010-10-21 01:53:21 UTC (rev 13974)
@@ -0,0 +1,7 @@
+# Config::Simple 4.59
+# Thu Oct 21 11:39:54 2010
+
+debug: 1
+xml_lang: en-US
+brand: JBoss
+