1 <?xml version="1.0" encoding="UTF-8"?>
3 ============LICENSE_START==========================================
5 ===================================================================
6 Copyright © 2017 AT&T Intellectual Property. All rights reserved.
7 ===================================================================
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
14 http://www.apache.org/licenses/LICENSE-2.0
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.
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
27 https://creativecommons.org/licenses/by/4.0/
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.
35 ============LICENSE_END============================================
37 ECOMP is a trademark and service mark of AT&T Intellectual Property.
39 <configuration scan="true" scanPeriod="3 seconds" debug="true">
41 Logback files for the ONAP Portal SDK Application
42 are created in directory ${catalina.base}/logs/${componentName}
43 e.g., apache-tomcat-8.0.35/logs/onapsdk/application.log
45 <!--<jmxConfigurator /> -->
46 <!-- specify the component name -->
47 <property name="componentName" value="onapsdk"></property>
48 <!-- specify the base path of the log directory -->
49 <property name="logDirPrefix" value="${catalina.base}/logs"></property>
50 <!-- The directories where logs are written -->
51 <property name="logDirectory" value="${logDirPrefix}/${componentName}" />
52 <!-- Can easily relocate debug logs by modifying this path. -->
53 <property name="debugLogDirectory" value="${logDirPrefix}/${componentName}" />
54 <!-- log file names -->
55 <property name="generalLogName" value="application" />
56 <property name="errorLogName" value="error" />
57 <property name="metricsLogName" value="metrics" />
58 <property name="auditLogName" value="audit" />
59 <property name="debugLogName" value="debug" />
61 These loggers are not used in code (yet).
62 <property name="securityLogName" value="security" /><property name="policyLogName" value="policy" /><property name="performanceLogName" value="performance" /><property name="serverLogName" value="server" />
64 <!-- 1610 Logging Fields Format Revisions -->
65 <property name="auditLoggerPattern" 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" />
66 <property name="metricsLoggerPattern" 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" />
67 <property name="errorLoggerPattern" 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" />
68 <property name="defaultLoggerPattern" value="%date{yyyy-MM-dd'T'HH:mm:ss.SSSXXX}|%X{RequestId}|%thread|%X{ClassName}| %msg%n" />
69 <!-- use %class so library logging calls yield their class name -->
70 <property name="applicationLoggerPattern" value="%date{yyyy-MM-dd'T'HH:mm:ss.SSSXXX}|%X{RequestId}|%thread|%class{36}| %msg%n" />
71 <!-- Example evaluator filter applied against console appender -->
72 <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
74 <pattern>${defaultLoggerPattern}</pattern>
77 <!-- ============================================================================ -->
78 <!-- EELF Appenders -->
79 <!-- ============================================================================ -->
80 <!-- The EELFAppender is used to record events to the general application
82 <appender name="EELF" class="ch.qos.logback.core.rolling.RollingFileAppender">
83 <file>${logDirectory}/${generalLogName}.log</file>
84 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
85 <!-- daily rollover -->
86 <fileNamePattern>${logDirectory}/${generalLogName}.%d{yyyy-MM-dd}.log.zip</fileNamePattern>
87 <!-- keep 30 days' worth of history capped at 3GB total size -->
88 <maxHistory>30</maxHistory>
89 <totalSizeCap>3GB</totalSizeCap>
92 <pattern>${applicationLoggerPattern}</pattern>
94 <filter class="org.onap.portalapp.util.CustomLoggingFilter" />
96 <appender name="asyncEELF" class="ch.qos.logback.classic.AsyncAppender">
97 <queueSize>256</queueSize>
98 <!-- Class name is part of caller data -->
99 <includeCallerData>true</includeCallerData>
100 <appender-ref ref="EELF" />
102 <!-- EELF Security Appender. This appender is used to record security events
103 to the security log file. Security events are separate from other loggers
104 in EELF so that security log records can be captured and managed in a secure
105 way separate from the other logs. This appender is set to never discard any
108 <appender name="EELFSecurity" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${logDirectory}/${securityLogName}.log</file><rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"><fileNamePattern>${logDirectory}/${securityLogName}.%i.log.zip
109 </fileNamePattern><minIndex>1</minIndex><maxIndex>9</maxIndex></rollingPolicy><triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"><maxFileSize>5MB</maxFileSize></triggeringPolicy><encoder><pattern>${defaultPattern}</pattern></encoder></appender><appender name="asyncEELFSecurity" class="ch.qos.logback.classic.AsyncAppender"><queueSize>256</queueSize><discardingThreshold>0</discardingThreshold><appender-ref ref="EELFSecurity" /></appender>
111 <!-- EELF Performance Appender. This appender is used to record performance
114 <appender name="EELFPerformance" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${logDirectory}/${performanceLogName}.log</file><rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"><fileNamePattern>${logDirectory}/${performanceLogName}.%i.log.zip
115 </fileNamePattern><minIndex>1</minIndex><maxIndex>9</maxIndex></rollingPolicy><triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"><maxFileSize>5MB</maxFileSize></triggeringPolicy><encoder><outputPatternAsHeader>true</outputPatternAsHeader><pattern>${defaultPattern}</pattern></encoder></appender><appender name="asyncEELFPerformance" class="ch.qos.logback.classic.AsyncAppender"><queueSize>256</queueSize><appender-ref ref="EELFPerformance" /></appender>
117 <!-- EELF Server Appender. This appender is used to record Server related
118 logging events. The Server logger and appender are specializations of the
119 EELF application root logger and appender. This can be used to segregate Server
120 events from other components, or it can be eliminated to record these events
121 as part of the application root log. -->
123 <appender name="EELFServer" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${logDirectory}/${serverLogName}.log</file><rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"><fileNamePattern>${logDirectory}/${serverLogName}.%i.log.zip
124 </fileNamePattern><minIndex>1</minIndex><maxIndex>9</maxIndex></rollingPolicy><triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"><maxFileSize>5MB</maxFileSize></triggeringPolicy><encoder><pattern>${defaultPattern}</pattern></encoder></appender><appender name="asyncEELFServer" class="ch.qos.logback.classic.AsyncAppender"><queueSize>256</queueSize><appender-ref ref="EELFServer" /></appender>
126 <!-- EELF Policy Appender. This appender is used to record Policy engine
127 related logging events. The Policy logger and appender are specializations
128 of the EELF application root logger and appender. This can be used to segregate
129 Policy engine events from other components, or it can be eliminated to record
130 these events as part of the application root log. -->
132 <appender name="EELFPolicy" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${logDirectory}/${policyLogName}.log</file><rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"><fileNamePattern>${logDirectory}/${policyLogName}.%i.log.zip
133 </fileNamePattern><minIndex>1</minIndex><maxIndex>9</maxIndex></rollingPolicy><triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"><maxFileSize>5MB</maxFileSize></triggeringPolicy><encoder><pattern>${defaultPattern}</pattern></encoder></appender><appender name="asyncEELFPolicy" class="ch.qos.logback.classic.AsyncAppender"><queueSize>256</queueSize><appender-ref ref="EELFPolicy" /></appender>
135 <!-- EELF Audit Appender. This appender is used to record audit engine
136 related logging events. The audit logger and appender are specializations
137 of the EELF application root logger and appender. This can be used to segregate
138 Policy engine events from other components, or it can be eliminated to record
139 these events as part of the application root log. -->
140 <appender name="EELFAudit" class="ch.qos.logback.core.rolling.RollingFileAppender">
141 <file>${logDirectory}/${auditLogName}.log</file>
142 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
143 <!-- daily rollover -->
144 <fileNamePattern>${logDirectory}/${auditLogName}.%d{yyyy-MM-dd}.log.zip</fileNamePattern>
145 <!-- keep 30 days' worth of history capped at 3GB total size -->
146 <maxHistory>30</maxHistory>
147 <totalSizeCap>3GB</totalSizeCap>
150 <pattern>${auditLoggerPattern}</pattern>
153 <appender name="asyncEELFAudit" class="ch.qos.logback.classic.AsyncAppender">
154 <queueSize>256</queueSize>
155 <appender-ref ref="EELFAudit" />
157 <appender name="EELFMetrics" class="ch.qos.logback.core.rolling.RollingFileAppender">
158 <file>${logDirectory}/${metricsLogName}.log</file>
159 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
160 <!-- daily rollover -->
161 <fileNamePattern>${logDirectory}/${metricsLogName}.%d{yyyy-MM-dd}.log.zip</fileNamePattern>
162 <!-- keep 30 days' worth of history capped at 3GB total size -->
163 <maxHistory>30</maxHistory>
164 <totalSizeCap>3GB</totalSizeCap>
167 <pattern>${metricsLoggerPattern}</pattern>
170 <appender name="asyncEELFMetrics" class="ch.qos.logback.classic.AsyncAppender">
171 <queueSize>256</queueSize>
172 <appender-ref ref="EELFMetrics"/>
174 <appender name="EELFError" class="ch.qos.logback.core.rolling.RollingFileAppender">
175 <file>${logDirectory}/${errorLogName}.log</file>
176 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
177 <!-- daily rollover -->
178 <fileNamePattern>${logDirectory}/${errorLogName}.%d{yyyy-MM-dd}.log.zip</fileNamePattern>
179 <!-- keep 30 days' worth of history capped at 3GB total size -->
180 <maxHistory>30</maxHistory>
181 <totalSizeCap>3GB</totalSizeCap>
184 <pattern>${errorLoggerPattern}</pattern>
187 <appender name="asyncEELFError" class="ch.qos.logback.classic.AsyncAppender">
188 <queueSize>256</queueSize>
189 <appender-ref ref="EELFError"/>
191 <appender name="EELFDebug" class="ch.qos.logback.core.rolling.RollingFileAppender">
192 <file>${debugLogDirectory}/${debugLogName}.log</file>
193 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
194 <!-- daily rollover -->
195 <fileNamePattern>${logDirectory}/${debugLogName}.%d{yyyy-MM-dd}.log.zip</fileNamePattern>
196 <!-- keep 30 days' worth of history capped at 3GB total size -->
197 <maxHistory>30</maxHistory>
198 <totalSizeCap>3GB</totalSizeCap>
201 <pattern>${defaultLoggerPattern}</pattern>
204 <appender name="asyncEELFDebug" class="ch.qos.logback.classic.AsyncAppender">
205 <queueSize>256</queueSize>
206 <appender-ref ref="EELFDebug" />
208 <logger name="org.onap.eelf" level="info" additivity="false">
209 <appender-ref ref="asyncEELF" />
211 <logger name="org.onap.eelf.audit" level="info" additivity="false">
212 <appender-ref ref="asyncEELFAudit" />
214 <logger name="org.onap.eelf.debug" level="debug" additivity="false">
215 <appender-ref ref="asyncEELFDebug" />
217 <logger name="org.onap.eelf.error" level="info" additivity="false">
218 <appender-ref ref="asyncEELFError" />
220 <logger name="org.onap.eelf.metrics" level="info" additivity="false">
221 <appender-ref ref="asyncEELFMetrics" />
224 <appender-ref ref="asyncEELF" />