X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits%2FDBIx-Class-DeploymentHandler.git;a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDeploymentHandler.pm;h=f9b11fe526fdb436d9cac0d497cafe73ce34d69b;hp=a792c25d22bd3cf1df5c3d5bf746b1eb6a6b0e13;hb=8465e76797613fa0b9c85365c03d26cacbaab31a;hpb=5020d6a24f9a9b5c37333c0f140839f5b73153cf

diff --git a/lib/DBIx/Class/DeploymentHandler.pm b/lib/DBIx/Class/DeploymentHandler.pm
index a792c25..f9b11fe 100644
--- a/lib/DBIx/Class/DeploymentHandler.pm
+++ b/lib/DBIx/Class/DeploymentHandler.pm
@@ -185,6 +185,26 @@ Then set your database version:
 
 Now you should be able to use C<DBIx::Class::DeploymentHandler> like normal!
 
+=head1 LOGGING
+
+This is a complex tool, and because of that sometimes you'll want to see
+what exactly is happening.  The best way to do that is to use the built in
+logging functionality.  It the standard six log levels; C<fatal>, C<error>,
+C<warn>, C<info>, C<debug>, and C<trace>.  Most of those are pretty self
+explanatory.  Generally a safe level to see what all is going on is debug,
+which will give you everything except for the exact SQL being run.
+
+To enable the various logging levels all you need to do is set an environment
+variables: C<DBICDH_FATAL>, C<DBICDH_ERROR>, C<DBICDH_WARN>, C<DBICDH_INFO>,
+C<DBICDH_DEBUG>, and C<DBICDH_TRACE>.  Each level can be set on it's own,
+but the default is the first three on and the last three off, and the levels
+cascade, so if you turn on trace the rest will turn on automatically.
+
+Lastly, the logging uses L<Log::Contextual>, so if you have already set up an
+application-wide logger this will use that logger instead, and the environment
+variables will be completely ignored (unless you did something weird like
+set your logger to log when the above environment variables are set.)
+
 =head1 DONATIONS
 
 If you'd like to thank me for the work I've done on this module, don't give me