rt/share/html/Admin/Elements/LoggingSummary

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2017 Best Practical Solutions, LLC
   6 %#                                          <sales@bestpractical.com>
   7 %#
   8 %# (Except where explicitly superseded by other copyright notices)
   9 %#
  10 %#
  11 %# LICENSE:
  12 %#
  13 %# This work is made available to you under the terms of Version 2 of
  14 %# the GNU General Public License. A copy of that license should have
  15 %# been provided with this software, but in any event can be snarfed
  16 %# from www.gnu.org.
  17 %#
  18 %# This work is distributed in the hope that it will be useful, but
  19 %# WITHOUT ANY WARRANTY; without even the implied warranty of
  20 %# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 %# General Public License for more details.
  22 %#
  23 %# You should have received a copy of the GNU General Public License
  24 %# along with this program; if not, write to the Free Software
  25 %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  26 %# 02110-1301 or visit their web page on the internet at
  27 %# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
  28 %#
  29 %#
  30 %# CONTRIBUTION SUBMISSION POLICY:
  31 %#
  32 %# (The following paragraph is not intended to limit the rights granted
  33 %# to you to modify and distribute this software under the terms of
  34 %# the GNU General Public License and is only of importance to you if
  35 %# you choose to contribute your changes and enhancements to the
  36 %# community by submitting them to Best Practical Solutions, LLC.)
  37 %#
  38 %# By intentionally submitting any modifications, corrections or
  39 %# derivatives to this work, or any other work intended for use with
  40 %# Request Tracker, to Best Practical Solutions, LLC, you confirm that
  41 %# you are the copyright holder for those contributions and you grant
  42 %# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  43 %# royalty-free, perpetual, license to use, copy, create derivative
  44 %# works based on those contributions, and sublicense and distribute
  45 %# those contributions and any derivatives thereof.
  46 %#
  47 %# END BPS TAGGED BLOCK }}}
  48 <%init>
  49 my @summary;
  50
  51 if (my $level = RT->Config->Get("LogToSTDERR")) {
  52     push @summary, loc("Logging [_1] level messages and higher to STDERR, which will usually end up in your webserver's error logs.", $level);
  53 }
  54
  55 if (my $level  = RT->Config->Get("LogToFile") and
  56     my $logger = RT->Logger->output("file")) {
  57     # Using the Log::Dispatch::File object let's us avoid duplicating
  58     # filename logic from RT::InitLogging()
  59     push @summary, loc("Logging [_1] level messages and higher to [_2]", $level, $logger->{filename});
  60 }
  61
  62 if (my $level = RT->Config->Get("LogToSyslog")) {
  63     my %conf = RT->Config->Get("LogToSyslogConf");
  64     my $conf = join ", ", map { "$_=$conf{$_}" } keys %conf;
  65     if ($conf) {
  66         push @summary, loc("Logging [_1] level messages and higher to syslog with the following configuration: [_2]", $level, $conf);
  67     } else {
  68         push @summary, loc("Logging [_1] level messages and higher to syslog.", $level);
  69     }
  70 }
  71
  72 if (my $level = RT->Config->Get("LogStackTraces")) {
  73     push @summary, loc("Stack traces are added to message levels [_1] and higher.", $level);
  74 } else {
  75     push @summary, loc("Stack traces are not logged.");
  76 }
  77
  78 if (my $level = RT->Config->Get("StatementLog")) {
  79     my $url = RT->Config->Get("WebPath") . "/Admin/Tools/Queries.html";
  80     push @summary, \loc("SQL queries are logged at the [_1] level and also available in the [_2]query tool[_3].", $m->interp->apply_escapes($level, 'h'), qq[<strong><a href="$url">], '</a></strong>');
  81 } else {
  82     push @summary, loc("SQL queries are not logged.");
  83 }
  84 </%init>
  85 <p>
  86 <&|/l&>RT's logging configuration is summarized below:</&>
  87 <ul>
  88 % for my $msg (@summary) {
  89   <li><% ref($msg) ? $$msg : $m->interp->apply_escapes($msg, 'h') |n %></li>
  90 % }
  91 </ul>
  92 </p>