com.indexdata.serviceproxy.plugins

Class StatisticsPlugin

java.lang.Object

com.indexdata.serviceproxy.AbstractPlugin

com.indexdata.serviceproxy.plugins.StatisticsPlugin

All Implemented Interfaces:

Plugin

public class StatisticsPlugin
extends AbstractPlugin

Logs service-proxy requests for statistics and analysis. Will format the first part of the statement according to the Common Log Format, while attaching custom attributes to the end of the statement.

Will write separate log files for each virtual domain that is using this service proxy instance.

The root directory for the log files is configurable (set 'LOG_DIRECTORY' in property file) but will be defaulted to /var/log/masterkey/service-proxy

The construction of the log statement is still ongoing. The individual elements in the log statement are so far:

CLF elements

• remote host (ip address of the client)
• remote logname (always '-', not available)
• user name
• [time stamp]
• "users request"
• HTTP status code (always '-', not available)
• Content length (always '-', not available)

Additional elements so far

• HTTP session ID (intended for session count)
• Pazpar2 session ID
• Async status of the request ('open','done', or '-' depending on status)

Author:

Niels Erik

Constructor Summary

Constructors

Constructor and Description
StatisticsPlugin()

Method Summary

Modifier and Type	Method and Description
String	currentState(Document doc) Retrieves the completion status of an asynchronous request by inspecting any response element(s) that would indicate if the search is done yet or not.
String	getClfStatement() Returns first part of a log statement according to the Common Log Format.
String	getClfStatement(String statement) Returns first part of a log statement according to the Common Log Format, except that the request section will not necessarily contain method,URI,querystring,protocol but rather whatever is specified in 'statement'.
org.apache.log4j.Logger	getDomainLogger()
com.indexdata.masterkey.pazpar2.client.Pazpar2Client	getPazpar2Client()
int	getSearchNumber() Retrieves the status of an asynchronous request, by inspecting the 'activeclients' element.
String	getSessionInfo()
void	log(String state) Logs CLF statement with added session info (pazpar2, http, async state)
void	log(String statement, String state) Logs CLF statement, but instead of request info (method,query string,protocol etc) the provided statement string is logged.
void	serve(ServiceRequest request, ServiceResponse response, ChainControl chain) This method gets called during the chain processing by the container.

Methods inherited from class com.indexdata.serviceproxy.AbstractPlugin

getChainName, getConfig, getName, getNodeList, getXmlString, setChainName, setConfig, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StatisticsPlugin

public StatisticsPlugin()

Method Detail

serve

public void serve(ServiceRequest request,
                  ServiceResponse response,
                  ChainControl chain)
           throws ServiceException,
                  IOException

Description copied from interface: Plugin

This method gets called during the chain processing by the container.

Specified by:

serve in interface Plugin

Specified by:

serve in class AbstractPlugin

Parameters:

request - service request

response - service response

chain - chain-control utility

Throws:

IOException - of any kind

ServiceException

log

public void log(String state)

Logs CLF statement with added session info (pazpar2, http, async state)

log

public void log(String statement,
                String state)

Logs CLF statement, but instead of request info (method,query string,protocol etc) the provided statement string is logged.

Parameters:

statement -

getSearchNumber

public int getSearchNumber()

Retrieves the status of an asynchronous request, by inspecting the 'activeclients' element.

Parameters:

response -

Returns:

'done' if there are no 'activeclients' left, 'open' if there are still 'activeclients' running, and '-' if this distincition does not apply to this request, that is, if there is no 'activeclients' element in the response.

currentState

public String currentState(Document doc)

Retrieves the completion status of an asynchronous request by inspecting any response element(s) that would indicate if the search is done yet or not.

Parameters:

response -

Returns:

'done' if there are no active clients left, 'open' if there are still clients running, and '-' if this distinction does not apply to the current request/response.

getClfStatement

public String getClfStatement()

Returns first part of a log statement according to the Common Log Format. The elements status-code and content-length are represented by dashes ('-') and the end of the string since neither is available to the logger at this time.

Parameters:

req -

Returns:

log statement with 'hostname - username [timestamp] "method uri querystring protocol" - -'

getClfStatement

public String getClfStatement(String statement)

Returns first part of a log statement according to the Common Log Format, except that the request section will not necessarily contain method,URI,querystring,protocol but rather whatever is specified in 'statement'. The elements status-code and content-length are represented by dashes ('-') and the end of the string since neither is available to the logger at this time.

Parameters:

req -

Returns:

log statement with 'hostname - username [timestamp] "" - -'

getSessionInfo

public String getSessionInfo()

getDomainLogger

public org.apache.log4j.Logger getDomainLogger()

getPazpar2Client

public com.indexdata.masterkey.pazpar2.client.Pazpar2Client getPazpar2Client()