ecomp-portal-BE-os/src/main/resources/logback.xml

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