From fd713fe1b2ae48cff3ee89d3b080490979e294a3 Mon Sep 17 00:00:00 2001
From: Gavin King <gavin@hibernate.org>
Date: Sun, 6 Feb 2005 06:42:54 +0000
Subject: [PATCH] docd log categories

git-svn-id: https://svn.jboss.org/repos/hibernate/trunk/Hibernate3/doc@5578 1b8cb986-b30d-0410-93ca-fae66ebed9b2
---
 reference/en/modules/configuration.xml | 66 ++++++++++++++++++++++++--
 1 file changed, 63 insertions(+), 3 deletions(-)

diff --git a/reference/en/modules/configuration.xml b/reference/en/modules/configuration.xml
index 569bcb2ccb..a54b7bcc61 100644
--- a/reference/en/modules/configuration.xml
+++ b/reference/en/modules/configuration.xml
@@ -1311,11 +1311,71 @@ hibernate.dialect = org.hibernate.dialect.PostgreSQLDialect]]></programlisting>
             We strongly recommend that you familiarize yourself with Hibernate's log
             messages. A lot of work has been put into making the Hibernate log as
             detailed as possible, without making it unreadable. It is an essential
-            troubleshooting device. Also don't forget to enable SQL logging as
-            described above (<literal>hibernate.show_sql</literal>), it is your first
-            step when looking for performance problems.
+            troubleshooting device. The most interesting log categories are the
+            following:
         </para>
         
+            <table frame="topbot" id="log-categories" revision="2">
+                <title>Hibernate Log Categories</title>
+                <tgroup cols="2">
+                    <colspec colwidth="1*"/>
+                    <colspec colwidth="2.5*"/>
+                    <thead>
+                        <row>
+                            <entry>Category</entry>
+                            <entry>Function</entry>
+                        </row>
+                    </thead>
+                    <tbody>
+                        <row>
+                            <entry><literal>org.hibernate.SQL</literal></entry>
+                            <entry>Log all SQL DML statements as they are executed</entry>
+                        </row>
+                        <row>
+                            <entry><literal>org.hibernate.type</literal></entry>
+                            <entry>Log all JDBC parameters</entry>
+                        </row>
+                        <row>
+                            <entry><literal>org.hibernate.tool.hbm2ddl</literal></entry>
+                            <entry>Log all SQL DDL statements as they are executed</entry>
+                        </row>
+                        <row>
+                            <entry><literal>org.hibernate.pretty</literal></entry>
+                            <entry>
+                                Log the state of all entities (max 20 entities) associated
+                                with the session at flush time
+                            </entry>
+                        </row>
+                        <row>
+                            <entry><literal>org.hibernate.cache</literal></entry>
+                            <entry>Log all second-level cache activity</entry>
+                        </row>
+                        <row>
+                            <entry><literal>org.hibernate.jdbc</literal></entry>
+                            <entry>Log all JDBC resource acquisition</entry>
+                        </row>
+                        <row>
+                            <entry><literal>org.hibernate.secure</literal></entry>
+                            <entry>Log all JAAS authorization requests</entry>
+                        </row>
+                        <row>
+                            <entry><literal>org.hibernate</literal></entry>
+                            <entry>
+                                Log everything (a lot of information, but very useful for
+                                troubleshooting).
+                            </entry>
+                        </row>
+                    </tbody>
+                </tgroup>
+            </table>
+            
+        <para>
+            When developing applications with Hibernate, you should almost always work with
+            <literal>debug</literal> enabled for the category <literal>org.hibernate.SQL</literal>,
+            or, alternatively, the property <literal>hibernate.show_sql</literal> enabled.
+        </para>
+                       
+        
     </sect1>
 
     <sect1 id="configuration-namingstrategy">