Interface Filter
- All Known Implementing Classes:
LogFilter,SessionFilter
public interface Filter
Description:
Filter interface is designed to make it easier to use Access Logs for JMeter test plans. Normally, a person would have to clean a log file manually and create the JMeter requests. The access log parse utility uses the filter to include/exclude files by either file name or regular expression pattern.
Filter interface is designed to make it easier to use Access Logs for JMeter test plans. Normally, a person would have to clean a log file manually and create the JMeter requests. The access log parse utility uses the filter to include/exclude files by either file name or regular expression pattern.
It will also be used by HttpSamplers that use access logs. Using access logs
is intended as a way to simulate production traffic. For functional testing,
it is better to use the standard functional testing tools in JMeter. Using
access logs can also reduce the amount of memory needed to run large test
plans.
-
Method Summary
Modifier and TypeMethodDescriptionvoidexcludeFiles(String[] filenames) Exclude all files in the arrayvoidexcludePattern(String[] regexp) Exclude any log entry that contains the following regular expression pattern.In case the user wants to replace the file extension, log parsers should call this method.voidincludeFiles(String[] filenames) Include all files in the array.voidincludePattern(String[] regexp) Include any log entry that contains the following regular expression pattern.booleanisFiltered(String path, org.apache.jmeter.testelement.TestElement sampler) Log parser will call this method to see if a particular entry should be filtered or not.voidreset()Tell the filter when the parsing has reached the end of the log file and is about to begin again.voidsetReplaceExtension(String oldextension, String newextension)
-
Method Details
-
setReplaceExtension
- Parameters:
oldextension- old extensionnewextension- new extension
-
includeFiles
Include all files in the array.- Parameters:
filenames- names of files to include
-
excludeFiles
Exclude all files in the array- Parameters:
filenames- names of files to exclude
-
includePattern
Include any log entry that contains the following regular expression pattern.- Parameters:
regexp- list of regexp that match entries that should be included
-
excludePattern
Exclude any log entry that contains the following regular expression pattern.- Parameters:
regexp- list of regexp that match entries that should be excluded
-
isFiltered
Log parser will call this method to see if a particular entry should be filtered or not.- Parameters:
path- log line that should be checked if it should to be filtered outsampler-TestElementin which the line would be added- Returns:
- boolean
trueif line should be filtered out,falseotherwise
-
filter
In case the user wants to replace the file extension, log parsers should call this method. This is useful for regression test plans. If a website is migrating from one platform to another and the file extension changes, the filter provides an easy way to do it without spending a lot of time.- Parameters:
text- log line to be filtered- Returns:
- String
-
reset
void reset()Tell the filter when the parsing has reached the end of the log file and is about to begin again. Gives the filter a chance to adjust it's values, if needed.
-