Class TCLogParser
- java.lang.Object
-
- org.apache.jmeter.protocol.http.util.accesslog.TCLogParser
-
- All Implemented Interfaces:
LogParser
- Direct Known Subclasses:
SharedTCLogParser
public class TCLogParser extends Object implements LogParser
Description:
Currently the parser only handles GET/POST requests. It's easy enough to add support for other request methods by changing checkMethod. The is a complete rewrite of a tool I wrote for myself earlier. The older algorithm was basic and did not provide the same level of flexibility I want, so I wrote a new one using a totally new algorithm. This implementation reads one line at a time using BufferedReader. When it gets to the end of the file and the sampler needs to get more requests, the parser will re-initialize the BufferedReader. The implementation uses StringTokenizer to create tokens.The parse algorithm is the following:
- cleans the entry by looking for backslash "\"
- looks to see if GET or POST is in the line
- tokenizes using quotes "
- finds the token with the request method
- gets the string of the token and tokenizes it using space
- finds the first token beginning with slash character
- tokenizes the string using question mark "?"
- get the path from the first token
- returns the second token and checks it for parameters
- tokenizes the string using ampersand "&"
- parses each token to name/value pairs
Extending this class is fairly simple. Most access logs use the same format starting from the request method. Therefore, changing the implementation of cleanURL(string) method should be sufficient to support new log formats. Tomcat uses common log format, so any webserver that uses the format should work with this parser. Servers that are known to use non standard formats are IIS and Netscape.
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
decode
by default, we probably should decode the parameter valuesprotected String
FILENAME
protected Filter
FILTER
Handles to supporting classesstatic String
GET
static String
HEAD
protected static Logger
log
static String
POST
protected BufferedReader
READER
protected String
RMETHOD
protected members *protected File
SOURCE
protected String
URL_PATH
The path to the access log fileprotected boolean
useFILE
-
Constructor Summary
Constructors Constructor Description TCLogParser()
TCLogParser(String source)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
checkMethod(String text)
The method checks forPOST
,GET
andHEAD
methods currently.boolean
checkParamFormat(String text)
Checks the string to see if it contains "&" and "=".boolean
checkURL(String url)
Checks the string to make sure it has/path/file?
String
cleanURL(String entry)
The method cleans the URL using the following algorithm.void
close()
close the any streams or readers.void
convertStringToJMRequest(String text, TestElement el)
Convert a single line into XMLNVPair[]
convertStringtoNVPair(String stringparams)
Parse the string parameters into NVPair[] array.boolean
decodeParameterValue()
decode the parameter values is to true by defaultprotected int
parse(BufferedReader breader, TestElement el, int parseCount)
The method is responsible for reading each line, and breaking out of the while loop if a set number of lines is given.
Note: empty lines will not be countedint
parse(TestElement el, int parseCount)
parse the entire file.int
parseAndConfigure(int count, TestElement el)
parse a set number of lines from the access log.protected int
parseLine(String line, TestElement el)
parseLine calls the other parse methods to parse the given text.protected NVPair
parseOneParameter(String parameter)
Method expects name and value to be separated by an equal sign "=".protected List<String>
parseParameters(String parameters)
Method uses StringTokenizer to convert the string into single pairs.void
setDecodeParameterValues(boolean decodeparams)
by default decode is set to true. if the parameters shouldn't be decoded, call the method with falsevoid
setFilter(Filter filter)
Use the filter to include/exclude files in the access logs.void
setSourceFile(String source)
Sets the source file.void
setUseParsedFile(boolean file)
Calls this method to set whether or not to use the path in the log.String
stripFile(String url, TestElement el)
Tokenize the URL into two tokens.StringTokenizer
tokenize(String line, String delim)
Parses the line using java.util.StringTokenizer.
-
-
-
Field Detail
-
log
protected static final Logger log
-
GET
public static final String GET
- See Also:
- Constant Field Values
-
POST
public static final String POST
- See Also:
- Constant Field Values
-
HEAD
public static final String HEAD
- See Also:
- Constant Field Values
-
RMETHOD
protected String RMETHOD
protected members *
-
URL_PATH
protected String URL_PATH
The path to the access log file
-
useFILE
protected boolean useFILE
-
SOURCE
protected File SOURCE
-
FILENAME
protected String FILENAME
-
READER
protected BufferedReader READER
-
FILTER
protected Filter FILTER
Handles to supporting classes
-
decode
protected boolean decode
by default, we probably should decode the parameter values
-
-
Constructor Detail
-
TCLogParser
public TCLogParser()
-
TCLogParser
public TCLogParser(String source)
- Parameters:
source
- name of the source file
-
-
Method Detail
-
setDecodeParameterValues
public void setDecodeParameterValues(boolean decodeparams)
by default decode is set to true. if the parameters shouldn't be decoded, call the method with false- Parameters:
decodeparams
- flag whether parameters should be decoded
-
decodeParameterValue
public boolean decodeParameterValue()
decode the parameter values is to true by default- Returns:
true
if parameter values should be decoded,false
otherwise
-
setUseParsedFile
public void setUseParsedFile(boolean file)
Calls this method to set whether or not to use the path in the log. We may want to provide the ability to filter the log file later on. By default, the parser uses the file in the log.- Parameters:
file
- flag whether to use the path from the log
-
setFilter
public void setFilter(Filter filter)
Use the filter to include/exclude files in the access logs. This is provided as a convenience and reduce the need to spend hours cleaning up log files.
-
setSourceFile
public void setSourceFile(String source)
Sets the source file.- Specified by:
setSourceFile
in interfaceLogParser
- Parameters:
source
- name of the source file
-
parse
public int parse(TestElement el, int parseCount)
parse the entire file.- Parameters:
el
- TestElement to read the lines intoparseCount
- number of max lines to read- Returns:
- number of read lines, or
-1
if an error occurred while reading
-
parseAndConfigure
public int parseAndConfigure(int count, TestElement el)
parse a set number of lines from the access log. Keep in mind the number of lines parsed will depend on the filter and number of lines in the log. The method returns the actual number of lines parsed.- Specified by:
parseAndConfigure
in interfaceLogParser
- Parameters:
count
- number of lines to readel
-TestElement
to read lines into- Returns:
- lines parsed
-
parse
protected int parse(BufferedReader breader, TestElement el, int parseCount)
The method is responsible for reading each line, and breaking out of the while loop if a set number of lines is given.
Note: empty lines will not be counted- Parameters:
breader
-BufferedReader
to read lines fromel
-TestElement
to read lines intoparseCount
- number of lines to read- Returns:
- number of lines parsed
-
parseLine
protected int parseLine(String line, TestElement el)
parseLine calls the other parse methods to parse the given text.- Parameters:
line
- single line to be parsedel
-TestElement
in which the line will be added- Returns:
- number of lines parsed (zero or one, actually)
-
cleanURL
public String cleanURL(String entry)
The method cleans the URL using the following algorithm.- check for double quotes
- check the request method
- tokenize using double quotes
- find first token containing request method
- tokenize string using space
- find first token that begins with "/"
127.0.0.1 - - [08/Jan/2003:07:03:54 -0500] "GET /addrbook/ HTTP/1.1" 200 1981
would result in the extracted url
/addrbook/
- Parameters:
entry
- line from which the url is to be extracted- Returns:
- cleaned url
-
checkMethod
public boolean checkMethod(String text)
The method checks forPOST
,GET
andHEAD
methods currently. The other methods aren't supported yet.- Parameters:
text
- text to be checked for HTTP method- Returns:
true
if method is supported,false
otherwise
-
stripFile
public String stripFile(String url, TestElement el)
Tokenize the URL into two tokens. If the URL has more than one "?", the parse may fail. Only the first two tokens are used. The first token is automatically parsed and set atURL_PATH
.- Parameters:
url
- url which should be stripped from parametersel
-TestElement
to parse url into- Returns:
- String presenting the parameters, or
null
when none where found
-
checkURL
public boolean checkURL(String url)
Checks the string to make sure it has/path/file?name=value
format. If the string doesn't contains a "?", it will returnfalse
.- Parameters:
url
- url to check for parameters- Returns:
true
if url contains a?
,false
otherwise
-
checkParamFormat
public boolean checkParamFormat(String text)
Checks the string to see if it contains "&" and "=". If it does, returntrue
, so that it can be parsed.- Parameters:
text
- text to be checked for&
and=
- Returns:
true
iftext
contains both&
and=
,false
otherwise
-
convertStringToJMRequest
public void convertStringToJMRequest(String text, TestElement el)
Convert a single line into XML- Parameters:
text
- to be be convertedel
-HTTPSamplerBase
which consumes thetext
-
convertStringtoNVPair
public NVPair[] convertStringtoNVPair(String stringparams)
Parse the string parameters into NVPair[] array. Once they are parsed, it is returned. The method uses parseOneParameter(string) to convert each pair.- Parameters:
stringparams
- String with parameters to be parsed- Returns:
- array of
NVPair
s
-
parseOneParameter
protected NVPair parseOneParameter(String parameter)
Method expects name and value to be separated by an equal sign "=". The method uses StringTokenizer to make a NVPair object. If there happens to be more than one "=" sign, the others are ignored. The chance of a string containing more than one is unlikely and would not conform to HTTP spec. I should double check the protocol spec to make sure this is accurate.- Parameters:
parameter
- to be parsed- Returns:
NVPair
with the parsed name and value of the parameter
-
parseParameters
protected List<String> parseParameters(String parameters)
Method uses StringTokenizer to convert the string into single pairs. The string should conform to HTTP protocol spec, which means the name/value pairs are separated by the ampersand symbol "&". Someone could write the querystrings by hand, but that would be round about and go against the purpose of this utility.- Parameters:
parameters
- string to be parsed- Returns:
- List of name/value pairs
-
tokenize
public StringTokenizer tokenize(String line, String delim)
Parses the line using java.util.StringTokenizer.- Parameters:
line
- line to be parseddelim
- delimiter- Returns:
- StringTokenizer constructed with
line
anddelim
-
-