ecomp-portal-BE-os/src/main/resources/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
  22 <!DOCTYPE xml>
  23 <configuration scan="true" scanPeriod="3 seconds" debug="true">
  24         <!-- Log-back files for the ECOMP Portal "ecompportal" are created in directory
  25                 ${catalina.base}/logs/ecompportal; e.g., apache-tomcat-8.0.35/logs/ecompportal/application.log -->
  26         <!--<jmxConfigurator /> -->
  27
  28         <!-- specify the component name -->
  29         <property name="componentName" value="ecompportal"></property>
  30
  31         <!-- specify the base path of the log directory -->
  32         <property name="logDirPrefix" value="${catalina.base}/logs"></property>
  33
  34         <!-- The directories where logs are written -->
  35         <property name="logDirectory" value="${logDirPrefix}/${componentName}" />
  36         <!-- Can easily relocate debug logs by modifying this path. -->
  37         <property name="debugLogDirectory" value="${logDirPrefix}/${componentName}" />
  38
  39         <!-- log file names -->
  40         <property name="generalLogName" value="application" />
  41         <property name="errorLogName" value="error" />
  42         <property name="metricsLogName" value="metrics" />
  43         <property name="auditLogName" value="audit" />
  44         <property name="debugLogName" value="debug" />
  45         <!-- These loggers are not used in code (yet). <property name="securityLogName"
  46                 value="security" /> <property name="policyLogName" value="policy" /> <property
  47                 name="performanceLogName" value="performance" /> <property name="serverLogName"
  48                 value="server" /> -->
  49
  50         <!-- ServerFQDN=Server,  -->
  51         <property name="auditLoggerPattern"
  52                 value="%X{AuditLogBeginTimestamp}|%X{AuditLogEndTimestamp}|%X{RequestId}|%X{ServiceInstanceId}|%thread|%X{VirtualServerName}|%X{ServiceName}|%X{PartnerName}|%X{StatusCode}|%X{ResponseCode}|%X{ResponseDescription}|%X{InstanceUUID}|%.-5level|%X{AlertSeverity}|%X{ServerIPAddress}|%X{Timer}|%X{ServerFQDN}|%X{ClientIPAddress}|%X{ClassName}|%X{Unused}|%X{ProcessKey}|%X{CustomField1}|%X{CustomField2}|%X{CustomField3}|%X{CustomField4}| %msg%n" />
  53
  54         <property name="metricsLoggerPattern"
  55                 value="%X{MetricsLogBeginTimestamp}|%X{MetricsLogEndTimestamp}|%X{RequestId}|%X{ServiceInstanceId}|%thread|%X{VirtualServerName}|%X{ServiceName}|%X{PartnerName}|%X{TargetEntity}|%X{TargetServiceName}|%X{StatusCode}|%X{ResponseCode}|%X{ResponseDescription}|%X{InstanceUUID}|%.-5level|%X{AlertSeverity}|%X{ServerIPAddress}|%X{Timer}|%X{ServerFQDN}|%X{ClientIPAddress}|%X{ClassName}|%X{Unused}|%X{ProcessKey}|%X{TargetVisualEntity}|%X{CustomField1}|%X{CustomField2}|%X{CustomField3}|%X{CustomField4}| %msg%n" />
  56
  57         <property name="errorLoggerPattern"
  58                 value="%date{yyyy-MM-dd'T'HH:mm:ss.SSSXXX}|%X{RequestId}|%thread|%X{ServiceName}|%X{PartnerName}|%X{TargetEntity}|%X{TargetServiceName}|%X{ClassName}|%X{AlertSeverity}|%X{ErrorCode}|%X{ErrorDescription}| %msg%n" />
  59
  60         <property name="defaultLoggerPattern"
  61                 value="%date{yyyy-MM-dd'T'HH:mm:ss.SSSXXX}|%X{RequestId}|%thread|%X{ClassName}| %msg%n" />
  62
  63         <!-- use %class so library logging calls yield their class name -->
  64         <property name="applicationLoggerPattern"
  65                 value="%date{yyyy-MM-dd'T'HH:mm:ss.SSSXXX}|%X{RequestId}|%thread|%class{36}| %msg%n" />
  66
  67         <!--
  68         <property name="defaultPattern"
  69                 value="%date{ISO8601}|%X{RequestId}|%X{ServiceInstanceId}|%thread|%X{VirtualServerName}|%X{ServiceName}|%X{InstanceUUID}|%.-5level|%X{AlertSeverity}|%X{ServerIPAddress}|%X{ServerFQDN}|%X{RemoteHost}|%X{ClassName}|%X{Timer}| %msg%n" />
  70         <property name="debugLoggerPattern"
  71                 value="%date{ISO8601}|%X{RequestId}|%X{ServiceInstanceId}|%thread|%X{VirtualServerName}|%X{ServiceName}|%X{InstanceUUID}|%.-5level|%X{AlertSeverity}|%X{ServerIPAddress}|%X{ServerFQDN}|%X{RemoteHost}|%X{ClassName}|%X{Timer}| %msg%n" />
  72          -->
  73         <!-- <property name="debugLoggerPattern" value="%date{ISO8601}|%X{RequestId}|%X{ServiceInstanceId}|%thread|%X{ServiceName}|%X{InstanceUUID}|%.-5level|%X{AlertSeverity}|%X{ServerIPAddress}|%X{ServerFQDN}|%X{RemoteHost}|%X{Timer}|[%caller{3}]|%msg%n"
  74                 /> -->
  75         <!-- Example evaluator filter applied against console appender -->
  76         <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
  77                 <encoder>
  78                         <pattern>${applicationLoggerPattern}</pattern>
  79                 </encoder>
  80         </appender>
  81
  82         <!-- ============================================================================ -->
  83         <!-- EELF Appenders -->
  84         <!-- ============================================================================ -->
  85
  86         <!-- The EELFAppender is used to record events to the general application
  87                 log -->
  88
  89
  90         <appender name="EELF"
  91                 class="ch.qos.logback.core.rolling.RollingFileAppender">
  92                 <file>${logDirectory}/${generalLogName}.log</file>
  93                 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  94                         <!-- daily rollover -->
  95                         <fileNamePattern>${logDirectory}/${generalLogName}.log.%d{yyyy-MM-dd}.zip
  96                         </fileNamePattern>
  97                         <maxHistory>30</maxHistory>
  98                 </rollingPolicy>
  99                 <encoder>
 100                         <pattern>${applicationLoggerPattern}</pattern>
 101                 </encoder>
 102                 <filter class="org.openecomp.portalapp.portal.utils.CustomLoggingFilter" />
 103         </appender>
 104
 105         <appender name="asyncEELF" class="ch.qos.logback.classic.AsyncAppender">
 106                 <queueSize>256</queueSize>
 107                 <!-- Class name is part of caller data -->
 108         <includeCallerData>true</includeCallerData>
 109                 <appender-ref ref="EELF" />
 110         </appender>
 111
 112         <!-- EELF Security Appender. This appender is used to record security events
 113                 to the security log file. Security events are separate from other loggers
 114                 in EELF so that security log records can be captured and managed in a secure
 115                 way separate from the other logs. This appender is set to never discard any
 116                 events. -->
 117         <!-- <appender name="EELFSecurity" class="ch.qos.logback.core.rolling.RollingFileAppender">
 118                 <file>${logDirectory}/${securityLogName}.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
 119                 <fileNamePattern>${logDirectory}/${securityLogName}.%i.log.zip </fileNamePattern>
 120                 <minIndex>1</minIndex> <maxIndex>9</maxIndex> </rollingPolicy> <triggeringPolicy
 121                 class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <maxFileSize>5MB</maxFileSize>
 122                 </triggeringPolicy> <encoder> <pattern>${defaultPattern}</pattern> </encoder>
 123                 </appender> <appender name="asyncEELFSecurity" class="ch.qos.logback.classic.AsyncAppender">
 124                 <queueSize>256</queueSize> <discardingThreshold>0</discardingThreshold> <appender-ref
 125                 ref="EELFSecurity" /> </appender> -->
 126
 127         <!-- EELF Performance Appender. This appender is used to record performance
 128                 records. -->
 129         <!-- <appender name="EELFPerformance" class="ch.qos.logback.core.rolling.RollingFileAppender">
 130                 <file>${logDirectory}/${performanceLogName}.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
 131                 <fileNamePattern>${logDirectory}/${performanceLogName}.%i.log.zip </fileNamePattern>
 132                 <minIndex>1</minIndex> <maxIndex>9</maxIndex> </rollingPolicy> <triggeringPolicy
 133                 class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <maxFileSize>5MB</maxFileSize>
 134                 </triggeringPolicy> <encoder> <outputPatternAsHeader>true</outputPatternAsHeader>
 135                 <pattern>${defaultPattern}</pattern> </encoder> </appender> <appender name="asyncEELFPerformance"
 136                 class="ch.qos.logback.classic.AsyncAppender"> <queueSize>256</queueSize>
 137                 <appender-ref ref="EELFPerformance" /> </appender> -->
 138
 139         <!-- EELF Server Appender. This appender is used to record Server related
 140                 logging events. The Server logger and appender are specializations of the
 141                 EELF application root logger and appender. This can be used to segregate
 142                 Server events from other components, or it can be eliminated to record these
 143                 events as part of the application root log. -->
 144         <!-- <appender name="EELFServer" class="ch.qos.logback.core.rolling.RollingFileAppender">
 145                 <file>${logDirectory}/${serverLogName}.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
 146                 <fileNamePattern>${logDirectory}/${serverLogName}.%i.log.zip </fileNamePattern>
 147                 <minIndex>1</minIndex> <maxIndex>9</maxIndex> </rollingPolicy> <triggeringPolicy
 148                 class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <maxFileSize>5MB</maxFileSize>
 149                 </triggeringPolicy> <encoder> <pattern>${defaultPattern}</pattern> </encoder>
 150                 </appender> <appender name="asyncEELFServer" class="ch.qos.logback.classic.AsyncAppender">
 151                 <queueSize>256</queueSize> <appender-ref ref="EELFServer" /> </appender> -->
 152
 153         <!-- EELF Policy Appender. This appender is used to record Policy engine
 154                 related logging events. The Policy logger and appender are specializations
 155                 of the EELF application root logger and appender. This can be used to segregate
 156                 Policy engine events from other components, or it can be eliminated to record
 157                 these events as part of the application root log. -->
 158         <!-- <appender name="EELFPolicy" class="ch.qos.logback.core.rolling.RollingFileAppender">
 159                 <file>${logDirectory}/${policyLogName}.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
 160                 <fileNamePattern>${logDirectory}/${policyLogName}.%i.log.zip </fileNamePattern>
 161                 <minIndex>1</minIndex> <maxIndex>9</maxIndex> </rollingPolicy> <triggeringPolicy
 162                 class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> <maxFileSize>5MB</maxFileSize>
 163                 </triggeringPolicy> <encoder> <pattern>${defaultPattern}</pattern> </encoder>
 164                 </appender> <appender name="asyncEELFPolicy" class="ch.qos.logback.classic.AsyncAppender">
 165                 <queueSize>256</queueSize> <appender-ref ref="EELFPolicy" /> </appender> -->
 166
 167         <!-- EELF Audit Appender. This appender is used to record audit engine related
 168                 logging events. The audit logger and appender are specializations of the
 169                 EELF application root logger and appender. This can be used to segregate
 170                 Policy engine events from other components, or it can be eliminated to record
 171                 these events as part of the application root log. -->
 172
 173         <appender name="EELFAudit"
 174                 class="ch.qos.logback.core.rolling.RollingFileAppender">
 175                 <file>${logDirectory}/${auditLogName}.log</file>
 176                 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
 177                         <!-- daily roll over -->
 178                         <fileNamePattern>${logDirectory}/${auditLogName}.log.%d{yyyy-MM-dd}.zip
 179                         </fileNamePattern>
 180                         <maxHistory>30</maxHistory>
 181                 </rollingPolicy>
 182                 <encoder>
 183                         <pattern>${auditLoggerPattern}</pattern>
 184                 </encoder>
 185         </appender>
 186         <appender name="asyncEELFAudit" class="ch.qos.logback.classic.AsyncAppender">
 187                 <queueSize>256</queueSize>
 188                 <appender-ref ref="EELFAudit" />
 189         </appender>
 190
 191         <appender name="EELFMetrics"
 192                 class="ch.qos.logback.core.rolling.RollingFileAppender">
 193                 <file>${logDirectory}/${metricsLogName}.log</file>
 194                 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
 195                         <!-- daily roll over -->
 196                         <fileNamePattern>${logDirectory}/${metricsLogName}.log.%d{yyyy-MM-dd}.zip
 197                         </fileNamePattern>
 198                         <maxHistory>30</maxHistory>
 199                 </rollingPolicy>
 200                 <encoder>
 201                         <pattern>${metricsLoggerPattern}</pattern>
 202                 </encoder>
 203         </appender>
 204
 205
 206         <appender name="asyncEELFMetrics" class="ch.qos.logback.classic.AsyncAppender">
 207                 <queueSize>256</queueSize>
 208                 <appender-ref ref="EELFMetrics" />
 209         </appender>
 210
 211         <appender name="EELFError"
 212                 class="ch.qos.logback.core.rolling.RollingFileAppender">
 213                 <file>${logDirectory}/${errorLogName}.log</file>
 214                 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
 215                         <!-- daily roll over -->
 216                         <fileNamePattern>${logDirectory}/${errorLogName}.log.%d{yyyy-MM-dd}.zip
 217                         </fileNamePattern>
 218                         <maxHistory>30</maxHistory>
 219                 </rollingPolicy>
 220                 <encoder>
 221                         <pattern>${errorLoggerPattern}</pattern>
 222                 </encoder>
 223         </appender>
 224
 225         <appender name="asyncEELFError" class="ch.qos.logback.classic.AsyncAppender">
 226                 <queueSize>256</queueSize>
 227                 <appender-ref ref="EELFError" />
 228         </appender>
 229
 230         <appender name="EELFDebug"
 231                 class="ch.qos.logback.core.rolling.RollingFileAppender">
 232                 <file>${debugLogDirectory}/${debugLogName}.log</file>
 233                 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
 234                         <!-- daily roll over -->
 235                         <fileNamePattern>${logDirectory}/${debugLogName}.log.%d{yyyy-MM-dd}.zip
 236                         </fileNamePattern>
 237                         <maxHistory>30</maxHistory>
 238                 </rollingPolicy>
 239                 <encoder>
 240                         <pattern>${defaultLoggerPattern}</pattern>
 241                 </encoder>
 242         </appender>
 243
 244         <appender name="asyncEELFDebug" class="ch.qos.logback.classic.AsyncAppender">
 245                 <queueSize>256</queueSize>
 246                 <appender-ref ref="EELFDebug" />
 247                 <includeCallerData>true</includeCallerData>
 248         </appender>
 249
 250
 251         <!-- ============================================================================ -->
 252         <!-- EELF loggers -->
 253         <!-- ============================================================================ -->
 254         <logger name="com.att.eelf" level="info" additivity="false">
 255                 <appender-ref ref="asyncEELF" />
 256         </logger>
 257
 258         <!-- <logger name="com.att.eelf.security" level="info" additivity="false">
 259                 <appender-ref ref="asyncEELFSecurity" /> </logger> <logger name="com.att.eelf.perf"
 260                 level="info" additivity="false"> <appender-ref ref="asyncEELFPerformance"
 261                 /> </logger> <logger name="com.att.eelf.server" level="info" additivity="false">
 262                 <appender-ref ref="asyncEELFServer" /> </logger> <logger name="com.att.eelf.policy"
 263                 level="info" additivity="false"> <appender-ref ref="asyncEELFPolicy" /> </logger> -->
 264
 265         <logger name="com.att.eelf.audit" level="info" additivity="false">
 266                 <appender-ref ref="asyncEELFAudit" />
 267         </logger>
 268
 269         <logger name="com.att.eelf.metrics" level="info" additivity="false">
 270                 <appender-ref ref="asyncEELFMetrics" />
 271         </logger>
 272
 273         <logger name="com.att.eelf.error" level="info" additivity="false">
 274                 <appender-ref ref="asyncEELFError" />
 275         </logger>
 276
 277         <logger name="com.att.eelf.debug" level="debug" additivity="false">
 278                 <appender-ref ref="asyncEELFDebug" />
 279         </logger>
 280
 281         <root level="INFO">
 282                 <appender-ref ref="asyncEELF" />
 283         </root>
 284
 285 </configuration>