ui/src/main/resources/logback.xml

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