diff options
| author |   Jorge Hernandez <jorge.hernandez-herrero@att.com> | 2019-03-25 15:43:23 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2019-03-25 15:43:23 +0000 |
| commit | 92cb38f9137d80328445d7b22cb51716783e3aea (patch) | |
| tree | 1785473356cad3351d5512d648a0f8582f4e6d35 | |
| parent | 3748b447876019681edce86942089a3652232ecc (diff) | |
| parent | 89d3441bb04047d63ff8f4f586773d7c287e1deb (diff) | |
Merge "Add MDC Topic Filtering"
16 files changed, 1877 insertions, 288 deletions
diff --git a/feature-eelf/src/main/feature/config/logback-eelf.xml b/feature-eelf/src/main/feature/config/logback-eelf.xml index 90b7f45e..c70a57a3 100644 --- a/feature-eelf/src/main/feature/config/logback-eelf.xml +++ b/feature-eelf/src/main/feature/config/logback-eelf.xml @@ -20,172 +20,166 @@ <configuration scan="true" scanPeriod="60 seconds" debug="false"> - <property name="errorLogName" value="error" /> - <property name="metricsLogName" value="metrics" /> - <property name="auditLogName" value="audit" /> - <property name="debugLogName" value="debug" /> - <property name="networkLogName" value="network" /> - - <property name="defaultPattern" - value="%X{BeginTimestamp}|%X{EndTimestamp}|%X{RequestID}|%X{ServiceInstanceId}|%thread|%X{ServerName}|%X{ServiceName}|%X{PartnerName}|%X{TargetEntity}|%X{TargetServiceName}|%X{StatusCode}|%X{ResponseCode}|%X{ResponseDescription}|%X{InstanceUUID}|%.-5level|%X{AlertSeverity}|%X{ServerIPAddress}|%X{ElapsedTime}|%X{ServerFQDN}|%X{RemoteHost}|%X{ClassName}||%X{ProcessKey}|%X{TargetVirtualEntity}|%X{CustomField1}|%X{CustomField2}|%X{CustomField3}|%X{CustomField4}|%msg%n" /> - <property name="defaultMetricPattern" - value="%X{BeginTimestamp}|%X{EndTimestamp}|%X{RequestID}|%X{ServiceInstanceId}|%thread|%X{ServerName}|%X{ServiceName}|%X{PartnerName}|%X{TargetEntity}|%X{TargetServiceName}|%X{StatusCode}|%X{ResponseCode}|%X{ResponseDescription}|%X{InstanceUUID}|%.-5level|%X{AlertSeverity}|%X{ServerIPAddress}|%X{ElapsedTime}|%X{ServerFQDN}|%X{RemoteHost}|%X{ClassName}||%X{ProcessKey}|%X{TargetVirtualEntity}|%X{CustomField1}|%X{CustomField2}|%X{CustomField3}|%X{CustomField4}|%msg%n" /> - <property name="defaultAuditPattern" - value="%X{BeginTimestamp}|%X{EndTimestamp}|%X{RequestID}|%X{ServiceInstanceId}|%thread|%X{ServerName}|%X{ServiceName}|%X{PartnerName}|%X{StatusCode}|%X{ResponseCode}|%X{ResponseDescription}|%X{InstanceUUID}|%.-5level|%X{AlertSeverity}|%X{ServerIPAddress}|%X{ElapsedTime}|%X{ServerFQDN}|%X{RemoteHost}|%X{ClassName}||%X{ProcessKey}|%X{CustomField1}|%X{CustomField2}|%X{CustomField3}|%X{CustomField4}|%msg%n" /> - <property name="defaultErrorPattern" - value="%d{yyyy-MM-dd'T'HH:mm:ss.SSS+00:00, UTC}|%X{RequestID}|%thread|%X{ServiceName}|%X{PartnerName}|%X{TargetEntity}|%X{TargetServiceName}|%X{ErrorCategory}|%X{ErrorCode}|%X{ErrorDesciption}|%msg%replace(%xException){'\n',' - '}%nopex%n" /> - - <property name="networkPattern" value="[%d|%t]%m%n" /> - <property name="debugPattern" value="[%date|%level|%logger{0}|%thread] %replace(%msg){'\n', ' '}%n" /> - - <property name="logDirectory" value="logs/Policy" /> - <property name="debugLogDirectory" value="logs/Policy" /> - - <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> - <encoder> - <pattern>${defaultPattern}</pattern> - </encoder> - </appender> - - <appender name="EELFAudit" - class="ch.qos.logback.core.rolling.RollingFileAppender"> - <file>${logDirectory}/${auditLogName}.log</file> - <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> - <fileNamePattern>${logDirectory}/${auditLogName}.%i.log.zip - </fileNamePattern> - <minIndex>1</minIndex> - <maxIndex>5</maxIndex> - </rollingPolicy> - <triggeringPolicy - class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> - <maxFileSize>10MB</maxFileSize> - </triggeringPolicy> - <encoder> - <pattern>${defaultAuditPattern}</pattern> - </encoder> - </appender> - - <appender name="asyncEELFAudit" class="ch.qos.logback.classic.AsyncAppender"> - <appender-ref ref="EELFAudit" /> - </appender> - - <appender name="EELFMetrics" - class="ch.qos.logback.core.rolling.RollingFileAppender"> - <file>${logDirectory}/${metricsLogName}.log</file> - <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> - <fileNamePattern>${logDirectory}/${metricsLogName}.%i.log.zip - </fileNamePattern> - <minIndex>1</minIndex> - <maxIndex>5</maxIndex> - </rollingPolicy> - <triggeringPolicy - class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> - <maxFileSize>15MB</maxFileSize> - </triggeringPolicy> - <encoder> - <pattern>${defaultMetricPattern}</pattern> - </encoder> - </appender> - - - <appender name="asyncEELFMetrics" class="ch.qos.logback.classic.AsyncAppender"> - <appender-ref ref="EELFMetrics" /> - </appender> - - <appender name="EELFError" - class="ch.qos.logback.core.rolling.RollingFileAppender"> - <file>${logDirectory}/${errorLogName}.log</file> - <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> - <fileNamePattern>${logDirectory}/${errorLogName}.%i.log.zip - </fileNamePattern> - <minIndex>1</minIndex> - <maxIndex>5</maxIndex> - </rollingPolicy> - <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> - <level>ERROR</level> - </filter> - <triggeringPolicy - class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> - <maxFileSize>20MB</maxFileSize> - </triggeringPolicy> - <encoder> - <pattern>${defaultErrorPattern}</pattern> - </encoder> - </appender> - - <appender name="asyncEELFError" class="ch.qos.logback.classic.AsyncAppender"> - <appender-ref ref="EELFError" /> - </appender> - - <appender name="EELFDebug" - class="ch.qos.logback.core.rolling.RollingFileAppender"> - <file>${debugLogDirectory}/${debugLogName}.log</file> - <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> - <fileNamePattern>${debugLogDirectory}/${debugLogName}.%i.log.zip - </fileNamePattern> - <minIndex>1</minIndex> - <maxIndex>5</maxIndex> - </rollingPolicy> - <triggeringPolicy - class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> - <maxFileSize>20MB</maxFileSize> - </triggeringPolicy> - <encoder> - <pattern>${debugPattern}</pattern> - </encoder> - </appender> - - <appender name="asyncEELFDebug" class="ch.qos.logback.classic.AsyncAppender"> - <appender-ref ref="EELFDebug" /> - </appender> - - <appender name="NetworkOut" class="ch.qos.logback.core.rolling.RollingFileAppender"> - <file>${logDirectory}/${networkLogName}.log</file> - <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> - <fileNamePattern>${logDirectory}/${networkLogName}.%i.log.zip - </fileNamePattern> - <minIndex>1</minIndex> - <maxIndex>5</maxIndex> - </rollingPolicy> - <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> - <maxFileSize>15MB</maxFileSize> - </triggeringPolicy> - <encoder> - <pattern>${networkPattern}</pattern> - </encoder> - </appender> - - <appender name="AsyncNetworkOut" class="ch.qos.logback.classic.AsyncAppender"> - <appender-ref ref="NetworkOut" /> - </appender> - - <logger name="com.att.eelf.audit" level="info" additivity="false"> - <appender-ref ref="asyncEELFAudit" /> - </logger> - - <logger name="com.att.eelf.metrics" level="info" additivity="false"> - <appender-ref ref="asyncEELFMetrics" /> - </logger> - - <logger name="com.att.eelf.error" level="error" additivity="false"> - <appender-ref ref="asyncEELFError" /> - </logger> - - <logger name="com.att.eelf.debug" level="info"> - <appender-ref ref="asyncEELFDebug" /> - </logger> - - <logger name="network" level="INFO" additivity="false"> - <appender-ref ref="AsyncNetworkOut" /> - </logger> - - <logger name="org.eclipse.jetty.server.RequestLog" level="info" additivity="false"> - <appender-ref ref="AsyncNetworkOut" /> - </logger> - - <root level="INFO"> - <appender-ref ref="asyncEELFDebug" /> - <appender-ref ref="asyncEELFError" /> - </root> + <property name="errorLogName" value="error" /> + <property name="metricsLogName" value="metrics" /> + <property name="auditLogName" value="audit" /> + <property name="debugLogName" value="debug" /> + <property name="networkLogName" value="network" /> + + <property name="defaultPattern" + value="%X{BeginTimestamp}|%X{EndTimestamp}|%X{RequestID}|%X{ServiceInstanceId}|%thread|%X{ServerName}|%X{ServiceName}|%X{PartnerName}|%X{TargetEntity}|%X{TargetServiceName}|%X{StatusCode}|%X{ResponseCode}|%X{ResponseDescription}|%X{InstanceUUID}|%.-5level|%X{AlertSeverity}|%X{ServerIPAddress}|%X{ElapsedTime}|%X{ServerFQDN}|%X{RemoteHost}|%X{ClassName}||%X{ProcessKey}|%X{TargetVirtualEntity}|%X{CustomField1}|%X{CustomField2}|%X{CustomField3}|%X{CustomField4}|%msg%n" /> + <property name="defaultMetricPattern" + value="%X{BeginTimestamp}|%X{EndTimestamp}|%X{RequestID}|%X{ServiceInstanceId}|%thread|%X{ServerName}|%X{ServiceName}|%X{PartnerName}|%X{TargetEntity}|%X{TargetServiceName}|%X{StatusCode}|%X{ResponseCode}|%X{ResponseDescription}|%X{InstanceUUID}|%.-5level|%X{AlertSeverity}|%X{ServerIPAddress}|%X{ElapsedTime}|%X{ServerFQDN}|%X{RemoteHost}|%X{ClassName}||%X{ProcessKey}|%X{TargetVirtualEntity}|%X{CustomField1}|%X{CustomField2}|%X{CustomField3}|%X{CustomField4}|%msg%n" /> + <property name="defaultAuditPattern" + value="%X{BeginTimestamp}|%X{EndTimestamp}|%X{RequestID}|%X{ServiceInstanceId}|%thread|%X{ServerName}|%X{ServiceName}|%X{PartnerName}|%X{StatusCode}|%X{ResponseCode}|%X{ResponseDescription}|%X{InstanceUUID}|%.-5level|%X{AlertSeverity}|%X{ServerIPAddress}|%X{ElapsedTime}|%X{ServerFQDN}|%X{RemoteHost}|%X{ClassName}||%X{ProcessKey}|%X{CustomField1}|%X{CustomField2}|%X{CustomField3}|%X{CustomField4}|%msg%n" /> + <property name="defaultErrorPattern" + value="%d{yyyy-MM-dd'T'HH:mm:ss.SSS+00:00, UTC}|%X{RequestID}|%thread|%X{ServiceName}|%X{PartnerName}|%X{TargetEntity}|%X{TargetServiceName}|%X{ErrorCategory}|%X{ErrorCode}|%X{ErrorDesciption}|%msg%replace(%xException){'\n',' - '}%nopex%n" /> + + <property name="networkPattern" value="[%d|%t]%m%n" /> + <property name="abstractNetworkPattern" + value="[%d] [%X{networkEventType:-NULL}|%X{networkProtocol:-NULL}|%X{networkTopic:-NULL}|%X{requestID:-NULL}]%n" /> + <property name="debugPattern" value="[%date|%level|%logger{0}|%thread] %replace(%msg){'\n', ' '}%n" /> + + <property name="logDirectory" value="logs/Policy" /> + <property name="debugLogDirectory" value="logs/Policy" /> + + <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> + <encoder> + <pattern>${defaultPattern}</pattern> + </encoder> + </appender> + + <appender name="EELFAudit" class="ch.qos.logback.core.rolling.RollingFileAppender"> + <file>${logDirectory}/${auditLogName}.log</file> + <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> + <fileNamePattern>${logDirectory}/${auditLogName}.%i.log.zip + </fileNamePattern> + <minIndex>1</minIndex> + <maxIndex>5</maxIndex> + </rollingPolicy> + <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> + <maxFileSize>10MB</maxFileSize> + </triggeringPolicy> + <encoder> + <pattern>${defaultAuditPattern}</pattern> + </encoder> + </appender> + + <appender name="asyncEELFAudit" class="ch.qos.logback.classic.AsyncAppender"> + <appender-ref ref="EELFAudit" /> + </appender> + + <appender name="EELFMetrics" class="ch.qos.logback.core.rolling.RollingFileAppender"> + <file>${logDirectory}/${metricsLogName}.log</file> + <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> + <fileNamePattern>${logDirectory}/${metricsLogName}.%i.log.zip + </fileNamePattern> + <minIndex>1</minIndex> + <maxIndex>5</maxIndex> + </rollingPolicy> + <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> + <maxFileSize>15MB</maxFileSize> + </triggeringPolicy> + <encoder> + <pattern>${defaultMetricPattern}</pattern> + </encoder> + </appender> + + + <appender name="asyncEELFMetrics" class="ch.qos.logback.classic.AsyncAppender"> + <appender-ref ref="EELFMetrics" /> + </appender> + + <appender name="EELFError" class="ch.qos.logback.core.rolling.RollingFileAppender"> + <file>${logDirectory}/${errorLogName}.log</file> + <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> + <fileNamePattern>${logDirectory}/${errorLogName}.%i.log.zip + </fileNamePattern> + <minIndex>1</minIndex> + <maxIndex>5</maxIndex> + </rollingPolicy> + <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> + <level>ERROR</level> + </filter> + <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> + <maxFileSize>20MB</maxFileSize> + </triggeringPolicy> + <encoder> + <pattern>${defaultErrorPattern}</pattern> + </encoder> + </appender> + + <appender name="asyncEELFError" class="ch.qos.logback.classic.AsyncAppender"> + <appender-ref ref="EELFError" /> + </appender> + + <appender name="EELFDebug" class="ch.qos.logback.core.rolling.RollingFileAppender"> + <file>${debugLogDirectory}/${debugLogName}.log</file> + <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> + <fileNamePattern>${debugLogDirectory}/${debugLogName}.%i.log.zip + </fileNamePattern> + <minIndex>1</minIndex> + <maxIndex>5</maxIndex> + </rollingPolicy> + <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> + <maxFileSize>20MB</maxFileSize> + </triggeringPolicy> + <encoder> + <pattern>${debugPattern}</pattern> + </encoder> + </appender> + + <appender name="asyncEELFDebug" class="ch.qos.logback.classic.AsyncAppender"> + <appender-ref ref="EELFDebug" /> + </appender> + + <appender name="NetworkOut" class="ch.qos.logback.core.rolling.RollingFileAppender"> + <file>${logDirectory}/${networkLogName}.log</file> + <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy"> + <fileNamePattern>${logDirectory}/${networkLogName}.%i.log.zip + </fileNamePattern> + <minIndex>1</minIndex> + <maxIndex>5</maxIndex> + </rollingPolicy> + <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"> + <maxFileSize>15MB</maxFileSize> + </triggeringPolicy> + <encoder> + <pattern>${networkPattern}</pattern> + </encoder> + </appender> + + <appender name="AsyncNetworkOut" class="ch.qos.logback.classic.AsyncAppender"> + <appender-ref ref="NetworkOut" /> + </appender> + + <logger name="com.att.eelf.audit" level="info" additivity="false"> + <appender-ref ref="asyncEELFAudit" /> + </logger> + + <logger name="com.att.eelf.metrics" level="info" additivity="false"> + <appender-ref ref="asyncEELFMetrics" /> + </logger> + + <logger name="com.att.eelf.error" level="error" additivity="false"> + <appender-ref ref="asyncEELFError" /> + </logger> + + <logger name="com.att.eelf.debug" level="info"> + <appender-ref ref="asyncEELFDebug" /> + </logger> + + <logger name="network" level="INFO" additivity="false"> + <appender-ref ref="AsyncNetworkOut" /> + </logger> + + <logger name="org.eclipse.jetty.server.RequestLog" level="info" additivity="false"> + <appender-ref ref="AsyncNetworkOut" /> + </logger> + + <root level="INFO"> + <appender-ref ref="asyncEELFDebug" /> + <appender-ref ref="asyncEELFError" /> + </root> </configuration> diff --git a/feature-mdc-filters/pom.xml b/feature-mdc-filters/pom.xml new file mode 100755 index 00000000..6ea654ba --- /dev/null +++ b/feature-mdc-filters/pom.xml @@ -0,0 +1,119 @@ +<!--
+ ============LICENSE_START=======================================================
+ feature-mdc-filters
+ ================================================================================
+ Copyright (C) 2019 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=========================================================
+ -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <artifactId>drools-pdp</artifactId>
+ <groupId>org.onap.policy.drools-pdp</groupId>
+ <version>1.4.0-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>feature-mdc-filters</artifactId>
+
+ <name>feature-mdc-filters</name>
+ <description>Loadable module that marks key fields in messages through logback mdc.</description>
+
+ <properties>
+ <maven.compiler.source>1.8</maven.compiler.source>
+ <maven.compiler.target>1.8</maven.compiler.target>
+ </properties>
+
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-assembly-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>zipfile</id>
+ <goals>
+ <goal>single</goal>
+ </goals>
+ <phase>package</phase>
+ <configuration>
+ <attach>true</attach>
+ <finalName>${project.artifactId}-${project.version}</finalName>
+ <descriptors>
+ <descriptor>src/assembly/assemble_zip.xml</descriptor>
+ </descriptors>
+ <appendAssemblyId>false</appendAssemblyId>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-dependency-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>copy-dependencies</id>
+ <goals>
+ <goal>copy-dependencies</goal>
+ </goals>
+ <phase>prepare-package</phase>
+ <configuration>
+ <outputDirectory>${project.build.directory}/assembly/lib</outputDirectory>
+ <overWriteReleases>false</overWriteReleases>
+ <overWriteSnapshots>true</overWriteSnapshots>
+ <overWriteIfNewer>true</overWriteIfNewer>
+ <useRepositoryLayout>false</useRepositoryLayout>
+ <addParentPoms>false</addParentPoms>
+ <copyPom>false</copyPom>
+ <includeScope>runtime</includeScope>
+ <excludeTransitive>true</excludeTransitive>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
+ <dependencies>
+
+ <dependency>
+ <groupId>org.onap.policy.common</groupId>
+ <artifactId>policy-endpoints</artifactId>
+ <version>${policy.common.version}</version>
+ <scope>provided</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>org.onap.policy.drools-pdp</groupId>
+ <artifactId>policy-management</artifactId>
+ <version>${project.version}</version>
+ <scope>provided</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>org.mockito</groupId>
+ <artifactId>mockito-core</artifactId>
+ <version>2.13.0</version>
+ <scope>test</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <scope>test</scope>
+ </dependency>
+
+ </dependencies>
+</project>
diff --git a/feature-mdc-filters/src/assembly/assemble_zip.xml b/feature-mdc-filters/src/assembly/assemble_zip.xml new file mode 100755 index 00000000..c85bbe52 --- /dev/null +++ b/feature-mdc-filters/src/assembly/assemble_zip.xml @@ -0,0 +1,55 @@ +<!--
+ ============LICENSE_START=======================================================
+ feature-mdc-filters
+ ================================================================================
+ Copyright (C) 2019 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=========================================================
+ -->
+
+<!-- Defines how we build the .zip file which is our distribution. -->
+
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
+ <id>feature-mdc-filters</id>
+ <formats>
+ <format>zip</format>
+ </formats>
+
+ <includeBaseDirectory>false</includeBaseDirectory>
+
+ <fileSets>
+ <fileSet>
+ <directory>target</directory>
+ <outputDirectory>lib/feature</outputDirectory>
+ <includes>
+ <include>feature-mdc-filters-${project.version}.jar</include>
+ </includes>
+ </fileSet>
+ <fileSet>
+ <directory>src/main/feature/config</directory>
+ <outputDirectory>config</outputDirectory>
+ <fileMode>0644</fileMode>
+ <excludes />
+ </fileSet>
+ <fileSet>
+ <directory>src/main/feature/install</directory>
+ <outputDirectory>install</outputDirectory>
+ <fileMode>0744</fileMode>
+ <excludes />
+ </fileSet>
+ </fileSets>
+
+</assembly>
diff --git a/feature-mdc-filters/src/main/feature/config/feature-mdc-filters.properties b/feature-mdc-filters/src/main/feature/config/feature-mdc-filters.properties new file mode 100755 index 00000000..0a53a9f5 --- /dev/null +++ b/feature-mdc-filters/src/main/feature/config/feature-mdc-filters.properties @@ -0,0 +1,54 @@ +###
+# ============LICENSE_START=======================================================
+# feature-mdc-filters
+# ================================================================================
+# Copyright (C) 2019 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=========================================================
+###
+
+# The properties keys follow the controller topic configurations followed by a
+# a new topic property, 'mdcFilters'.
+#<protocol>.<type>.topics.<topic-name>.mdcFilters
+
+# The value of the property is broken down to the MDC key name to be used by the
+# feature followed by the path(s) to the desired field's value.
+#dmaap.sink.topics.example.mdcFilters=sampleKey=$.path.to.sample.key
+
+# The path always begins with '$' as this signifies the root of the JSON document.
+# The underlying library used is Jayway JsonPath. The library's query syntax is
+# supported for searching a JSON document. The query syntax and some examples
+# can be found at: https://github.com/json-path/JsonPath
+
+# Multiple fields can be found for a given JSON document by a comma separated list
+# of <mdcKey,jsonPath> pairs.
+#dmaap.sink.topics.example.mdcFilters=field1=$.field1,field2=$.field2
+
+# If a given topic supports multiple message types that have fields with the same
+# name, a '|' separated list can define multiple paths to a field. The feature
+# will loop through each path until it finds a match and returns it.
+#dmaap.sink.topics.example.mdcFilters=field1=$.field1|$.body.field1
+
+# dmaap source filters
+dmaap.source.topics.PDPD-CONFIGURATION.mdcFilters=requestID=$.requestID
+dmaap.source.topics.DCAE_TOPIC.mdcFilters=requestID=$.requestID
+dmaap.source.topics.APPC-CL.mdcFilters=requestID=$.CommonHeader.RequestID
+dmaap.source.topics.APPC-LCM-WRITE.mdcFilters=requestID=$.body.output.common-header.request-id
+dmaap.source.topics.SDNR-CL-RSP.mdcFilters=requestID=$.body.CommonHeader.RequestID
+
+# dmaap sink filters
+dmaap.sink.topics.POLICY-CL-MGT.mdcFilters=requestID=$.requestID
+dmaap.sink.topics.APPC-CL.mdcFilters=requestID=$.CommonHeader.RequestID
+dmaap.sink.topics.APPC-LCM-READ.mdcFilters=requestID=$.body.input.common-header.request-id
+dmaap.sink.topics.SDNR-CL.mdcFilters=requestID=$.body.CommonHeader.RequestID
diff --git a/feature-mdc-filters/src/main/feature/install/disable b/feature-mdc-filters/src/main/feature/install/disable new file mode 100755 index 00000000..25d57374 --- /dev/null +++ b/feature-mdc-filters/src/main/feature/install/disable @@ -0,0 +1,32 @@ +#!/bin/bash + +### +# ============LICENSE_START======================================================= +# feature-mdc-filters +# ================================================================================ +# Copyright (C) 2019 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========================================================= +## + +if [[ "${DEBUG}" == "y" ]]; then + set -x +fi + +CONFIG_DIR="${POLICY_HOME}"/config +for mainConfig in ${CONFIG_DIR}/logback.xml ${CONFIG_DIR}/logback-eelf.xml; do + if [ -e "${mainConfig}" ]; then + sed -i --follow-symlinks 's/${abstractNetworkPattern}/${networkPattern}/' "${mainConfig}" + fi +done diff --git a/feature-mdc-filters/src/main/feature/install/enable b/feature-mdc-filters/src/main/feature/install/enable new file mode 100755 index 00000000..57c7cc4a --- /dev/null +++ b/feature-mdc-filters/src/main/feature/install/enable @@ -0,0 +1,32 @@ +#!/bin/bash + +### +# ============LICENSE_START======================================================= +# feature-mdc-filters +# ================================================================================ +# Copyright (C) 2019 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========================================================= +## + +if [[ "${DEBUG}" == "y" ]]; then + set -x +fi + +CONFIG_DIR="${POLICY_HOME}"/config +for mainConfig in ${CONFIG_DIR}/logback.xml ${CONFIG_DIR}/logback-eelf.xml; do + if [ -e "${mainConfig}" ]; then + sed -i --follow-symlinks 's/${networkPattern}/${abstractNetworkPattern}/' "${mainConfig}" + fi +done diff --git a/feature-mdc-filters/src/main/java/org/onap/policy/drools/mdc/filters/MdcFilterFeature.java b/feature-mdc-filters/src/main/java/org/onap/policy/drools/mdc/filters/MdcFilterFeature.java new file mode 100755 index 00000000..369c0aa0 --- /dev/null +++ b/feature-mdc-filters/src/main/java/org/onap/policy/drools/mdc/filters/MdcFilterFeature.java @@ -0,0 +1,201 @@ +/*
+ * ============LICENSE_START=======================================================
+ * feature-mdc-filters
+ * ================================================================================
+ * Copyright (C) 2019 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=========================================================
+ */
+
+package org.onap.policy.drools.mdc.filters;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Properties;
+import org.onap.policy.common.endpoints.event.comm.Topic;
+import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
+import org.onap.policy.common.endpoints.features.NetLoggerFeatureApi;
+import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
+import org.onap.policy.drools.features.PolicyControllerFeatureAPI;
+import org.onap.policy.drools.persistence.SystemPersistence;
+import org.onap.policy.drools.system.PolicyController;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.slf4j.MDC;
+
+public class MdcFilterFeature implements NetLoggerFeatureApi, PolicyControllerFeatureAPI {
+
+ /**
+ * Logger.
+ */
+ private static final Logger logger = LoggerFactory.getLogger(MdcFilterFeature.class);
+
+ /**
+ * Feature properties.
+ */
+ public static final String FEATURE_NAME = "feature-mdc-filters";
+ public static final String SOURCE = "source";
+ public static final String SINK = "sink";
+ public static final String MDC_FILTERS = ".mdcFilters";
+
+ /**
+ * Mapping of 'protocol:type:topic' key to a 'MdcTopicFilter' object.
+ */
+ private Map<String, MdcTopicFilter> topicFilters = new HashMap<>();
+
+ /**
+ * Feature properties map obtained from the feature properties file.
+ */
+ private Properties featureProps = null;
+
+ /**
+ * Constructor.
+ */
+ public MdcFilterFeature() {
+ super();
+ featureProps = getFeatureProps();
+ }
+
+ /**
+ * Gets the feature properties.
+ *
+ * @return the properties for this feature.
+ */
+ protected Properties getFeatureProps() {
+ return SystemPersistence.manager.getProperties(FEATURE_NAME);
+ }
+
+ /**
+ * Sequence number to be used for order of feature implementer execution.
+ */
+ @Override
+ public int getSequenceNumber() {
+ return 1;
+ }
+
+ /**
+ * Loops through all source and sink topics to find which topics have mdc filters and
+ * inserts an MdcTopicFilter in to the topicFilters map.
+ */
+ @Override
+ public boolean afterCreate(PolicyController controller) {
+ createSourceTopicFilters(controller);
+ createSinkTopicFilters(controller);
+ return false;
+ }
+
+ /**
+ * Extracts the fields in a JSON string that are to be logged in an abbreviated
+ * message. The event delivery infrastructure details are put in the MDC as well using
+ * the keys networkEventType (IN/OUT), networkProtocol (UEB/DMAAP/NOOP/REST), and
+ * networkTopic.
+ */
+ @Override
+ public boolean beforeLog(Logger eventLogger, EventType type, CommInfrastructure protocol, String topic,
+ String message) {
+
+ String filterKey = null;
+ if (type == EventType.IN) {
+ filterKey = getTopicKey(protocol.name().toLowerCase(), SOURCE, topic);
+ } else {
+ filterKey = getTopicKey(protocol.name().toLowerCase(), SINK, topic);
+ }
+
+ MDC.put("networkEventType", type.name());
+ MDC.put("networkProtocol", protocol.name());
+ MDC.put("networkTopic", topic);
+
+ MdcTopicFilter filter = topicFilters.get(filterKey);
+ if (filter != null) {
+ for (Map.Entry<String, List<String>> entry : filter.find(message).entrySet()) {
+ String mdcKey = entry.getKey();
+ List<String> results = entry.getValue();
+ if (results.isEmpty()) {
+ logger.debug("No results found for key {}", mdcKey);
+ } else if (results.size() > 1) {
+ logger.debug("Multple results found for key {}, returning list as a string", mdcKey);
+ MDC.put(mdcKey, results.toString());
+ } else {
+ MDC.put(mdcKey, results.get(0));
+ }
+ }
+ } else {
+ logger.debug("No mdc topic filters exist for key {}", filterKey);
+ }
+
+ return false;
+ }
+
+ /**
+ * Clears the MDC mapping after a message is logged.
+ */
+ @Override
+ public boolean afterLog(Logger eventLogger, EventType type, CommInfrastructure protocol, String topic,
+ String message) {
+ MDC.clear();
+ return false;
+ }
+
+ /**
+ * Creates a key using the protocol, type, and topic name.
+ *
+ * @param protocol defined as ueb, dmaap, noop
+ * @param type defined as source or sink
+ * @param topic name of the topic
+ * @return a key that is the concatenation of the protocol, type, and topic name
+ */
+ private String getTopicKey(String protocol, String type, String topic) {
+ return protocol + ":" + type + ":" + topic;
+ }
+
+ /**
+ * Creates MdcTopicFilters for a source/sink topic based on the type.
+ *
+ * @param topic the topic name
+ * @param type 'source' or 'sink'
+ */
+ private void createTopicFilter(Topic topic, String type) {
+ String protocol = topic.getTopicCommInfrastructure().name().toLowerCase();
+ String topicName = topic.getTopic();
+
+ String propertyKey = protocol + "." + type + ".topics." + topicName + MDC_FILTERS;
+ String propertyValue = featureProps.getProperty(propertyKey);
+ if (propertyValue != null) {
+ String topicKey = getTopicKey(protocol, type, topicName);
+ if (!topicFilters.containsKey(topicKey)) {
+ logger.debug("MdcTopicFilter created for {} {} topic {}", protocol, type, topicName);
+ topicFilters.put(topicKey, new MdcTopicFilter(propertyValue));
+ } else {
+ logger.debug("An MdcTopicFilter already exists for key {}", topicKey);
+ }
+ } else {
+ logger.debug("No MDC filters defined for {} {} topic {}", protocol, type, topicName);
+ }
+ }
+
+ /**
+ * Creates MdcTopicFilters for the controller's source topics.
+ */
+ private void createSourceTopicFilters(PolicyController controller) {
+ controller.getTopicSources().forEach(sourceTopic -> createTopicFilter(sourceTopic, SOURCE));
+ }
+
+ /**
+ * Creates MdcTopicFilters for the controller's sink topics.
+ */
+ private void createSinkTopicFilters(PolicyController controller) {
+ controller.getTopicSinks().forEach(sinkTopic -> createTopicFilter(sinkTopic, SINK));
+ }
+}
diff --git a/feature-mdc-filters/src/main/java/org/onap/policy/drools/mdc/filters/MdcTopicFilter.java b/feature-mdc-filters/src/main/java/org/onap/policy/drools/mdc/filters/MdcTopicFilter.java new file mode 100755 index 00000000..d0813a93 --- /dev/null +++ b/feature-mdc-filters/src/main/java/org/onap/policy/drools/mdc/filters/MdcTopicFilter.java @@ -0,0 +1,337 @@ +/*
+ * ============LICENSE_START=======================================================
+ * feature-mdc-filters
+ * ================================================================================
+ * Copyright (C) 2019 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=========================================================
+ */
+
+package org.onap.policy.drools.mdc.filters;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import org.onap.policy.drools.protocol.coders.JsonProtocolFilter;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class MdcTopicFilter {
+
+ private static final Logger logger = LoggerFactory.getLogger(MdcTopicFilter.class);
+
+ public static final String MDC_KEY_ERROR = "mdcKey must be provided";
+ public static final String JSON_PATH_ERROR = "json path(s) must be provided";
+
+ private Map<String, FilterRule> rules = new HashMap<>();
+
+ public static class FilterRule {
+ private String mdcKey;
+ private List<String> paths;
+
+ public FilterRule(String mdcKey, String path) {
+ this.mdcKey = mdcKey;
+ this.paths = Arrays.asList(path);
+ }
+
+ /**
+ * Constructor.
+ *
+ * @param mdcKey the key to the filter rule
+ * @param paths the list of potential paths to the key
+ */
+ public FilterRule(String mdcKey, List<String> paths) {
+ this.mdcKey = mdcKey;
+ this.paths = paths;
+ }
+
+ public String getMdcKey() {
+ return mdcKey;
+ }
+
+ public List<String> getPaths() {
+ return paths;
+ }
+
+ protected void setMdcKey(String mdcKey) {
+ if (mdcKey == null || mdcKey.isEmpty()) {
+ throw new IllegalArgumentException(MDC_KEY_ERROR);
+ }
+ this.mdcKey = mdcKey;
+ }
+
+ protected void setPaths(List<String> paths) {
+ if (paths == null || paths.isEmpty()) {
+ throw new IllegalArgumentException(JSON_PATH_ERROR);
+ }
+ this.paths = paths;
+ }
+
+ protected void addPaths(List<String> paths) {
+ if (paths == null || paths.isEmpty()) {
+ throw new IllegalArgumentException(JSON_PATH_ERROR);
+ }
+ this.paths.addAll(paths);
+ }
+
+ protected void addPath(String path) {
+ if (path == null || path.isEmpty()) {
+ throw new IllegalArgumentException(JSON_PATH_ERROR);
+ }
+ this.paths.add(path);
+ }
+ }
+
+ protected MdcTopicFilter(String rawFilters) {
+ for (String filter : rawFilters.split("\\s*,\\s*")) {
+ FilterRule rule = createFilterRule(filter);
+ rules.put(rule.mdcKey, rule);
+ }
+ }
+
+ private FilterRule createFilterRule(String filter) {
+ String[] filterKeyPaths = filter.split("\\s*=\\s*");
+ if (filterKeyPaths.length != 2) {
+ throw new IllegalArgumentException("could not parse filter rule");
+ }
+
+ String filterKey = filterKeyPaths[0];
+ String paths = filterKeyPaths[1];
+ List<String> filterPaths = new ArrayList<>(Arrays.asList(paths.split("(?<!\\|)\\|(?!\\|)")));
+ return new FilterRule(filterKey, filterPaths);
+ }
+
+ /**
+ * Gets all the filter rules for the topic.
+ *
+ * @return an array list of the rules for the topic
+ */
+ protected List<FilterRule> getFilterRule() {
+ return new ArrayList<>(rules.values());
+ }
+
+ /**
+ * Gets the filter rule for the specified key.
+ *
+ * @param mdcKey the key to the filter rule
+ * @return the filter rule associated with the key
+ */
+ protected FilterRule getFilterRule(String mdcKey) {
+ if (mdcKey == null || mdcKey.isEmpty()) {
+ throw new IllegalArgumentException(MDC_KEY_ERROR);
+ }
+ return rules.get(mdcKey);
+ }
+
+ /**
+ * Adds a filter rule for the specified key and path.
+ *
+ * @param mdcKey the key to the filter rule
+ * @param path the json path to the key
+ * @return the filter rule that was added for the topic
+ */
+ protected FilterRule addFilterRule(String mdcKey, String path) {
+ if (path == null || path.isEmpty()) {
+ throw new IllegalArgumentException(JSON_PATH_ERROR);
+ }
+ return addFilterRule(mdcKey, Arrays.asList(path));
+ }
+
+ /**
+ * Adds a filter rule for the specified key and paths.
+ *
+ * @param mdcKey the key to the filter rule
+ * @param paths the list of potential paths to the key
+ * @return the filter rule that was added for the topic
+ */
+ protected FilterRule addFilterRule(String mdcKey, List<String> paths) {
+ if (mdcKey == null || mdcKey.isEmpty()) {
+ throw new IllegalArgumentException(MDC_KEY_ERROR);
+ }
+
+ if (paths == null || paths.isEmpty()) {
+ throw new IllegalArgumentException(JSON_PATH_ERROR);
+ }
+
+ if (rules.containsKey(mdcKey)) {
+ throw new IllegalArgumentException("a filter rule already exists for key: " + mdcKey);
+ }
+
+ FilterRule rule = new FilterRule(mdcKey, paths);
+ rules.put(mdcKey, rule);
+ return rule;
+ }
+
+ /**
+ * Modifies an existing filter rule by adding the specified path.
+ *
+ * @param mdcKey the key to the filter rule
+ * @param path the path to the key
+ * @return the filter rule that was modified
+ */
+ protected FilterRule modifyFilterRule(String mdcKey, String path) {
+ if (path == null || path.isEmpty()) {
+ throw new IllegalArgumentException(JSON_PATH_ERROR);
+ }
+ return modifyFilterRule(mdcKey, Arrays.asList(path));
+ }
+
+ /**
+ * Modifies an existing filter rule by adding the specified paths.
+ *
+ * @param mdcKey the key to the filter rule
+ * @param paths the list of potential paths to the key
+ * @return the filter rule that was modified
+ */
+ protected FilterRule modifyFilterRule(String mdcKey, List<String> paths) {
+ if (mdcKey == null || mdcKey.isEmpty()) {
+ throw new IllegalArgumentException(MDC_KEY_ERROR);
+ }
+
+ if (paths == null || paths.isEmpty()) {
+ throw new IllegalArgumentException(JSON_PATH_ERROR);
+ }
+
+ if (!rules.containsKey(mdcKey)) {
+ throw new IllegalArgumentException("a filter rule doesn't exist for key: " + mdcKey);
+ }
+
+ FilterRule rule = rules.get(mdcKey);
+ rule.addPaths(paths);
+ return rule;
+ }
+
+ /**
+ * Modifies an existing filter rule's key and replaces the paths with the specified
+ * paths.
+ *
+ * @param oldMdcKey the old key to the filter rule
+ * @param newMdcKey the new key to the filter rule
+ * @param paths the list of potential paths to the key
+ * @return the filter rule that was modified
+ */
+ protected FilterRule modifyFilterRule(String oldMdcKey, String newMdcKey, List<String> paths) {
+ if (oldMdcKey == null || oldMdcKey.isEmpty()) {
+ throw new IllegalArgumentException("current mdcKey must be provided");
+ }
+
+ if (newMdcKey == null || newMdcKey.isEmpty()) {
+ throw new IllegalArgumentException("new mdcKey must be provided");
+ }
+
+ if (oldMdcKey.equals(newMdcKey)) {
+ throw new IllegalArgumentException("the old and new mdcKey are equivalent");
+ }
+ if (paths == null || paths.isEmpty()) {
+ throw new IllegalArgumentException(JSON_PATH_ERROR);
+ }
+
+ if (rules.containsKey(newMdcKey)) {
+ throw new IllegalArgumentException("a filter rule already exists for key: " + newMdcKey);
+ }
+
+ FilterRule rule = rules.remove(oldMdcKey);
+ if (rule == null) {
+ throw new IllegalArgumentException("a filter rule doesn't exist for key: " + oldMdcKey);
+ }
+
+ rule.setMdcKey(newMdcKey);
+ rule.setPaths(paths);
+ rules.put(newMdcKey, rule);
+ return rule;
+ }
+
+ /**
+ * Deletes all filter rules for the topic filter.
+ */
+ protected void deleteFilterRule() {
+ rules.clear();
+ }
+
+ /**
+ * Deletes an existing filter rule.
+ *
+ * @param mdcKey the key to the filter rule
+ * @return the filter rule that was deleted
+ */
+ protected FilterRule deleteFilterRule(String mdcKey) {
+ if (mdcKey == null || mdcKey.isEmpty()) {
+ throw new IllegalArgumentException(MDC_KEY_ERROR);
+ }
+ return rules.remove(mdcKey);
+ }
+
+ /**
+ * Finds all fields for each topic filter rule. The results are stored in a map that
+ * is indexed by the MDC key. Each MDC key has a list of results as multiple
+ * occurrences of a key can be found in a JSON document.
+ *
+ * @param json the json string to be parsed
+ * @return a map of mdc keys and list of results for each key
+ */
+ protected Map<String, List<String>> find(String json) {
+ Map<String, List<String>> results = new HashMap<>();
+ for (FilterRule rule : rules.values()) {
+ List<String> matches = new ArrayList<>();
+ for (String path : rule.getPaths()) {
+
+ try {
+ matches = JsonProtocolFilter.filter(json, path);
+ } catch (Exception e) {
+ logger.debug("Could not filter on path {} because of {}", path, e.getMessage(), e);
+ }
+
+ if (!matches.isEmpty()) {
+ break;
+ } else {
+ logger.error("Could not find path {} in json {}", path, json);
+ }
+
+ }
+ results.put(rule.getMdcKey(), matches);
+ }
+ return results;
+ }
+
+ /**
+ * Finds all occurrences of a field in a JSON document based on the filter rule paths.
+ *
+ * @param json the json string to be parsed
+ * @return a list of matches from the JSON document
+ */
+ protected List<String> find(String json, String mdcKey) {
+ List<String> matches = new ArrayList<>();
+ for (String path : rules.get(mdcKey).getPaths()) {
+
+ try {
+ matches = JsonProtocolFilter.filter(json, path);
+ } catch (Exception e) {
+ logger.debug("Could not filter on path {} because of {}", path, e.getMessage(), e);
+ }
+
+ if (!matches.isEmpty()) {
+ break;
+ }
+
+ }
+
+ if (matches.isEmpty()) {
+ logger.error("Could not find any matches for key {} in json {}", mdcKey, json);
+ }
+
+ return matches;
+ }
+}
diff --git a/feature-mdc-filters/src/main/resources/META-INF/services/org.onap.policy.common.endpoints.features.NetLoggerFeatureApi b/feature-mdc-filters/src/main/resources/META-INF/services/org.onap.policy.common.endpoints.features.NetLoggerFeatureApi new file mode 100755 index 00000000..f2fdb402 --- /dev/null +++ b/feature-mdc-filters/src/main/resources/META-INF/services/org.onap.policy.common.endpoints.features.NetLoggerFeatureApi @@ -0,0 +1 @@ +org.onap.policy.drools.mdc.filters.MdcFilterFeature
diff --git a/feature-mdc-filters/src/main/resources/META-INF/services/org.onap.policy.drools.features.PolicyControllerFeatureAPI b/feature-mdc-filters/src/main/resources/META-INF/services/org.onap.policy.drools.features.PolicyControllerFeatureAPI new file mode 100755 index 00000000..f2fdb402 --- /dev/null +++ b/feature-mdc-filters/src/main/resources/META-INF/services/org.onap.policy.drools.features.PolicyControllerFeatureAPI @@ -0,0 +1 @@ +org.onap.policy.drools.mdc.filters.MdcFilterFeature
diff --git a/feature-mdc-filters/src/test/java/org/onap/policy/drools/mdc/filters/MdcFilterFeatureTest.java b/feature-mdc-filters/src/test/java/org/onap/policy/drools/mdc/filters/MdcFilterFeatureTest.java new file mode 100755 index 00000000..afe6df35 --- /dev/null +++ b/feature-mdc-filters/src/test/java/org/onap/policy/drools/mdc/filters/MdcFilterFeatureTest.java @@ -0,0 +1,170 @@ +/*
+ * ============LICENSE_START=======================================================
+ * feature-mdc-filters
+ * ================================================================================
+ * Copyright (C) 2019 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=========================================================
+ */
+
+package org.onap.policy.drools.mdc.filters;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.mock;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.List;
+import java.util.Properties;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
+import org.onap.policy.common.endpoints.event.comm.TopicEndpoint;
+import org.onap.policy.common.endpoints.event.comm.TopicSink;
+import org.onap.policy.common.endpoints.event.comm.TopicSource;
+import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
+import org.onap.policy.drools.system.PolicyController;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.slf4j.MDC;
+
+public class MdcFilterFeatureTest {
+
+ /**
+ * Logger.
+ */
+ private static final Logger logger = LoggerFactory.getLogger(MdcFilterFeatureTest.class);
+
+ /**
+ * Test topic names for mdc topic filters.
+ */
+ private static final String TEST_TOPIC_A = "org.onap.policy.test-topic-a";
+ private static final String TEST_TOPIC_B = "org.onap.policy.test-topic-b";
+
+ /**
+ * The mock PolicyController to be used for the junits.
+ */
+ private PolicyController controller;
+
+ /**
+ * The mock properties to be used for the junits.
+ */
+ private Properties props;
+
+ /**
+ * An instance of the MdcFilterFeature.
+ */
+ private MdcFilterFeature mdcFilterFeature;
+
+ /**
+ * Sample json string to be logged.
+ */
+ private String message;
+
+ /**
+ * Setup.
+ * @throws IOException thrown if onset.json file could not be read
+ */
+ @Before
+ public void setUp() throws IOException {
+ message = new String(Files.readAllBytes(Paths.get("src/test/resources/onset.json")));
+
+ props = mockFeatureProperties();
+ controller = mock(PolicyController.class);
+
+ props.setProperty("dmaap.source.topics", TEST_TOPIC_A);
+ props.setProperty("dmaap.source.topics." + TEST_TOPIC_A + ".servers", "http://testing123.com/");
+ props.setProperty("noop.sink.topics", TEST_TOPIC_B);
+
+ List<TopicSource> topicSources = TopicEndpoint.manager.addTopicSources(props);
+ doReturn(topicSources).when(controller).getTopicSources();
+
+ List<TopicSink> topicSinks = TopicEndpoint.manager.addTopicSinks(props);
+ doReturn(topicSinks).when(controller).getTopicSinks();
+
+ mdcFilterFeature = new MdcFilterFeatureImpl();
+ mdcFilterFeature.afterCreate(controller);
+ }
+
+ /**
+ * Tests extracting fields from a JSON message and place them in the MDC and
+ * then clearing the MDC.
+ */
+ @Test
+ public void mdcLogTest() {
+ mdcFilterFeature.beforeLog(logger, EventType.IN,
+ CommInfrastructure.DMAAP, TEST_TOPIC_A, message);
+
+ assertEquals("8c1b8bd8-06f7-493f-8ed7-daaa4cc481bc", MDC.get("requestID"));
+ assertEquals("CL-TEST", MDC.get("closedLoopControlName"));
+
+ assertNotNull(MDC.getCopyOfContextMap());
+
+ mdcFilterFeature.afterLog(logger, EventType.IN,
+ CommInfrastructure.DMAAP, TEST_TOPIC_A, message);
+
+ assertNull(MDC.getCopyOfContextMap());
+ }
+
+ /**
+ * Tests that the feature does not search for fields in a JSON message
+ * if there is not an MdcTopicFilter object for the generated key.
+ */
+ @Test
+ public void noTopicFilterTest() {
+ mdcFilterFeature.beforeLog(logger, EventType.OUT,
+ CommInfrastructure.NOOP, "no-topic", message);
+
+ assertEquals("OUT", MDC.get("networkEventType"));
+ assertEquals("NOOP", MDC.get("networkProtocol"));
+ assertEquals("no-topic", MDC.get("networkTopic"));
+ assertNull(MDC.get("requestID"));
+ }
+
+ /**
+ * Creates a simple properties map containing an mdc filter for a test
+ * topic.
+ *
+ * @return a properties map with mdc filter properties.
+ */
+ private Properties mockFeatureProperties() {
+ Properties props = new Properties();
+
+ String key = "dmaap.source.topics." + TEST_TOPIC_A + ".mdcFilters";
+ String value = "requestID=$.requestID,closedLoopControlName=$.closedLoopControlName";
+ props.setProperty(key, value);
+
+ return props;
+ }
+
+ /**
+ * Subclass of MdcFilterFeature for junit usage.
+ */
+ private class MdcFilterFeatureImpl extends MdcFilterFeature {
+
+ public MdcFilterFeatureImpl() {
+ super();
+ }
+
+ @Override
+ protected Properties getFeatureProps() {
+ return props;
+ }
+ }
+}
diff --git a/feature-mdc-filters/src/test/java/org/onap/policy/drools/mdc/filters/MdcTopicFilterTest.java b/feature-mdc-filters/src/test/java/org/onap/policy/drools/mdc/filters/MdcTopicFilterTest.java new file mode 100755 index 00000000..2a5a875d --- /dev/null +++ b/feature-mdc-filters/src/test/java/org/onap/policy/drools/mdc/filters/MdcTopicFilterTest.java @@ -0,0 +1,564 @@ +/*
+ * ============LICENSE_START=======================================================
+ * feature-mdc-filters
+ * ================================================================================
+ * Copyright (C) 2019 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=========================================================
+ */
+
+package org.onap.policy.drools.mdc.filters;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+
+import org.junit.Test;
+import org.onap.policy.drools.mdc.filters.MdcTopicFilter.FilterRule;
+
+public class MdcTopicFilterTest {
+
+ /**
+ * Test the simple case of having one filter rule for a key.
+ */
+ @Test
+ public void singleFilterOnePathTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+
+ FilterRule rule = topicFilter.getFilterRule("requestID");
+ assertEquals("requestID", rule.getMdcKey());
+ assertEquals("[$.requestID]", rule.getPaths().toString());
+ }
+
+ /**
+ * Tests having one filter rule with a set of potential paths to the key.
+ */
+ @Test
+ public void singleFilterMultiPathTest() {
+ String topicFilterProp = "requestID=$.requestID|$.request-id";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+
+ FilterRule rule = topicFilter.getFilterRule("requestID");
+ assertEquals("requestID", rule.getMdcKey());
+ assertEquals(2, rule.getPaths().size());
+ assertEquals("[$.requestID, $.request-id]", rule.getPaths().toString());
+ }
+
+ /**
+ * Tests having two filter rules that each have one key/path pair.
+ */
+ @Test
+ public void multiFilterSinglePathTest() {
+ String topicFilterProp = "requestID=$.requestID,closedLoopControlName=$.closedLoopControlName";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+
+ FilterRule rule = topicFilter.getFilterRule("requestID");
+ assertEquals("requestID", rule.getMdcKey());
+ assertEquals(1, rule.getPaths().size());
+ assertEquals("[$.requestID]", rule.getPaths().toString());
+
+ FilterRule rule2 = topicFilter.getFilterRule("closedLoopControlName");
+ assertEquals("closedLoopControlName", rule2.getMdcKey());
+ assertEquals(1, rule2.getPaths().size());
+ assertEquals("[$.closedLoopControlName]", rule2.getPaths().toString());
+ }
+
+ /**
+ * Tests having two filter rules that each have two key/path pairs.
+ */
+ @Test
+ public void multiFilterMultiPathTest() {
+ String topicFilterProp = "requestID=$.requestID|$.body.request-id,"
+ + "closedLoopControlName=$.closedLoopControlName"
+ + "|$.body.closedLoopControlName";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+
+ FilterRule rule = topicFilter.getFilterRule("requestID");
+ assertEquals("requestID", rule.getMdcKey());
+ assertEquals(2, rule.getPaths().size());
+ assertEquals("[$.requestID, $.body.request-id]", rule.getPaths().toString());
+
+ FilterRule rule2 = topicFilter.getFilterRule("closedLoopControlName");
+ assertEquals("closedLoopControlName", rule2.getMdcKey());
+ assertEquals(2, rule2.getPaths().size());
+ assertEquals("[$.closedLoopControlName, $.body.closedLoopControlName]", rule2.getPaths().toString());
+ }
+
+ /**
+ * Tests that the regex split logic for '|' in the feature code doesn't
+ * break parsing when "||" is used as a predicate in a JsonPath query.
+ */
+ @Test
+ public void addOrPredicateFilterTest() {
+ String topicFilterProp = "requestID=$.requestID||$.body.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ assertEquals(1, topicFilter.getFilterRule().size());
+ assertEquals("requestID", topicFilter.getFilterRule("requestID").getMdcKey());
+ assertEquals(Arrays.asList("$.requestID||$.body.requestID"), topicFilter
+ .getFilterRule("requestID").getPaths());
+ }
+
+ /**
+ * Tests getting all filter rules for a given topic.
+ */
+ @Test
+ public void getAllFilterRulesTest() {
+ String topicFilterProp = "requestID=$.requestID,subRequestID=$.subRequestID,"
+ + "closedLoopControlName=$.closedLoopControlName";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ assertEquals(3, topicFilter.getFilterRule().size());
+ }
+
+ /**
+ * Tests getting a filter rule by its key.
+ */
+ @Test
+ public void getFilterRuleTest() {
+ String topicFilterProp = "requestID=$.requestID,subRequestID=$.subRequestID,"
+ + "closedLoopControlName=$.closedLoopControlName";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+
+ FilterRule rule = topicFilter.getFilterRule("requestID");
+ assertNotNull(rule);
+ }
+
+ /**
+ * Tests throwing an exception for passing in a null key.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void getFilterRuleNullKeyTest() {
+ String topicFilterProp = "requestID=$.requestID,subRequestID=$.subRequestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.getFilterRule(null);
+ }
+
+ /**
+ * Tests throwing an exception for passing in an empty key.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void getFilterRuleEmptyKeyTest() {
+ String topicFilterProp = "requestID=$.requestID,subRequestID=$.subRequestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.getFilterRule("");
+ }
+
+ /**
+ * Tests adding a filter rule with a single path.
+ */
+ @Test
+ public void addFilterRuleSinglePathTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+
+ String key = "subRequestID";
+ String path = "$.subRequestID";
+ FilterRule rule = topicFilter.addFilterRule(key, path);
+ assertEquals(topicFilter.getFilterRule(key), rule);
+ }
+
+ /**
+ * Tests adding a filter rule with multiple paths.
+ */
+ @Test
+ public void addFilterRuleMultiPathTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+
+ String key = "subRequestID";
+ List<String> paths = Arrays.asList("$.subRequestID", "$.sub-request-id");
+ FilterRule rule = topicFilter.addFilterRule(key, paths);
+ assertEquals(topicFilter.getFilterRule(key), rule);
+ }
+
+ /**
+ * Tests throwing an exception for passing a null key and a
+ * single path.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void addFilterRuleNullKeyStringPathTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.addFilterRule(null, "$.subRequestID");
+ }
+
+ /**
+ * Tests throwing an exception for passing a null key and a list
+ * of paths.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void addFilterRuleNullKeyPathListTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.addFilterRule(null, Arrays.asList("$.subRequestID"));
+ }
+
+ /**
+ * Tests throwing an exception for passing an empty key and
+ * a single path.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void addFilterRuleEmptyKeyStringPathTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.addFilterRule("", "$.subRequestID");
+ }
+
+ /**
+ * Tests throwing an exception for passing an empty key and
+ * a list of paths.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void addFilterRuleEmptyKeyPathListTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.addFilterRule("", Arrays.asList("$.subRequestID"));
+ }
+
+ /**
+ * Tests throwing an exception for passing an empty path string.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void addFilterRuleEmptyPathTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.addFilterRule("subRequestID", "");
+ }
+
+ /**
+ * Tests throwing an exception for passing an empty paths list.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void addFilterRuleEmptyPathsTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.addFilterRule("subRequestID", Arrays.asList());
+ }
+
+ /**
+ * Tests throwing an exception for trying to add a filter with a key that
+ * already exists with a single filter.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void addExistingFilterRuleStringTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.addFilterRule("requestID", "$.test");
+ }
+
+ /**
+ * Tests throwing an exception for trying to add a filter with a key that
+ * already exists with a list of filters.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void addExistingFilterRuleListTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.addFilterRule("requestID", Arrays.asList("$.test"));
+ }
+
+ /**
+ * Tests modifying a filter rule to add a new path.
+ */
+ @Test
+ public void modifyFilterRuleSinglePathTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+
+ FilterRule rule = topicFilter.modifyFilterRule("requestID", "$.request-id");
+ assertEquals(topicFilter.getFilterRule("requestID"), rule);
+ assertEquals(Arrays.asList("$.requestID", "$.request-id"), rule.getPaths());
+ }
+
+ /**
+ * Tests modifying a filter rule to add a list of new paths.
+ */
+ @Test
+ public void modifyFilterRuleMultiPathTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+
+ FilterRule rule = topicFilter.modifyFilterRule("requestID",
+ Arrays.asList("$.request-id", "$.requestId"));
+ assertEquals(topicFilter.getFilterRule("requestID"), rule);
+ assertEquals(
+ Arrays.asList("$.requestID", "$.request-id", "$.requestId"),
+ rule.getPaths());
+ }
+
+ /**
+ * Tests modifying a filter rule key.
+ */
+ @Test
+ public void modifyFilterRuleKeyTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+
+ FilterRule rule = topicFilter.modifyFilterRule("requestID",
+ "request-id", Arrays.asList("$.request-id"));
+ assertEquals(topicFilter.getFilterRule("request-id"), rule);
+ assertEquals("[$.request-id]", rule.getPaths().toString());
+ }
+
+ /**
+ * Tests throwing an exception when passing a null key and
+ * a single path.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void modifyFilterRuleNullKeyStringPathTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.modifyFilterRule(null, "$.request-id");
+ }
+
+ /**
+ * Tests throwing an exception when passing a null key and
+ * a list of multiple paths.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void modifyFilterRuleNullKeyPathListTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.modifyFilterRule(null, Arrays.asList("$.request-id"));
+ }
+
+ /**
+ * Tests throwing an exception when passing an empty key and
+ * a single path.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void modifyFilterRuleEmptyKeyStringPathTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.modifyFilterRule("", "$.request-id");
+ }
+
+ /**
+ * Tests throwing an exception when passing an empty key and
+ * a list of multiple paths.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void modifyFilterRuleEmptyKeyPathListTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.modifyFilterRule("", Arrays.asList("$.request-id"));
+ }
+
+ /**
+ * Tests throwing an exception when passing an empty string path.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void modifyFilterRuleEmptyPathStringTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.modifyFilterRule("requestID", "");
+ }
+
+ /**
+ * Tests throwing an exception when passing an empty list of paths.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void modifyFilterRuleEmptyPathListTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.modifyFilterRule("requestID", Arrays.asList());
+ }
+
+ /**
+ * Tests throwing an exception when passing a key that is
+ * not in the filter rules map and a string path.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void modifyFilterRuleMissingKeyStringPathTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.modifyFilterRule("request-id", "$.request-id");
+ }
+
+ /**
+ * Tests throwing an exception when passing a key that is
+ * not in the filter rules map and a list of paths.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void modifyFilterRuleMissingKeyPathListTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.modifyFilterRule("request-id", Arrays.asList("$.request-id"));
+ }
+
+
+ /**
+ * Tests throwing an exception when passing a null oldKey.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void modifyFilterRuleNullOldKeyTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.modifyFilterRule(null, "request-id", Arrays.asList("$.request-id"));
+ }
+
+ /**
+ * Tests throwing an exception when passing an empty oldKey.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void modifyFilterRuleEmptyOldKeyTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.modifyFilterRule("", "request-id", Arrays.asList("$.request-id"));
+ }
+
+ /**
+ * Tests throwing an exception when passing a null newKey.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void modifyFilterRuleNullNewKeyTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.modifyFilterRule("requestID", null, Arrays.asList("$.request-id"));
+ }
+
+ /**
+ * Tests throwing an exception when passing an empty newKey.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void modifyFilterRuleEmptyNewKeyTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.modifyFilterRule("requestID", "", Arrays.asList("$.request-id"));
+ }
+
+ /**
+ * Tests throwing an exception when the old and new key are the same.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void modifyFilterRuleSameKeyTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.modifyFilterRule("requestID", "requestID",
+ Arrays.asList("$.request-id"));
+ }
+
+ /**
+ * Tests throwing an exception when passing an empty paths list.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void modifyFilterRuleEmptyPathsTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.modifyFilterRule("requestID", "request-id", Arrays.asList());
+ }
+
+ /**
+ * Tests throwing an exception when the old key doesn't exist
+ * in the rules map.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void modifyFilterRuleNonExistingOldKeyTest() {
+ String topicFilterProp = "requestID=$.requestID";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.modifyFilterRule("request-id", "id", Arrays.asList("$.request-id"));
+ }
+
+ /**
+ * Tests deleting all filter rules in the rules map.
+ */
+ @Test
+ public void deleteAllFilterRulesTest() {
+ String topicFilterProp = "requestID=$.requestID,subRequestID=$.subRequestID,"
+ + "closedLoopControlName=$.closedLoopControlName";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+
+ assertEquals(3, topicFilter.getFilterRule().size());
+ topicFilter.deleteFilterRule();
+ assertEquals(0, topicFilter.getFilterRule().size());
+ }
+
+ /**
+ * Tests deleting a single filter rule by its key from the rules map.
+ */
+ @Test
+ public void deleteFilterRuleTest() {
+ String topicFilterProp = "requestID=$.requestID,subRequestID=$.subRequestID,"
+ + "closedLoopControlName=$.closedLoopControlName";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+
+ assertEquals(3, topicFilter.getFilterRule().size());
+ topicFilter.deleteFilterRule("closedLoopControlName");
+ assertEquals(2, topicFilter.getFilterRule().size());
+ }
+
+ /**
+ * Tests throwing an exception if the key is null.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void deleteFilterRuleNullKeyTest() {
+ String topicFilterProp = "requestID=$.requestID,subRequestID=$.subRequestID,"
+ + "closedLoopControlName=$.closedLoopControlName";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.deleteFilterRule(null);
+ }
+
+ /**
+ * Tests throwing an exception if the key is empty.
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void deleteFilterRuleEmptyKeyTest() {
+ String topicFilterProp = "requestID=$.requestID,subRequestID=$.subRequestID,"
+ + "closedLoopControlName=$.closedLoopControlName";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+ topicFilter.deleteFilterRule("");
+ }
+
+ /**
+ * Tests finding all results for each filter rule corresponding to a topic.
+ */
+ @Test
+ public void findAllTest() {
+ String message = "{\"requestID\":\"38adde30-cc22-11e8-a8d5-f2801f1b9fd1\",\"entity\":\"controller\","
+ + "\"controllers\":[{\"name\":\"test-controller\","
+ + "\"drools\":{\"groupId\":\"org.onap.policy.drools.test\","
+ + "\"artifactId\":\"test\",\"version\":\"0.0.1\"},\"operation\":\"update\"}]}";
+
+ String topicFilterProp = "requestID=$.requestID,controllerName=$.controllers[0].name,"
+ + "operation=$.controllers[0].operation";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+
+ Map<String, List<String>> results = topicFilter.find(message);
+ assertEquals("38adde30-cc22-11e8-a8d5-f2801f1b9fd1",
+ results.get("requestID").get(0));
+ assertEquals("test-controller", results.get("controllerName").get(0));
+ assertEquals("update", results.get("operation").get(0));
+ }
+
+ /**
+ * Tests finding field matches for a filter rule corresponding to a topic.
+ */
+ @Test
+ public void findTest() {
+ String message = "{\"requestID\":\"38adde30-cc22-11e8-a8d5-f2801f1b9fd1\",\"entity\":\"controller\","
+ + "\"controllers\":[{\"name\":\"test-controller\","
+ + "\"drools\":{\"groupId\":\"org.onap.policy.drools.test\","
+ + "\"artifactId\":\"test\",\"version\":\"0.0.1\"},\"operation\":\"update\"}]}";
+
+ String topicFilterProp = "requestID=$.requestID,controllerName=$.controllers[0].name,"
+ + "operation=$.controllers[0].operation";
+ MdcTopicFilter topicFilter = new MdcTopicFilter(topicFilterProp);
+
+ List<String> results = topicFilter.find(message, "requestID");
+ assertEquals("38adde30-cc22-11e8-a8d5-f2801f1b9fd1", results.get(0));
+ }
+}
diff --git a/feature-mdc-filters/src/test/resources/onset.json b/feature-mdc-filters/src/test/resources/onset.json new file mode 100755 index 00000000..fafc93a3 --- /dev/null +++ b/feature-mdc-filters/src/test/resources/onset.json @@ -0,0 +1,18 @@ +{
+ "closedLoopEventClient": "DCAE_INSTANCE_ID.dcae-tca",
+ "policyVersion": "1.0.0.5",
+ "policyName": "policyTest",
+ "policyScope": "type=SampleType,closedLoopControlName=SampleClosedLoop",
+ "target_type": "VM",
+ "AAI": {
+ "vserver.is-closed-loop-disabled": false,
+ "vserver.vserver-name": "example-vserver-name"
+ },
+ "closedLoopAlarmStart": 1484855291527925,
+ "closedLoopEventStatus": "ONSET",
+ "closedLoopControlName": "CL-TEST",
+ "version": "1.0.2",
+ "target": "vserver.vserver-name",
+ "requestID": "8c1b8bd8-06f7-493f-8ed7-daaa4cc481bc",
+ "from": "DCAE"
+}
\ No newline at end of file diff --git a/packages/install/pom.xml b/packages/install/pom.xml index e603fb6f..7fa5d505 100644 --- a/packages/install/pom.xml +++ b/packages/install/pom.xml @@ -124,6 +124,12 @@ <version>${project.version}</version> <type>zip</type> </dependency> + <dependency> + <groupId>org.onap.policy.drools-pdp</groupId> + <artifactId>feature-mdc-filters</artifactId> + <version>${project.version}</version> + <type>zip</type> + </dependency> </dependencies> </project> diff --git a/policy-management/src/main/server/config/logback.xml b/policy-management/src/main/server/config/logback.xml index 4fb82768..bf08a5ac 100644 --- a/policy-management/src/main/server/config/logback.xml +++ b/policy-management/src/main/server/config/logback.xml @@ -19,126 +19,130 @@ --> <configuration scan="true" scanPeriod="30 seconds" debug="false"> - - <property name="logDir" value="${POLICY_LOGS}" /> - - <property name="errorLog" value="error" /> - <property name="debugLog" value="debug" /> - <property name="networkLog" value="network" /> - - <property name="metricLog" value="metric" /> - <property name="transactionLog" value="audit" /> - - <property name="debugPattern" value="[%d{yyyy-MM-dd'T'HH:mm:ss.SSS+00:00, UTC}|%level|%logger{0}|%thread] %msg%n" /> - <property name="errorPattern" value="${debugPattern}" /> - <property name="networkPattern" value="[%d{yyyy-MM-dd'T'HH:mm:ss.SSS+00:00, UTC}|%t]%m%n" /> - - <property name="metricPattern" value="%X{RequestID}|%X{InvocationID}|%X{ServiceName}|%X{PartnerName}|%X{BeginTimestamp}|%X{EndTimestamp}|%X{ElapsedTime}|%X{ServiceInstanceID}|%X{VirtualServerName}|%X{StatusCode}|%X{ResponseCode}|%X{ResponseDescription}|%X{InstanceUUID}|%X{Severity}|%X{TargetEntity}|%X{TargetServiceName}|%X{Server}|%X{ServerIPAddress}|%X{ServerFQDN}|%X{ClientIPAddress}|%X{ProcessKey}|%X{RemoteHost}|%X{AlertSeverity}|%X{TargetVirtualEntity}|%level|%thread| %msg%n"/> - <property name="transactionPattern" value="${metricPattern}" /> - - <appender name="ErrorOut" class="ch.qos.logback.core.rolling.RollingFileAppender"> - <file>${logDir}/${errorLog}.log</file> - <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> - <fileNamePattern>${logDir}/${errorLog}.%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern> - <maxFileSize>50MB</maxFileSize> - <maxHistory>30</maxHistory> - <totalSizeCap>10GB</totalSizeCap> - </rollingPolicy> - <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> - <level>WARN</level> - </filter> - <encoder> - <pattern>${errorPattern}</pattern> - </encoder> - </appender> - - <appender name="AsyncErrorOut" class="ch.qos.logback.classic.AsyncAppender"> - <appender-ref ref="ErrorOut" /> - </appender> - - <appender name="DebugOut" class="ch.qos.logback.core.rolling.RollingFileAppender"> - <file>${logDir}/${debugLog}.log</file> - <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> - <fileNamePattern>${logDir}/${debugLog}.%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern> - <maxFileSize>50MB</maxFileSize> - <maxHistory>30</maxHistory> - <totalSizeCap>10GB</totalSizeCap> - </rollingPolicy> - <encoder> - <pattern>${debugPattern}</pattern> - </encoder> - </appender> - - <appender name="AsyncDebugOut" class="ch.qos.logback.classic.AsyncAppender"> - <appender-ref ref="DebugOut" /> - </appender> - - <appender name="NetworkOut" class="ch.qos.logback.core.rolling.RollingFileAppender"> - <file>${logDir}/${networkLog}.log</file> - <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> - <fileNamePattern>${logDir}/${networkLog}.%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern> - <maxFileSize>50MB</maxFileSize> - <maxHistory>30</maxHistory> - <totalSizeCap>10GB</totalSizeCap> - </rollingPolicy> - <encoder> - <pattern>${networkPattern}</pattern> - </encoder> - </appender> - - <appender name="AsyncNetworkOut" class="ch.qos.logback.classic.AsyncAppender"> - <appender-ref ref="NetworkOut" /> - </appender> - - <appender name="MetricOut" class="ch.qos.logback.core.rolling.RollingFileAppender"> - <file>${logDir}/${metricLog}.log</file> - <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> - <fileNamePattern>${logDir}/${metricLog}.%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern> - <maxFileSize>50MB</maxFileSize> - <maxHistory>30</maxHistory> - <totalSizeCap>10GB</totalSizeCap> - </rollingPolicy> - <filter class="org.onap.policy.drools.utils.logging.LoggerMarkerFilter$MetricLoggerMarkerFilter" /> - <encoder> - <pattern>${metricPattern}</pattern> - </encoder> - </appender> - - <appender name="AsyncMetricOut" class="ch.qos.logback.classic.AsyncAppender"> - <appender-ref ref="MetricOut" /> - </appender> - - <appender name="TransactionOut" class="ch.qos.logback.core.rolling.RollingFileAppender"> - <file>${logDir}/${transactionLog}.log</file> - <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> - <fileNamePattern>${logDir}/${transactionLog}.%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern> - <maxFileSize>50MB</maxFileSize> - <maxHistory>30</maxHistory> - <totalSizeCap>10GB</totalSizeCap> - </rollingPolicy> - <filter class="org.onap.policy.drools.utils.logging.LoggerMarkerFilter$TransactionLoggerMarkerFilter" /> - <encoder> - <pattern>${transactionPattern}</pattern> - </encoder> - </appender> - - <appender name="AsyncTransactionOut" class="ch.qos.logback.classic.AsyncAppender"> - <appender-ref ref="TransactionOut" /> - </appender> - - <logger name="network" level="INFO" additivity="false"> - <appender-ref ref="AsyncNetworkOut" /> - </logger> - - <logger name="org.eclipse.jetty.server.RequestLog" level="info" additivity="false"> - <appender-ref ref="AsyncNetworkOut" /> - </logger> - - <root level="INFO"> - <appender-ref ref="AsyncDebugOut" /> - <appender-ref ref="AsyncErrorOut" /> - <appender-ref ref="AsyncMetricOut" /> - <appender-ref ref="AsyncTransactionOut" /> - </root> + + <property name="logDir" value="${POLICY_LOGS}" /> + + <property name="errorLog" value="error" /> + <property name="debugLog" value="debug" /> + <property name="networkLog" value="network" /> + + <property name="metricLog" value="metric" /> + <property name="transactionLog" value="audit" /> + + <property name="debugPattern" + value="[%d{yyyy-MM-dd'T'HH:mm:ss.SSS+00:00, UTC}|%level|%logger{0}|%thread] %msg%n" /> + <property name="errorPattern" value="${debugPattern}" /> + <property name="networkPattern" value="[%d{yyyy-MM-dd'T'HH:mm:ss.SSS+00:00, UTC}|%t]%m%n" /> + <property name="abstractNetworkPattern" + value="[%d{yyyy-MM-dd'T'HH:mm:ss.SSS+00:00, UTC}] [%X{networkEventType:-NULL}|%X{networkProtocol:-NULL}|%X{networkTopic:-NULL}|%X{requestID:-NULL}]%n" /> + + <property name="metricPattern" + value="%X{RequestID}|%X{InvocationID}|%X{ServiceName}|%X{PartnerName}|%X{BeginTimestamp}|%X{EndTimestamp}|%X{ElapsedTime}|%X{ServiceInstanceID}|%X{VirtualServerName}|%X{StatusCode}|%X{ResponseCode}|%X{ResponseDescription}|%X{InstanceUUID}|%X{Severity}|%X{TargetEntity}|%X{TargetServiceName}|%X{Server}|%X{ServerIPAddress}|%X{ServerFQDN}|%X{ClientIPAddress}|%X{ProcessKey}|%X{RemoteHost}|%X{AlertSeverity}|%X{TargetVirtualEntity}|%level|%thread| %msg%n" /> + <property name="transactionPattern" value="${metricPattern}" /> + + <appender name="ErrorOut" class="ch.qos.logback.core.rolling.RollingFileAppender"> + <file>${logDir}/${errorLog}.log</file> + <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> + <fileNamePattern>${logDir}/${errorLog}.%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern> + <maxFileSize>50MB</maxFileSize> + <maxHistory>30</maxHistory> + <totalSizeCap>10GB</totalSizeCap> + </rollingPolicy> + <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> + <level>WARN</level> + </filter> + <encoder> + <pattern>${errorPattern}</pattern> + </encoder> + </appender> + + <appender name="AsyncErrorOut" class="ch.qos.logback.classic.AsyncAppender"> + <appender-ref ref="ErrorOut" /> + </appender> + + <appender name="DebugOut" class="ch.qos.logback.core.rolling.RollingFileAppender"> + <file>${logDir}/${debugLog}.log</file> + <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> + <fileNamePattern>${logDir}/${debugLog}.%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern> + <maxFileSize>50MB</maxFileSize> + <maxHistory>30</maxHistory> + <totalSizeCap>10GB</totalSizeCap> + </rollingPolicy> + <encoder> + <pattern>${debugPattern}</pattern> + </encoder> + </appender> + + <appender name="AsyncDebugOut" class="ch.qos.logback.classic.AsyncAppender"> + <appender-ref ref="DebugOut" /> + </appender> + + <appender name="NetworkOut" class="ch.qos.logback.core.rolling.RollingFileAppender"> + <file>${logDir}/${networkLog}.log</file> + <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> + <fileNamePattern>${logDir}/${networkLog}.%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern> + <maxFileSize>50MB</maxFileSize> + <maxHistory>30</maxHistory> + <totalSizeCap>10GB</totalSizeCap> + </rollingPolicy> + <encoder> + <pattern>${networkPattern}</pattern> + </encoder> + </appender> + + <appender name="AsyncNetworkOut" class="ch.qos.logback.classic.AsyncAppender"> + <appender-ref ref="NetworkOut" /> + </appender> + + <appender name="MetricOut" class="ch.qos.logback.core.rolling.RollingFileAppender"> + <file>${logDir}/${metricLog}.log</file> + <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> + <fileNamePattern>${logDir}/${metricLog}.%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern> + <maxFileSize>50MB</maxFileSize> + <maxHistory>30</maxHistory> + <totalSizeCap>10GB</totalSizeCap> + </rollingPolicy> + <filter class="org.onap.policy.drools.utils.logging.LoggerMarkerFilter$MetricLoggerMarkerFilter" /> + <encoder> + <pattern>${metricPattern}</pattern> + </encoder> + </appender> + + <appender name="AsyncMetricOut" class="ch.qos.logback.classic.AsyncAppender"> + <appender-ref ref="MetricOut" /> + </appender> + + <appender name="TransactionOut" class="ch.qos.logback.core.rolling.RollingFileAppender"> + <file>${logDir}/${transactionLog}.log</file> + <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> + <fileNamePattern>${logDir}/${transactionLog}.%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern> + <maxFileSize>50MB</maxFileSize> + <maxHistory>30</maxHistory> + <totalSizeCap>10GB</totalSizeCap> + </rollingPolicy> + <filter class="org.onap.policy.drools.utils.logging.LoggerMarkerFilter$TransactionLoggerMarkerFilter" /> + <encoder> + <pattern>${transactionPattern}</pattern> + </encoder> + </appender> + + <appender name="AsyncTransactionOut" class="ch.qos.logback.classic.AsyncAppender"> + <appender-ref ref="TransactionOut" /> + </appender> + + <logger name="network" level="INFO" additivity="false"> + <appender-ref ref="AsyncNetworkOut" /> + </logger> + + <logger name="org.eclipse.jetty.server.RequestLog" level="info" additivity="false"> + <appender-ref ref="AsyncNetworkOut" /> + </logger> + + <root level="INFO"> + <appender-ref ref="AsyncDebugOut" /> + <appender-ref ref="AsyncErrorOut" /> + <appender-ref ref="AsyncMetricOut" /> + <appender-ref ref="AsyncTransactionOut" /> + </root> </configuration> @@ -81,6 +81,7 @@ <module>feature-simulators</module> <module>feature-distributed-locking</module> <module>feature-controller-logging</module> + <module>feature-mdc-filters</module> <module>packages</module> </modules> |