2. API Reference

The framework is designed in a modular fashion with a separate module for each log input format, each data output format, a few auxilliary modules for the datatypes exposed by the framework and their functionality. Where possible, standards dictating formats are linked in the API reference.

Each module comes with documentation including examples of usage. The best way to learn the framework is to peruse the API reference and try out the examples, modifying them to suit your purposes.

• 2.1. lars - Introduction
  • 2.1.1. Filtering rows
  • 2.1.2. Manipulating row content
• 2.2. lars.apache - Reading Apache Logs
  • 2.2.1. Classes
  • 2.2.2. Data
  • 2.2.3. Exceptions
  • 2.2.4. Examples
• 2.3. lars.iis - Reading IIS Logs
  • 2.3.1. Classes
  • 2.3.2. Exceptions
  • 2.3.3. Examples
  • 2.3.4. Note for maintainers
• 2.4. lars.csv - Writing CSV Files
  • 2.4.1. Classes
  • 2.4.2. Data
  • 2.4.3. Examples
• 2.5. lars.sql - Direct Database Output
  • 2.5.1. Classes
  • 2.5.2. Exceptions
  • 2.5.3. Examples
• 2.6. lars.geoip - GeoIP Database Access
  • 2.6.1. Functions
  • 2.6.2. Examples
• 2.7. lars.datatypes - Web Log Datatypes
  • 2.7.1. Classes
  • 2.7.2. Functions
• 2.8. lars.progress - Rendering Progress
  • 2.8.1. Classes
  • 2.8.2. Examples
• 2.9. lars.dns - DNS Resolution
  • 2.9.1. Functions
• 2.10. lars.cache - Cache Decorators
  • 2.10.1. Functions