From 7a2c23b3ad83eab0eed5b990c70a1603447d5ee5 Mon Sep 17 00:00:00 2001
From: "Singla, Rajiv (rs153v)" <rs153v@att.com>
Date: Wed, 15 Aug 2018 11:46:10 -0400
Subject: Standalone TCA with EELF Logger

Issue-ID: DCAEGEN2-633
Change-Id: I4da76b532021c0d6248455e7bd6e77f4614c35a7
Signed-off-by: Singla, Rajiv (rs153v) <rs153v@att.com>
---
 ....onap.dcae.utils.eelf.logger.api.log.EELFLogger |  20 ++++
 .../src/main/resources/eelf-async-appenders.xml    |  55 ++++++++++
 .../src/main/resources/eelf-defaults.xml           |  51 ++++++++++
 .../src/main/resources/eelf-logback.xml            |  45 +++++++++
 .../src/main/resources/eelf-optional-appenders.xml |  68 +++++++++++++
 .../src/main/resources/eelf-required-appenders.xml | 112 +++++++++++++++++++++
 6 files changed, 351 insertions(+)
 create mode 100644 eelf-logger/eelf-logger-logback-impl/src/main/resources/META-INF/services/org.onap.dcae.utils.eelf.logger.api.log.EELFLogger
 create mode 100644 eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-async-appenders.xml
 create mode 100644 eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-defaults.xml
 create mode 100644 eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-logback.xml
 create mode 100644 eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-optional-appenders.xml
 create mode 100644 eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-required-appenders.xml

(limited to 'eelf-logger/eelf-logger-logback-impl/src/main/resources')

diff --git a/eelf-logger/eelf-logger-logback-impl/src/main/resources/META-INF/services/org.onap.dcae.utils.eelf.logger.api.log.EELFLogger b/eelf-logger/eelf-logger-logback-impl/src/main/resources/META-INF/services/org.onap.dcae.utils.eelf.logger.api.log.EELFLogger
new file mode 100644
index 0000000..d7d5c71
--- /dev/null
+++ b/eelf-logger/eelf-logger-logback-impl/src/main/resources/META-INF/services/org.onap.dcae.utils.eelf.logger.api.log.EELFLogger
@@ -0,0 +1,20 @@
+#
+# ================================================================================
+# Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
+# ================================================================================
+# 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.
+# ============LICENSE_END=========================================================
+#
+#
+
+org.onap.dcae.utils.eelf.logger.logback.log.EELFLoggerImpl
diff --git a/eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-async-appenders.xml b/eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-async-appenders.xml
new file mode 100644
index 0000000..e2e93e4
--- /dev/null
+++ b/eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-async-appenders.xml
@@ -0,0 +1,55 @@
+<!--
+  ~ ================================================================================
+  ~ Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
+  ~ ================================================================================
+  ~ 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.
+  ~ ============LICENSE_END=========================================================
+  ~
+  -->
+
+<included>
+
+    <!--
+        ASYNC APPENDERS CAN BE USED TO INCREASE THE PERFORMANCE OF ECOMP LOGGING, HOWEVER, ASYNC LOGGERS
+        CAN DROP MESSAGES IF QUEUE SIZE IF FULL AND DURING SHUT DOWN TIME.
+
+        SO INCREASED PERFORMANCE AT THE COST OF LESS RELIABLE LOGGING
+     -->
+
+    <appender name="asyncAuditLogAppender" class="ch.qos.logback.classic.AsyncAppender">
+        <queueSize>${queueSize}</queueSize>
+        <maxFlushTime>${maxFlushTime}</maxFlushTime>
+        <appender-ref ref="auditLogAppender"/>
+    </appender>
+
+    <appender name="asyncMetricLogAppender" class="ch.qos.logback.classic.AsyncAppender">
+        <queueSize>${queueSize}</queueSize>
+        <maxFlushTime>${maxFlushTime}</maxFlushTime>
+        <appender-ref ref="metricLogAppender"/>
+    </appender>
+
+    <appender name="asyncErrorLogAppender" class="ch.qos.logback.classic.AsyncAppender">
+        <queueSize>${queueSize}</queueSize>
+        <maxFlushTime>${maxFlushTime}</maxFlushTime>
+        <appender-ref ref="errorLogAppender"/>
+    </appender>
+
+    <appender name="asyncDebugLogAppender" class="ch.qos.logback.classic.AsyncAppender">
+        <queueSize>${queueSize}</queueSize>
+        <maxFlushTime>${maxFlushTime}</maxFlushTime>
+        <appender-ref ref="debugLogAppender"/>
+    </appender>
+
+</included>
+
+
diff --git a/eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-defaults.xml b/eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-defaults.xml
new file mode 100644
index 0000000..f9bb078
--- /dev/null
+++ b/eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-defaults.xml
@@ -0,0 +1,51 @@
+<!--
+  ~ ================================================================================
+  ~ Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
+  ~ ================================================================================
+  ~ 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.
+  ~ ============LICENSE_END=========================================================
+  ~
+  -->
+
+<included>
+
+    <!-- LOG DIRECTORIES -->
+    <property scope="context" name="logDir" value="logs"/>
+    <property scope="context" name="debugDir" value="debug-logs"/>
+
+    <!-- SETUP LOG DIRECTORIES -->
+    <property scope="context" name="logDirectory" value="${logDir}/${componentName}"/>
+    <property scope="context" name="debugLogDirectory" value="${debugDir}/${componentName}"/>
+
+    <!--
+    MODIFY LOG DIR ON WINDOWS OS SO THAT TEST LOGS ARE UNDER TARGET DIR CAN BE CLEANED AFTER TESTS AUTOMATICALLY
+     -->
+    <property scope="context" name="modifyLogPathInWindows" value="true" />
+    <property scope="context" name="appendDirectory" value="target" />
+
+    <!-- LOG FILE NAMES -->
+    <property scope="context" name="metricLogName" value="metrics"/>
+    <property scope="context" name="auditLogName" value="audit"/>
+    <property scope="context" name="errorLogName" value="error"/>
+    <property scope="context" name="debugLogName" value="debug"/>
+
+    <!-- ROLLING FILE APPENDER DEFAULT SETTINGS -->
+    <property scope="context" name="minFileIndex" value="1"/>
+    <property scope="context" name="maxFileIndex" value="10"/>
+    <property scope="context" name="maxFileSize" value="2500KB"/>
+
+    <!-- ASYNC APPENDER DEFAULT SETTINGS -->
+    <property scope="context" name="queueSize" value="1024"/>
+    <property scope="context" name="maxFlushTime" value="5000"/>
+
+</included>
diff --git a/eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-logback.xml b/eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-logback.xml
new file mode 100644
index 0000000..7e08eb2
--- /dev/null
+++ b/eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-logback.xml
@@ -0,0 +1,45 @@
+<!--
+  ~ ================================================================================
+  ~ Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
+  ~ ================================================================================
+  ~ 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.
+  ~ ============LICENSE_END=========================================================
+  ~
+  -->
+
+<included>
+
+    <include resource="eelf-defaults.xml"/>
+
+    <!-- CUSTOM STARTUP LISTENER REQUIRED TO SETUP DEFAULT APP LOG INFO DURING STARTUP TIME-->
+    <contextListener class="org.onap.dcae.utils.eelf.logger.logback.listener.LogbackStartupListener"/>
+
+    <!-- ADD REQUIRED APPENDERS -->
+    <include resource="eelf-required-appenders.xml"/>
+
+    <!-- ADD OPTIONAL APPENDERS: NOT ADDED BY DEFAULT -->
+    <!--<include resource="eelf-optional-appenders.xml"/>-->
+
+
+    <root level="DEBUG">
+        <!-- required appenders -->
+        <appender-ref ref="auditLogAppender"/>
+        <appender-ref ref="metricLogAppender"/>
+        <appender-ref ref="errorLogAppender"/>
+
+        <!-- optional appenders: not added by default -->
+        <!--<appender-ref ref="debugLogAppender"/>-->
+        <!--<appender-ref ref="STDOUT"/>-->
+    </root>
+
+</included>
diff --git a/eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-optional-appenders.xml b/eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-optional-appenders.xml
new file mode 100644
index 0000000..fb7ec7f
--- /dev/null
+++ b/eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-optional-appenders.xml
@@ -0,0 +1,68 @@
+<!--
+  ~ ================================================================================
+  ~ Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
+  ~ ================================================================================
+  ~ 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.
+  ~ ============LICENSE_END=========================================================
+  ~
+  -->
+
+<included>
+
+    <!--
+     ============================= DEBUG LOG APPENDER ================================
+     -->
+    <appender name="debugLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
+
+        <filter class="org.onap.dcae.utils.eelf.logger.logback.filter.MarkerFilter">
+            <markers>DEBUG_LOG</markers>
+            <onMatch>ACCEPT</onMatch>
+            <onMismatch>DENY</onMismatch>
+        </filter>
+
+        <file>${debugLogDirectory}/${debugLogName}.log</file>
+
+        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
+            <fileNamePattern>${logDirectory}/${debugLogName}.%i.log.zip</fileNamePattern>
+            <minIndex>${minFileIndex}</minIndex>
+            <maxIndex>${maxFileIndex}</maxIndex>
+        </rollingPolicy>
+
+        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
+            <maxFileSize>${maxFileSize}</maxFileSize>
+        </triggeringPolicy>
+
+        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
+            <layout class="org.onap.dcae.utils.eelf.logger.logback.layout.DebugLogLayout"/>
+        </encoder>
+
+    </appender>
+
+
+    <!--
+      ============================= CONSOLE APPENDER ================================
+     -->
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+
+        <filter class="org.onap.dcae.utils.eelf.logger.logback.filter.MarkerFilter">
+            <markers>METRIC_LOG,AUDIT_LOG,ERROR_LOG,DEBUG_LOG</markers>
+            <onMatch>ACCEPT</onMatch>
+            <onMismatch>DENY</onMismatch>
+        </filter>
+
+        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
+            <layout class="org.onap.dcae.utils.eelf.logger.logback.layout.ConsoleLayout"/>
+        </encoder>
+    </appender>
+
+</included>
diff --git a/eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-required-appenders.xml b/eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-required-appenders.xml
new file mode 100644
index 0000000..72f1a5d
--- /dev/null
+++ b/eelf-logger/eelf-logger-logback-impl/src/main/resources/eelf-required-appenders.xml
@@ -0,0 +1,112 @@
+<!--
+  ~ ================================================================================
+  ~ Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
+  ~ ================================================================================
+  ~ 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.
+  ~ ============LICENSE_END=========================================================
+  ~
+  -->
+
+<included>
+
+    <!--
+     ============================= AUDIT LOG APPENDER ================================
+     -->
+    <appender name="auditLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
+
+        <filter class="org.onap.dcae.utils.eelf.logger.logback.filter.MarkerFilter">
+            <markers>AUDIT_LOG</markers>
+            <onMatch>ACCEPT</onMatch>
+            <onMismatch>DENY</onMismatch>
+        </filter>
+
+        <file>${logDirectory}/${auditLogName}.log</file>
+
+        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
+            <fileNamePattern>${logDirectory}/${auditLogName}.%i.log.zip</fileNamePattern>
+            <minIndex>${minFileIndex}</minIndex>
+            <maxIndex>${maxFileIndex}</maxIndex>
+        </rollingPolicy>
+
+        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
+            <maxFileSize>${maxFileSize}</maxFileSize>
+        </triggeringPolicy>
+
+        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
+            <layout class="org.onap.dcae.utils.eelf.logger.logback.layout.AuditLogLayout"/>
+        </encoder>
+
+    </appender>
+
+
+    <!--
+     ============================= METRIC LOG APPENDER ================================
+     -->
+    <appender name="metricLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
+
+        <filter class="org.onap.dcae.utils.eelf.logger.logback.filter.MarkerFilter">
+            <markers>METRIC_LOG</markers>
+            <onMatch>ACCEPT</onMatch>
+            <onMismatch>DENY</onMismatch>
+        </filter>
+
+        <file>${logDirectory}/${metricLogName}.log</file>
+
+        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
+            <fileNamePattern>${logDirectory}/${metricLogName}.%i.log.zip</fileNamePattern>
+            <minIndex>${minFileIndex}</minIndex>
+            <maxIndex>${maxFileIndex}</maxIndex>
+        </rollingPolicy>
+
+        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
+            <maxFileSize>${maxFileSize}</maxFileSize>
+        </triggeringPolicy>
+
+        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
+            <layout class="org.onap.dcae.utils.eelf.logger.logback.layout.MetricLogLayout"/>
+        </encoder>
+
+    </appender>
+
+
+    <!--
+     ============================= ERROR LOG APPENDER ================================
+    -->
+    <appender name="errorLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
+
+        <filter class="org.onap.dcae.utils.eelf.logger.logback.filter.MarkerFilter">
+            <markers>ERROR_LOG</markers>
+            <onMatch>ACCEPT</onMatch>
+            <onMismatch>DENY</onMismatch>
+        </filter>
+
+        <file>${logDirectory}/${errorLogName}.log</file>
+
+        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
+            <fileNamePattern>${logDirectory}/${errorLogName}.%i.log.zip</fileNamePattern>
+            <minIndex>${minFileIndex}</minIndex>
+            <maxIndex>${maxFileIndex}</maxIndex>
+        </rollingPolicy>
+
+        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
+            <maxFileSize>${maxFileSize}</maxFileSize>
+        </triggeringPolicy>
+
+        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
+            <layout class="org.onap.dcae.utils.eelf.logger.logback.layout.ErrorLogLayout"/>
+        </encoder>
+
+    </appender>
+
+
+</included>
-- 
cgit 1.2.3-korg