[LOG] Add canonicalization for Portal logs

Canonicalization of path for log provider configuration file and log files

Change-Id: Ia669aaff2b9516a7da97c64fe76cdd0297a5dfc6
Issue-ID: LOG-26
Signed-off-by: Vidya Shinde <vidya.shinde@amdocs.com>

1 files changed, 244 insertions, 0 deletions

diff --git a/onap/portal/portal-be/conf/logback.xml b/onap/portal/portal-be/conf/logback.xml
new file mode 100644
index 0000000..1b16f71
--- /dev/null
+++ b/onap/portal/portal-be/conf/logback.xml
@@ -0,0 +1,244 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  ================================================================================
+  eCOMP Portal
+  ================================================================================
+  Copyright (C) 2017 AT&T Intellectual Property
+  ================================================================================
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+  
+       http://www.apache.org/licenses/LICENSE-2.0
+  
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+  ================================================================================
+  -->
+<!DOCTYPE xml>
+<configuration debug="true" scan="true" scanPeriod="3 seconds">
+    <!-- Log-back files for the ECOMP Portal "ecompportal" are created in directory 
+                ${catalina.base}/logs/ecompportal; e.g., apache-tomcat-8.0.35/logs/ecompportal/application.log -->
+    <!--<jmxConfigurator /> -->
+    <!-- specify the component name -->
+    <property name="componentName" value="portal"></property>
+    <property name="subComponentName" value="portalBE"></property>
+    <!-- specify the base path of the log directory -->
+    <property name="logDirPrefix" value="/var/log/onap"></property>
+    <!-- The directories where logs are written -->
+    <property name="logDirectory" value="${logDirPrefix}/${componentName}/${subComponentName}" />
+    <!-- Can easily relocate debug logs by modifying this path. -->
+    <property name="debugLogDirectory" value="${logDirPrefix}/${componentName}/${subComponentName}" />
+    <!-- log file names -->
+    <property name="generalLogName" value="application" />
+    <property name="errorLogName" value="error" />
+    <property name="metricsLogName" value="metrics" />
+    <property name="auditLogName" value="audit" />
+    <property name="debugLogName" value="debug" />
+    <!-- These loggers are not used in code (yet). <property name="securityLogName" 
+                value="security" /> <property name="policyLogName" value="policy" /> <property 
+                name="performanceLogName" value="performance" /> <property name="serverLogName" 
+                value="server" /> -->
+    <!-- ServerFQDN=Server,  -->
+    <property name="pattern" value="%d{&quot;yyyy-MM-dd'T'HH:mm:ss.SSSXXX&quot;, UTC}\t[%thread]\t%-5level\t%logger{36}\t%replace(%replace(%replace(%mdc){'\t','\\\\t'}){', ','\t'}){'\n', '\\\\n'}\t%replace(%replace(%msg){'\n', '\\\\n'}){'\t','\\\\t'}%n" />
+    <property name="maxHistory" value="30" />
+    <property name="queueSize" value="256" />
+    <property name="maxFileSize" value="50MB" />
+    <property name="totalSizeCap" value="10GB" />
+    <!-- Example evaluator filter applied against console appender -->
+    <appender class="ch.qos.logback.core.ConsoleAppender" name="STDOUT">
+        <encoder>
+            <pattern>${pattern}</pattern>
+        </encoder>
+    </appender>
+    <!-- ============================================================================ -->
+    <!-- EELF Appenders -->
+    <!-- ============================================================================ -->
+    <!-- The EELFAppender is used to record events to the general application 
+                log -->
+    <appender class="ch.qos.logback.core.rolling.RollingFileAppender" name="EELF">
+        <file>${logDirectory}/${generalLogName}.log</file>
+        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+            <!-- daily rollover -->
+            <fileNamePattern>${logDirectory}/${generalLogName}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
+            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
+                <maxFileSize>${maxFileSize}</maxFileSize>
+            </timeBasedFileNamingAndTriggeringPolicy>
+            <maxHistory>${maxHistory}</maxHistory>
+            <totalSizeCap>${totalSizeCap}</totalSizeCap>
+        </rollingPolicy>
+        <encoder>
+            <pattern>${pattern}</pattern>
+        </encoder>
+        <filter class="org.openecomp.portalapp.portal.utils.CustomLoggingFilter" />
+    </appender>
+    <appender class="ch.qos.logback.classic.AsyncAppender" name="asyncEELF">
+        <queueSize>${queueSize}</queueSize>
+        <!-- Class name is part of caller data -->
+        <includeCallerData>true</includeCallerData>
+        <appender-ref ref="EELF" />
+    </appender>
+    <!-- EELF Security Appender. This appender is used to record security events 
+                to the security log file. Security events are separate from other loggers 
+                in EELF so that security log records can be captured and managed in a secure 
+                way separate from the other logs. This appender is set to never discard any 
+                events. -->
+    <!-- <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 </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> -->
+    <!-- EELF Performance Appender. This appender is used to record performance 
+                records. -->
+    <!-- <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 </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> -->
+    <!-- EELF Server Appender. This appender is used to record Server related 
+                logging events. The Server logger and appender are specializations of the 
+                EELF application root logger and appender. This can be used to segregate 
+                Server events from other components, or it can be eliminated to record these 
+                events as part of the application root log. -->
+    <!-- <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 </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> -->
+    <!-- EELF Policy Appender. This appender is used to record Policy engine 
+                related logging events. The Policy logger and appender are specializations 
+                of the EELF application root logger and appender. This can be used to segregate 
+                Policy engine events from other components, or it can be eliminated to record 
+                these events as part of the application root log. -->
+    <!-- <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 </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> -->
+    <!-- EELF Audit Appender. This appender is used to record audit engine related 
+                logging events. The audit logger and appender are specializations of the 
+                EELF application root logger and appender. This can be used to segregate 
+                Policy engine events from other components, or it can be eliminated to record 
+                these events as part of the application root log. -->
+    <appender class="ch.qos.logback.core.rolling.RollingFileAppender" name="EELFAudit">
+        <file>${logDirectory}/${auditLogName}.log</file>
+        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+            <!-- daily roll over -->
+            <fileNamePattern>${logDirectory}/${auditLogName}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
+            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
+                <maxFileSize>${maxFileSize}</maxFileSize>
+            </timeBasedFileNamingAndTriggeringPolicy>
+            <maxHistory>${maxHistory}</maxHistory>
+            <totalSizeCap>${totalSizeCap}</totalSizeCap>
+        </rollingPolicy>
+        <encoder>
+            <pattern>${pattern}</pattern>
+        </encoder>
+    </appender>
+    <appender class="ch.qos.logback.classic.AsyncAppender" name="asyncEELFAudit">
+        <queueSize>${queueSize}</queueSize>
+        <appender-ref ref="EELFAudit" />
+    </appender>
+    <appender class="ch.qos.logback.core.rolling.RollingFileAppender" name="EELFMetrics">
+        <file>${logDirectory}/${metricsLogName}.log</file>
+        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+            <!-- daily roll over -->
+            <fileNamePattern>${logDirectory}/${metricsLogName}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
+            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
+                <maxFileSize>${maxFileSize}</maxFileSize>
+            </timeBasedFileNamingAndTriggeringPolicy>
+            <maxHistory>${maxHistory}</maxHistory>
+            <totalSizeCap>${totalSizeCap}</totalSizeCap>
+        </rollingPolicy>
+        <encoder>
+            <pattern>${pattern}</pattern>
+        </encoder>
+    </appender>
+    <appender class="ch.qos.logback.classic.AsyncAppender" name="asyncEELFMetrics">
+        <queueSize>${queueSize}</queueSize>
+        <appender-ref ref="EELFMetrics" />
+    </appender>
+    <appender class="ch.qos.logback.core.rolling.RollingFileAppender" name="EELFError">
+        <file>${logDirectory}/${errorLogName}.log</file>
+        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+            <!-- daily roll over -->
+            <fileNamePattern>${logDirectory}/${errorLogName}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
+            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
+                <maxFileSize>${maxFileSize}</maxFileSize>
+            </timeBasedFileNamingAndTriggeringPolicy>
+            <maxHistory>${maxHistory}</maxHistory>
+            <totalSizeCap>${totalSizeCap}</totalSizeCap>
+        </rollingPolicy>
+        <encoder>
+            <pattern>${pattern}</pattern>
+        </encoder>
+    </appender>
+    <appender class="ch.qos.logback.classic.AsyncAppender" name="asyncEELFError">
+        <queueSize>${queueSize}</queueSize>
+        <appender-ref ref="EELFError" />
+    </appender>
+    <appender class="ch.qos.logback.core.rolling.RollingFileAppender" name="EELFDebug">
+        <file>${debugLogDirectory}/${debugLogName}.log</file>
+        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+            <!-- daily roll over -->
+            <fileNamePattern>${logDirectory}/${debugLogName}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
+            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
+                <maxFileSize>${maxFileSize}</maxFileSize>
+            </timeBasedFileNamingAndTriggeringPolicy>
+            <maxHistory>${maxHistory}</maxHistory>
+            <totalSizeCap>${totalSizeCap}</totalSizeCap>
+        </rollingPolicy>
+        <encoder>
+            <pattern>${pattern}</pattern>
+        </encoder>
+    </appender>
+    <appender class="ch.qos.logback.classic.AsyncAppender" name="asyncEELFDebug">
+        <queueSize>${queueSize}</queueSize>
+        <appender-ref ref="EELFDebug" />
+        <includeCallerData>true</includeCallerData>
+    </appender>
+    <!-- ============================================================================ -->
+    <!-- EELF loggers -->
+    <!-- ============================================================================ -->
+    <logger additivity="false" level="info" name="com.att.eelf">
+        <appender-ref ref="asyncEELF" />
+    </logger>
+    <!-- <logger name="com.att.eelf.security" level="info" additivity="false"> 
+                <appender-ref ref="asyncEELFSecurity" /> </logger> <logger name="com.att.eelf.perf" 
+                level="info" additivity="false"> <appender-ref ref="asyncEELFPerformance" 
+                /> </logger> <logger name="com.att.eelf.server" level="info" additivity="false"> 
+                <appender-ref ref="asyncEELFServer" /> </logger> <logger name="com.att.eelf.policy" 
+                level="info" additivity="false"> <appender-ref ref="asyncEELFPolicy" /> </logger> -->
+    <logger additivity="false" level="info" name="com.att.eelf.audit">
+        <appender-ref ref="asyncEELFAudit" />
+    </logger>
+    <logger additivity="false" level="info" name="com.att.eelf.metrics">
+        <appender-ref ref="asyncEELFMetrics" />
+    </logger>
+    <logger additivity="false" level="info" name="com.att.eelf.error">
+        <appender-ref ref="asyncEELFError" />
+    </logger>
+    <logger additivity="false" level="debug" name="com.att.eelf.debug">
+        <appender-ref ref="asyncEELFDebug" />
+    </logger>
+    <root level="INFO">
+        <appender-ref ref="asyncEELF" />
+    </root>
+</configuration>