1 <?xml version="1.0" encoding="UTF-8"?>
3 ================================================================================
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
12 http://www.apache.org/licenses/LICENSE-2.0
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 ================================================================================
22 <configuration scan="true" scanPeriod="3 seconds" debug="true">
24 Logback files for the ONAP Portal SDK Application "epsdk-app-os"
25 are created in directory ${catalina.base}/logs/epsdk_app_os;
26 e.g., apache-tomcat-8.0.35/logs/epsdk_app_os/application.log
28 <!--<jmxConfigurator /> -->
30 <!-- specify the component name -->
31 <property name="componentName" value="epsdk_app_os"></property>
33 <!-- specify the base path of the log directory -->
34 <property name="logDirPrefix" value="${catalina.base}/logs"></property>
36 <!-- The directories where logs are written -->
37 <property name="logDirectory" value="${logDirPrefix}/${componentName}" />
38 <!-- Can easily relocate debug logs by modifying this path. -->
39 <property name="debugLogDirectory" value="${logDirPrefix}/${componentName}" />
41 <!-- log file names -->
42 <property name="generalLogName" value="application" />
43 <property name="errorLogName" value="error" />
44 <property name="metricsLogName" value="metrics" />
45 <property name="auditLogName" value="audit" />
46 <property name="debugLogName" value="debug" />
48 These loggers are not used in code (yet).
49 <property name="securityLogName" value="security" />
50 <property name="policyLogName" value="policy" />
51 <property name="performanceLogName" value="performance" />
52 <property name="serverLogName" value="server" />
55 <!-- 1610 Logging Fields Format Revisions -->
56 <property name="auditLoggerPattern"
57 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" />
59 <property name="metricsLoggerPattern"
60 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" />
62 <property name="errorLoggerPattern"
63 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" />
65 <property name="defaultLoggerPattern"
66 value="%date{yyyy-MM-dd'T'HH:mm:ss.SSSXXX}|%X{RequestId}|%thread|%X{ClassName}| %msg%n" />
68 <!-- use %class so library logging calls yield their class name -->
69 <property name="applicationLoggerPattern"
70 value="%date{yyyy-MM-dd'T'HH:mm:ss.SSSXXX}|%X{RequestId}|%thread|%class{36}| %msg%n" />
72 <!-- Example evaluator filter applied against console appender -->
73 <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
75 <pattern>${defaultLoggerPattern}</pattern>
79 <!-- ============================================================================ -->
80 <!-- EELF Appenders -->
81 <!-- ============================================================================ -->
83 <!-- The EELFAppender is used to record events to the general application
88 class="ch.qos.logback.core.rolling.RollingFileAppender">
89 <file>${logDirectory}/${generalLogName}.log</file>
90 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
91 <!-- daily rollover -->
92 <fileNamePattern>${logDirectory}/${generalLogName}.%d{yyyy-MM-dd}.log.zip</fileNamePattern>
94 <!-- keep 30 days' worth of history capped at 3GB total size -->
95 <maxHistory>30</maxHistory>
96 <totalSizeCap>3GB</totalSizeCap>
100 <pattern>${applicationLoggerPattern}</pattern>
102 <filter class="org.onap.portalapp.util.CustomLoggingFilter" />
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" />
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
118 <appender name="EELFSecurity"
119 class="ch.qos.logback.core.rolling.RollingFileAppender">
120 <file>${logDirectory}/${securityLogName}.log</file>
122 class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
123 <fileNamePattern>${logDirectory}/${securityLogName}.%i.log.zip
125 <minIndex>1</minIndex>
126 <maxIndex>9</maxIndex>
129 class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
130 <maxFileSize>5MB</maxFileSize>
133 <pattern>${defaultPattern}</pattern>
137 <appender name="asyncEELFSecurity" class="ch.qos.logback.classic.AsyncAppender">
138 <queueSize>256</queueSize>
139 <discardingThreshold>0</discardingThreshold>
140 <appender-ref ref="EELFSecurity" />
144 <!-- EELF Performance Appender. This appender is used to record performance
147 <appender name="EELFPerformance"
148 class="ch.qos.logback.core.rolling.RollingFileAppender">
149 <file>${logDirectory}/${performanceLogName}.log</file>
151 class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
152 <fileNamePattern>${logDirectory}/${performanceLogName}.%i.log.zip
154 <minIndex>1</minIndex>
155 <maxIndex>9</maxIndex>
158 class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
159 <maxFileSize>5MB</maxFileSize>
162 <outputPatternAsHeader>true</outputPatternAsHeader>
163 <pattern>${defaultPattern}</pattern>
166 <appender name="asyncEELFPerformance" class="ch.qos.logback.classic.AsyncAppender">
167 <queueSize>256</queueSize>
168 <appender-ref ref="EELFPerformance" />
172 <!-- EELF Server Appender. This appender is used to record Server related
173 logging events. The Server logger and appender are specializations of the
174 EELF application root logger and appender. This can be used to segregate Server
175 events from other components, or it can be eliminated to record these events
176 as part of the application root log. -->
178 <appender name="EELFServer"
179 class="ch.qos.logback.core.rolling.RollingFileAppender">
180 <file>${logDirectory}/${serverLogName}.log</file>
182 class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
183 <fileNamePattern>${logDirectory}/${serverLogName}.%i.log.zip
185 <minIndex>1</minIndex>
186 <maxIndex>9</maxIndex>
189 class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
190 <maxFileSize>5MB</maxFileSize>
193 <pattern>${defaultPattern}</pattern>
196 <appender name="asyncEELFServer" class="ch.qos.logback.classic.AsyncAppender">
197 <queueSize>256</queueSize>
198 <appender-ref ref="EELFServer" />
202 <!-- EELF Policy Appender. This appender is used to record Policy engine
203 related logging events. The Policy logger and appender are specializations
204 of the EELF application root logger and appender. This can be used to segregate
205 Policy engine events from other components, or it can be eliminated to record
206 these events as part of the application root log. -->
208 <appender name="EELFPolicy"
209 class="ch.qos.logback.core.rolling.RollingFileAppender">
210 <file>${logDirectory}/${policyLogName}.log</file>
212 class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
213 <fileNamePattern>${logDirectory}/${policyLogName}.%i.log.zip
215 <minIndex>1</minIndex>
216 <maxIndex>9</maxIndex>
219 class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
220 <maxFileSize>5MB</maxFileSize>
223 <pattern>${defaultPattern}</pattern>
226 <appender name="asyncEELFPolicy" class="ch.qos.logback.classic.AsyncAppender">
227 <queueSize>256</queueSize>
228 <appender-ref ref="EELFPolicy" />
232 <!-- EELF Audit Appender. This appender is used to record audit engine
233 related logging events. The audit logger and appender are specializations
234 of the EELF application root logger and appender. This can be used to segregate
235 Policy engine events from other components, or it can be eliminated to record
236 these events as part of the application root log. -->
238 <appender name="EELFAudit"
239 class="ch.qos.logback.core.rolling.RollingFileAppender">
240 <file>${logDirectory}/${auditLogName}.log</file>
241 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
242 <!-- daily rollover -->
243 <fileNamePattern>${logDirectory}/${auditLogName}.%d{yyyy-MM-dd}.log.zip</fileNamePattern>
245 <!-- keep 30 days' worth of history capped at 3GB total size -->
246 <maxHistory>30</maxHistory>
247 <totalSizeCap>3GB</totalSizeCap>
251 <pattern>${auditLoggerPattern}</pattern>
254 <appender name="asyncEELFAudit" class="ch.qos.logback.classic.AsyncAppender">
255 <queueSize>256</queueSize>
256 <appender-ref ref="EELFAudit" />
259 <appender name="EELFMetrics"
260 class="ch.qos.logback.core.rolling.RollingFileAppender">
261 <file>${logDirectory}/${metricsLogName}.log</file>
262 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
263 <!-- daily rollover -->
264 <fileNamePattern>${logDirectory}/${metricsLogName}.%d{yyyy-MM-dd}.log.zip</fileNamePattern>
266 <!-- keep 30 days' worth of history capped at 3GB total size -->
267 <maxHistory>30</maxHistory>
268 <totalSizeCap>3GB</totalSizeCap>
272 <pattern>${metricsLoggerPattern}</pattern>
277 <appender name="asyncEELFMetrics" class="ch.qos.logback.classic.AsyncAppender">
278 <queueSize>256</queueSize>
279 <appender-ref ref="EELFMetrics"/>
282 <appender name="EELFError"
283 class="ch.qos.logback.core.rolling.RollingFileAppender">
284 <file>${logDirectory}/${errorLogName}.log</file>
285 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
286 <!-- daily rollover -->
287 <fileNamePattern>${logDirectory}/${errorLogName}.%d{yyyy-MM-dd}.log.zip</fileNamePattern>
289 <!-- keep 30 days' worth of history capped at 3GB total size -->
290 <maxHistory>30</maxHistory>
291 <totalSizeCap>3GB</totalSizeCap>
295 <pattern>${errorLoggerPattern}</pattern>
299 <appender name="asyncEELFError" class="ch.qos.logback.classic.AsyncAppender">
300 <queueSize>256</queueSize>
301 <appender-ref ref="EELFError"/>
304 <appender name="EELFDebug"
305 class="ch.qos.logback.core.rolling.RollingFileAppender">
306 <file>${debugLogDirectory}/${debugLogName}.log</file>
307 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
308 <!-- daily rollover -->
309 <fileNamePattern>${logDirectory}/${debugLogName}.%d{yyyy-MM-dd}.log.zip</fileNamePattern>
311 <!-- keep 30 days' worth of history capped at 3GB total size -->
312 <maxHistory>30</maxHistory>
313 <totalSizeCap>3GB</totalSizeCap>
317 <pattern>${defaultLoggerPattern}</pattern>
321 <appender name="asyncEELFDebug" class="ch.qos.logback.classic.AsyncAppender">
322 <queueSize>256</queueSize>
323 <appender-ref ref="EELFDebug" />
329 <logger name="org.onap.eelf" level="info" additivity="false">
330 <appender-ref ref="asyncEELF" />
333 <logger name="org.onap.eelf.audit" level="info" additivity="false">
334 <appender-ref ref="asyncEELFAudit" />
337 <logger name="org.onap.eelf.debug" level="debug" additivity="false">
338 <appender-ref ref="asyncEELFDebug" />
341 <logger name="org.onap.eelf.error" level="info" additivity="false">
342 <appender-ref ref="asyncEELFError" />
345 <logger name="org.onap.eelf.metrics" level="info" additivity="false">
346 <appender-ref ref="asyncEELFMetrics" />
350 <appender-ref ref="asyncEELF" />