onap/portal/portal-be/conf/logback.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!--
   3   ================================================================================
   4   eCOMP Portal
   5   ================================================================================
   6   Copyright (C) 2017 AT&T Intellectual Property
   7   ================================================================================
   8   Licensed under the Apache License, Version 2.0 (the "License");
   9   you may not use this file except in compliance with the License.
  10   You may obtain a copy of the License at
  11
  12        http://www.apache.org/licenses/LICENSE-2.0
  13
  14   Unless required by applicable law or agreed to in writing, software
  15   distributed under the License is distributed on an "AS IS" BASIS,
  16   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17   See the License for the specific language governing permissions and
  18   limitations under the License.
  19   ================================================================================
  20   -->
  21 <!DOCTYPE xml>
  22 <configuration debug="true" scan="true" scanPeriod="3 seconds">
  23     <!-- Log-back files for the ECOMP Portal "ecompportal" are created in directory
  24                 ${catalina.base}/logs/ecompportal; e.g., apache-tomcat-8.0.35/logs/ecompportal/application.log -->
  25     <!--<jmxConfigurator /> -->
  26     <!-- specify the component name -->
  27     <property name="componentName" value="portal"></property>
  28     <property name="subComponentName" value="portalBE"></property>
  29     <!-- specify the base path of the log directory -->
  30     <property name="logDirPrefix" value="/var/log/onap"></property>
  31     <!-- The directories where logs are written -->
  32     <property name="logDirectory" value="${logDirPrefix}/${componentName}/${subComponentName}" />
  33     <!-- Can easily relocate debug logs by modifying this path. -->
  34     <property name="debugLogDirectory" value="${logDirPrefix}/${componentName}/${subComponentName}" />
  35     <!-- log file names -->
  36     <property name="generalLogName" value="application" />
  37     <property name="errorLogName" value="error" />
  38     <property name="metricsLogName" value="metrics" />
  39     <property name="auditLogName" value="audit" />
  40     <property name="debugLogName" value="debug" />
  41     <!-- These loggers are not used in code (yet). <property name="securityLogName"
  42                 value="security" /> <property name="policyLogName" value="policy" /> <property
  43                 name="performanceLogName" value="performance" /> <property name="serverLogName"
  44                 value="server" /> -->
  45     <!-- ServerFQDN=Server,  -->
  46     <property name="pattern" value="%d{&quot;yyyy-MM-dd'T'HH:mm:ss.SSSXXX&quot;, UTC}\t[%thread]\t%-5level\t%logger{36}\t%replace(%replace(%replace(%mdc){'\t','\\\\t'}){', ','\t'}){'\n', '\\\\n'}\t%replace(%replace(%msg){'\n', '\\\\n'}){'\t','\\\\t'}%n" />
  47     <property name="maxHistory" value="30" />
  48     <property name="queueSize" value="256" />
  49     <property name="maxFileSize" value="50MB" />
  50     <property name="totalSizeCap" value="10GB" />
  51     <!-- Example evaluator filter applied against console appender -->
  52     <appender class="ch.qos.logback.core.ConsoleAppender" name="STDOUT">
  53         <encoder>
  54             <pattern>${pattern}</pattern>
  55         </encoder>
  56     </appender>
  57     <!-- ============================================================================ -->
  58     <!-- EELF Appenders -->
  59     <!-- ============================================================================ -->
  60     <!-- The EELFAppender is used to record events to the general application
  61                 log -->
  62     <appender class="ch.qos.logback.core.rolling.RollingFileAppender" name="EELF">
  63         <file>${logDirectory}/${generalLogName}.log</file>
  64         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  65             <!-- daily rollover -->
  66             <fileNamePattern>${logDirectory}/${generalLogName}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  67             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  68                 <maxFileSize>${maxFileSize}</maxFileSize>
  69             </timeBasedFileNamingAndTriggeringPolicy>
  70             <maxHistory>${maxHistory}</maxHistory>
  71             <totalSizeCap>${totalSizeCap}</totalSizeCap>
  72         </rollingPolicy>
  73         <encoder>
  74             <pattern>${pattern}</pattern>
  75         </encoder>
  76         <filter class="org.openecomp.portalapp.portal.utils.CustomLoggingFilter" />
  77     </appender>
  78     <appender class="ch.qos.logback.classic.AsyncAppender" name="asyncEELF">
  79         <queueSize>${queueSize}</queueSize>
  80         <!-- Class name is part of caller data -->
  81         <includeCallerData>true</includeCallerData>
  82         <appender-ref ref="EELF" />
  83     </appender>
  84     <!-- EELF Security Appender. This appender is used to record security events
  85                 to the security log file. Security events are separate from other loggers
  86                 in EELF so that security log records can be captured and managed in a secure
  87                 way separate from the other logs. This appender is set to never discard any
  88                 events. -->
  89     <!-- <appender name="EELFSecurity" class="ch.qos.logback.core.rolling.RollingFileAppender">
  90                 <file>${logDirectory}/${securityLogName}.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
  91                 <fileNamePattern>${logDirectory}/${securityLogName}.%i.log.zip </fileNamePattern>
  92                 <minIndex>1</minIndex> <maxIndex>9</maxIndex> </rollingPolicy> <triggeringPolicy
  93                 class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <maxFileSize>5MB</maxFileSize>
  94                 </triggeringPolicy> <encoder> <pattern>${defaultPattern}</pattern> </encoder>
  95                 </appender> <appender name="asyncEELFSecurity" class="ch.qos.logback.classic.AsyncAppender">
  96                 <queueSize>256</queueSize> <discardingThreshold>0</discardingThreshold> <appender-ref
  97                 ref="EELFSecurity" /> </appender> -->
  98     <!-- EELF Performance Appender. This appender is used to record performance
  99                 records. -->
 100     <!-- <appender name="EELFPerformance" class="ch.qos.logback.core.rolling.RollingFileAppender">
 101                 <file>${logDirectory}/${performanceLogName}.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
 102                 <fileNamePattern>${logDirectory}/${performanceLogName}.%i.log.zip </fileNamePattern>
 103                 <minIndex>1</minIndex> <maxIndex>9</maxIndex> </rollingPolicy> <triggeringPolicy
 104                 class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <maxFileSize>5MB</maxFileSize>
 105                 </triggeringPolicy> <encoder> <outputPatternAsHeader>true</outputPatternAsHeader>
 106                 <pattern>${defaultPattern}</pattern> </encoder> </appender> <appender name="asyncEELFPerformance"
 107                 class="ch.qos.logback.classic.AsyncAppender"> <queueSize>256</queueSize>
 108                 <appender-ref ref="EELFPerformance" /> </appender> -->
 109     <!-- EELF Server Appender. This appender is used to record Server related
 110                 logging events. The Server logger and appender are specializations of the
 111                 EELF application root logger and appender. This can be used to segregate
 112                 Server events from other components, or it can be eliminated to record these
 113                 events as part of the application root log. -->
 114     <!-- <appender name="EELFServer" class="ch.qos.logback.core.rolling.RollingFileAppender">
 115                 <file>${logDirectory}/${serverLogName}.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
 116                 <fileNamePattern>${logDirectory}/${serverLogName}.%i.log.zip </fileNamePattern>
 117                 <minIndex>1</minIndex> <maxIndex>9</maxIndex> </rollingPolicy> <triggeringPolicy
 118                 class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <maxFileSize>5MB</maxFileSize>
 119                 </triggeringPolicy> <encoder> <pattern>${defaultPattern}</pattern> </encoder>
 120                 </appender> <appender name="asyncEELFServer" class="ch.qos.logback.classic.AsyncAppender">
 121                 <queueSize>256</queueSize> <appender-ref ref="EELFServer" /> </appender> -->
 122     <!-- EELF Policy Appender. This appender is used to record Policy engine
 123                 related logging events. The Policy logger and appender are specializations
 124                 of the EELF application root logger and appender. This can be used to segregate
 125                 Policy engine events from other components, or it can be eliminated to record
 126                 these events as part of the application root log. -->
 127     <!-- <appender name="EELFPolicy" class="ch.qos.logback.core.rolling.RollingFileAppender">
 128                 <file>${logDirectory}/${policyLogName}.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
 129                 <fileNamePattern>${logDirectory}/${policyLogName}.%i.log.zip </fileNamePattern>
 130                 <minIndex>1</minIndex> <maxIndex>9</maxIndex> </rollingPolicy> <triggeringPolicy
 131                 class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <maxFileSize>5MB</maxFileSize>
 132                 </triggeringPolicy> <encoder> <pattern>${defaultPattern}</pattern> </encoder>
 133                 </appender> <appender name="asyncEELFPolicy" class="ch.qos.logback.classic.AsyncAppender">
 134                 <queueSize>256</queueSize> <appender-ref ref="EELFPolicy" /> </appender> -->
 135     <!-- EELF Audit Appender. This appender is used to record audit engine related
 136                 logging events. The audit logger and appender are specializations of the
 137                 EELF application root logger and appender. This can be used to segregate
 138                 Policy engine events from other components, or it can be eliminated to record
 139                 these events as part of the application root log. -->
 140     <appender class="ch.qos.logback.core.rolling.RollingFileAppender" name="EELFAudit">
 141         <file>${logDirectory}/${auditLogName}.log</file>
 142         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
 143             <!-- daily roll over -->
 144             <fileNamePattern>${logDirectory}/${auditLogName}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
 145             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
 146                 <maxFileSize>${maxFileSize}</maxFileSize>
 147             </timeBasedFileNamingAndTriggeringPolicy>
 148             <maxHistory>${maxHistory}</maxHistory>
 149             <totalSizeCap>${totalSizeCap}</totalSizeCap>
 150         </rollingPolicy>
 151         <encoder>
 152             <pattern>${pattern}</pattern>
 153         </encoder>
 154     </appender>
 155     <appender class="ch.qos.logback.classic.AsyncAppender" name="asyncEELFAudit">
 156         <queueSize>${queueSize}</queueSize>
 157         <appender-ref ref="EELFAudit" />
 158     </appender>
 159     <appender class="ch.qos.logback.core.rolling.RollingFileAppender" name="EELFMetrics">
 160         <file>${logDirectory}/${metricsLogName}.log</file>
 161         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
 162             <!-- daily roll over -->
 163             <fileNamePattern>${logDirectory}/${metricsLogName}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
 164             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
 165                 <maxFileSize>${maxFileSize}</maxFileSize>
 166             </timeBasedFileNamingAndTriggeringPolicy>
 167             <maxHistory>${maxHistory}</maxHistory>
 168             <totalSizeCap>${totalSizeCap}</totalSizeCap>
 169         </rollingPolicy>
 170         <encoder>
 171             <pattern>${pattern}</pattern>
 172         </encoder>
 173     </appender>
 174     <appender class="ch.qos.logback.classic.AsyncAppender" name="asyncEELFMetrics">
 175         <queueSize>${queueSize}</queueSize>
 176         <appender-ref ref="EELFMetrics" />
 177     </appender>
 178     <appender class="ch.qos.logback.core.rolling.RollingFileAppender" name="EELFError">
 179         <file>${logDirectory}/${errorLogName}.log</file>
 180         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
 181             <!-- daily roll over -->
 182             <fileNamePattern>${logDirectory}/${errorLogName}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
 183             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
 184                 <maxFileSize>${maxFileSize}</maxFileSize>
 185             </timeBasedFileNamingAndTriggeringPolicy>
 186             <maxHistory>${maxHistory}</maxHistory>
 187             <totalSizeCap>${totalSizeCap}</totalSizeCap>
 188         </rollingPolicy>
 189         <encoder>
 190             <pattern>${pattern}</pattern>
 191         </encoder>
 192     </appender>
 193     <appender class="ch.qos.logback.classic.AsyncAppender" name="asyncEELFError">
 194         <queueSize>${queueSize}</queueSize>
 195         <appender-ref ref="EELFError" />
 196     </appender>
 197     <appender class="ch.qos.logback.core.rolling.RollingFileAppender" name="EELFDebug">
 198         <file>${debugLogDirectory}/${debugLogName}.log</file>
 199         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
 200             <!-- daily roll over -->
 201             <fileNamePattern>${logDirectory}/${debugLogName}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
 202             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
 203                 <maxFileSize>${maxFileSize}</maxFileSize>
 204             </timeBasedFileNamingAndTriggeringPolicy>
 205             <maxHistory>${maxHistory}</maxHistory>
 206             <totalSizeCap>${totalSizeCap}</totalSizeCap>
 207         </rollingPolicy>
 208         <encoder>
 209             <pattern>${pattern}</pattern>
 210         </encoder>
 211     </appender>
 212     <appender class="ch.qos.logback.classic.AsyncAppender" name="asyncEELFDebug">
 213         <queueSize>${queueSize}</queueSize>
 214         <appender-ref ref="EELFDebug" />
 215         <includeCallerData>true</includeCallerData>
 216     </appender>
 217     <!-- ============================================================================ -->
 218     <!-- EELF loggers -->
 219     <!-- ============================================================================ -->
 220     <logger additivity="false" level="info" name="com.att.eelf">
 221         <appender-ref ref="asyncEELF" />
 222     </logger>
 223     <!-- <logger name="com.att.eelf.security" level="info" additivity="false">
 224                 <appender-ref ref="asyncEELFSecurity" /> </logger> <logger name="com.att.eelf.perf"
 225                 level="info" additivity="false"> <appender-ref ref="asyncEELFPerformance"
 226                 /> </logger> <logger name="com.att.eelf.server" level="info" additivity="false">
 227                 <appender-ref ref="asyncEELFServer" /> </logger> <logger name="com.att.eelf.policy"
 228                 level="info" additivity="false"> <appender-ref ref="asyncEELFPolicy" /> </logger> -->
 229     <logger additivity="false" level="info" name="com.att.eelf.audit">
 230         <appender-ref ref="asyncEELFAudit" />
 231     </logger>
 232     <logger additivity="false" level="info" name="com.att.eelf.metrics">
 233         <appender-ref ref="asyncEELFMetrics" />
 234     </logger>
 235     <logger additivity="false" level="info" name="com.att.eelf.error">
 236         <appender-ref ref="asyncEELFError" />
 237     </logger>
 238     <logger additivity="false" level="debug" name="com.att.eelf.debug">
 239         <appender-ref ref="asyncEELFDebug" />
 240     </logger>
 241     <root level="INFO">
 242         <appender-ref ref="asyncEELF" />
 243     </root>
 244 </configuration>