Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NTA-89: Add a keyword filter #80

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions core/src/main/java/io/narayana/nta/Configuration.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
package io.narayana.nta;

import io.narayana.nta.logparsing.as8.filters.PackageFilter;
import io.narayana.nta.logparsing.as8.filters.KeywordFilter;
import io.narayana.nta.logparsing.as8.handlers.*;

import java.io.File;
Expand Down Expand Up @@ -80,6 +81,7 @@ public final class Configuration {

public static final Class[] LOG_FILTERS = new Class[]{
PackageFilter.class,
KeywordFilter.class,
};

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
package io.narayana.nta.logparsing.as8.filters;

import org.apache.log4j.Logger;

import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;

public class GetFilterKeywords {
private List<String> filterKeywords;
private static final Logger logger = Logger.getLogger(GetFilterKeywords.class.getName());

private static class GetFilterKeywordsHolder {
private static final GetFilterKeywords INSTANCE = new GetFilterKeywords();
}

public static final GetFilterKeywords getInstance() {
return GetFilterKeywordsHolder.INSTANCE;
}

private GetFilterKeywords() {
InputStream inputStream = null;
try {
Properties prop = new Properties();
filterKeywords = new ArrayList<>();

String propFileName = "filter.properties";
logger.warn(getClass().getClassLoader().getResource(""));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This log message does not server any purpose.

inputStream = getClass().getClassLoader().getResourceAsStream(propFileName);
if (inputStream != null) {
prop.load(inputStream);
} else {
throw new FileNotFoundException("property file '" + propFileName + "' not found in the classpath");
}

for (String name : prop.stringPropertyNames()) {
if (name.contains("keywords"))
filterKeywords.add(prop.getProperty(name));
}
} catch (Exception e) {
e.printStackTrace();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps you should be logging something here (either INFO, WARN, or ERROR depending upon the consequences of not finding any filter keywords - I would have thought that if you don't have anything to match against then it would be a fatal error).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1, printStackTrace should be replaced with a log message or // ignore if its expected but I would hope its not expected

} finally {
try {
inputStream.close();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

inputStream could be null

} catch (IOException ignored) {
}
}
}

public List<String> getFilterKeywords() {
return filterKeywords;
}
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
/*
* JBoss, Home of Professional Open Source.
* Copyright 2016, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/

package io.narayana.nta.logparsing.as8.filters;

import io.narayana.nta.logparsing.common.Filter;

import java.util.List;

/**
* @author huyuan
*/
public class KeywordFilter implements Filter {


@Override
public boolean matches(String line) throws IndexOutOfBoundsException {

List<String> keywordList = GetFilterKeywords.getInstance().getFilterKeywords();

try {
for (String s : keywordList) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

keywordList could be null

if (line.contains(s)) { // if black list use !line.contains(s)
return true;
}
}
return false;
} catch (IndexOutOfBoundsException e) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think anything throws IndexOutOfBoundsException so you can remove it from both the throws and the catch clauses.

return false;
}
}
}
4 changes: 4 additions & 0 deletions core/src/main/resources/filter.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
keywords.1=TransactionImple
keywords.2=Periodic Recovery
keywords.3=TransactionSynchronizationRegistryImple
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't Amos suggest a comma separated list of keywords here. Why did you go back to this approach.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I suggest and it looks like she used the wrong old properties file.


Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ public static WebArchive createDeployment() {
.addAsWebInfResource(new FileAsset(new File("src/test/resources/persistence.xml")),
"classes/META-INF/persistence.xml")
.addAsManifestResource(new FileAsset(new File("src/test/resources/nta-test-ds.xml")), "nta-test-ds.xml")
.addAsManifestResource(new FileAsset(new File("src/test/resources/filter.properties")), "filter.properties")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would recommend getting resources via the class loader instead of using hard code paths.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the filter.properties will be added into a test.war and deployed into the container during the aruquillian running the tests. I do not understand how to use the class loader here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assumed that you suggest like the following

new File(getClass().getClassLoader().getResource("filter.properties").toURI());

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kind of, but using the getPath() method instead. But I would have thought just the following should work:

addAsManifestResource("filter.properties")

I would try that first.

//.addAsManifestResource(new FileAsset(new File("src/test/resources/nta-test-mysql-ds.xml")), "nta-test-mysql-ds.xml")
.addAsLibraries(libs)
.setManifest(new StringAsset(ManifestMF));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ public static WebArchive createDeployment() {
.addAsWebInfResource(new FileAsset(new File("src/test/resources/persistence.xml")),
"classes/META-INF/persistence.xml")
.addAsManifestResource(new FileAsset(new File("src/test/resources/nta-test-ds.xml")), "nta-test-ds.xml")
.addAsManifestResource(new FileAsset(new File("src/test/resources/filter.properties")), "filter.properties")
.setManifest(new StringAsset(ManifestMF));
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ public static WebArchive createDeployment() {
.addAsWebInfResource(new FileAsset(new File("src/test/resources/persistence.xml")),
"classes/META-INF/persistence.xml")
.addAsManifestResource(new FileAsset(new File("src/test/resources/nta-test-ds.xml")), "nta-test-ds.xml")
.addAsManifestResource(new FileAsset(new File("src/test/resources/filter.properties")), "filter.properties")
.addAsLibraries(libs)
.setManifest(new StringAsset(ManifestMF));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ public static WebArchive createDeployment() {
.addAsWebInfResource(new FileAsset(new File("src/test/resources/persistence.xml")),
"classes/META-INF/persistence.xml")
.addAsManifestResource(new FileAsset(new File("src/test/resources/nta-test-ds.xml")), "nta-test-ds.xml")
.addAsManifestResource(new FileAsset(new File("src/test/resources/filter.properties")), "filter.properties")
.setManifest(new StringAsset(ManifestMF));
}

Expand Down
4 changes: 4 additions & 0 deletions core/src/test/resources/filter.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
keywords.1=TransactionImple
keywords.2=Periodic Recovery
keywords.3=TransactionSynchronizationRegistryImple

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How did you decide on this list of keywords. If they are controlling which log lines are passed on for further processing then there are many others that need to be included, for example BasicAction.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, they are controlling the lines we don't need.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's exactly the reason why the JIRA is incomplete. A good JIRA will explain the requirement and perhaps where the requirement originates from.

Why is there not a need for filters that block lines and other filters that match lines. If there is such a need then you would need at least two property names, for example: matching_keywords and blocked_keywords