Skip to content

Using request log analyzer as a library

wvanbergen edited this page Sep 4, 2010 · 3 revisions

Instead of using request-log-analyzer as a command line tool, you can also use it as a library and integrate it into other Ruby applications.

  • You will need the RequestLogAnalyzer::Controller#build method if you want to use r-l-a just like the command line application.
  • See the DESIGN.rdoc file for more information about how r-l-a works internally.
  • RDoc documentation for all classes.
  • Contact us for more information about the API.

API stability

At this moment, we only offer a “best effort” guarantee for API stability. If your product uses request-log-analyzer’s API and is used by a lot of people, you can consider submitting a spec that tests the integration between your application and request-log-analyzer. See the Munin integration spec and the Scout integration spec for inspiration.

During development, we will do our best to keep these specs from failing to ensure that the integration keeps working as intended. If we really want to change something that will break the integration, we can give you a heads-up beforehand.