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