FuseGuard Logo

fuseguard.components.loggers
Component DBLogReader

loggers.BaseLogReader
  |
  +--loggers.DBLogReader

I read from the log database and return results

Method Summary
public query getAllHostNames()
          Returns a query with column request_host
public query getAllThreatCategories()
          Returns a query with column threat_category
public numeric getAverageThreatLevel([numeric year="0"], [numeric month="0"], [numeric day="0"])
          returns the average threat level on a given day, month, or year
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"], [string filter_name=""])
          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=""], [string filter_name=""], [numeric limit="0"], [numeric page="1"])
          Returns a query with several columns, the detail column is not returned.
public void setDatasource(any datasource, [any username=""], [any password=""], [any dbtype=""])
          Sets the datasource name.

Methods inherited from loggers.BaseLogReader
getLogger, init
 

Method Detail

getAllHostNames

public query getAllHostNames()
Returns a query with column request_host


getAllThreatCategories

public query getAllThreatCategories()
Returns a query with column threat_category


getAverageThreatLevel

public numeric getAverageThreatLevel([numeric year="0"], [numeric month="0"], [numeric day="0"])
returns the average threat level on a given day, month, or year

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

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"], [string filter_name=""])
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"]
[string filter_name=""] - Pass in a filter_name to filter by.

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=""], [string filter_name=""], [numeric limit="0"], [numeric page="1"])
Returns a query with several columns, the detail column is not returned.

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
[string filter_name=""] - The name of the filter that triggered the log.
[numeric limit="0"] - Limit the number of records returned to this many
[numeric page="1"] - Page number when used with limit

setDatasource

public void setDatasource(any datasource, [any username=""], [any password=""], [any dbtype=""])
Sets the datasource name.

Parameters:
any datasource - The name of a valid datasource
[any username=""] - Optional, the datasource username
[any password=""] - Optional, the datasource password
[any dbtype=""] - mysql, sqlserver, or derby