FuseGuard Logo

fuseguard.components.loggers
Component BaseLogReader

loggers.BaseLogReader

I am an abstract class for reading from a log

Method Summary
public BaseLogReader init([any firewall], [any logger])
          Initialize the LogReader on firewall startup.
public query getAllHostNames()
          Returns a query with column request_host
public query getAllThreatCategories()
          Returns a query with column threat_category
public query getCountFor(variablename field, [numeric minimum="0"], [numeric year="0"], [numeric month="0"], [numeric day="0"], [string threat_category=""], [string script_name=""], [string ip=""], [string host=""], [numeric threat_level="0"], [string blocked=""], [numeric maxrows="0"])
          Returns a query with the num column and column passed into the field argument.
public query getLogDetail([string id="0"])
          Returns all information about a particular log entry.
public query getLogEntries([numeric year="0"], [numeric month="0"], [numeric day="0"], [string threat_category=""], [string script_name=""], [string ip=""], [string host=""], [numeric threat_level="0"], [string blocked=""], [numeric limit="0"], [numeric page="1"])
          Returns a query with several columns
public BaseLogger getLogger()
          Return the logger that corresponds to this LogReader
 

Method Detail

getAllHostNames

public query getAllHostNames()
Returns a query with column request_host


getAllThreatCategories

public query getAllThreatCategories()
Returns a query with column threat_category


getCountFor

public query getCountFor(variablename field, [numeric minimum="0"], [numeric year="0"], [numeric month="0"], [numeric day="0"], [string threat_category=""], [string script_name=""], [string ip=""], [string host=""], [numeric threat_level="0"], [string blocked=""], [numeric maxrows="0"])
Returns a query with the num column and column passed into the field argument.

Parameters:
variablename field - One of: ip_address,script_name,threat_level,threat_category,filter_component,filter_name,request_date,request_host
[numeric minimum="0"]
[numeric year="0"] - Pass in a year to filter by year, or 0 for any year
[numeric month="0"] - Pass in a month to filter by month, or 0 for any month
[numeric day="0"] - Pass in a day or 0 to filter by any day
[string threat_category=""] - Pass in a threat category to filter by, or an empty string for any category.
[string script_name=""] - Pass in a URI to filter by, supports wildcards eg /admin/* will match anything under the admin uri.
[string ip=""] - Pass in an IP address to filter by.
[string host=""] - Pass in a hostname to filter by.
[numeric threat_level="0"] - Threat Level from 1-10
[string blocked=""] - Pass boolean to filter by blocked or not blocked
[numeric maxrows="0"]

getLogDetail

public query getLogDetail([string id="0"])
Returns all information about a particular log entry.

Parameters:
[string id="0"]

getLogEntries

public query getLogEntries([numeric year="0"], [numeric month="0"], [numeric day="0"], [string threat_category=""], [string script_name=""], [string ip=""], [string host=""], [numeric threat_level="0"], [string blocked=""], [numeric limit="0"], [numeric page="1"])
Returns a query with several columns

Parameters:
[numeric year="0"] - Pass in a year to filter by year, or 0 for any year
[numeric month="0"] - Pass in a month to filter by month, or 0 for any month
[numeric day="0"] - Pass in a day or 0 to filter by any day
[string threat_category=""] - Pass in a threat category to filter by, or an empty string for any category.
[string script_name=""] - Pass in a URI to filter by, supports wildcards eg /admin/* will match anything under the admin uri.
[string ip=""] - Pass in an IP address to filter by.
[string host=""] - Pass in a hostname to filter by.
[numeric threat_level="0"] - Threat Level from 1-10
[string blocked=""] - Pass boolean to filter by blocked or not blocked
[numeric limit="0"] - Limit the number of records returned to this many
[numeric page="1"] - Page number when used with limit

getLogger

public BaseLogger getLogger()
Return the logger that corresponds to this LogReader


init

public BaseLogReader init([any firewall], [any logger])
Initialize the LogReader on firewall startup.

Parameters:
[any firewall] - The firewall instance.
[any logger] - The logger that this LogReader corresponds to.