epsdk-app-onap/src/main/resources/logback.xml

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