Using the web console to run arbitrary queries

Architecturally, logworm is built in such a way that it's easy to create and add new applications to retrieve, process, and present the data that you store in logs. The command-line tools are one example of such tools, and another one is the web-based console located at console.logworm.com, which allows you to run arbitrary queries against your logs. You can also access the console from a Project's Home Page, by clicking on the 'Console' link:

The console has two modes: basic, and expert.

Basic mode

In Basic mode, you select the log table that you want to query and then specify optional conditions, field and row filters, and aggregation mechanisms. Internally the console issues a database query using the logworm querying language, just like the command-line tools do --the parameters that you specify in the console are, therefore, identical to the ones you can use with the command-like tools.

The query results are shown in the console as lists of log entries, ordered in reverse chronological order. The console will also show some important information about the query itself:

  • The number of rows that were retrieved
  • The time it took to execute the query
  • The expiration date for the results

By default, the results of queries are cached for 5 minutes, which for most cases is a reasonable limit. When you make queries using the API you can override that limit and set it to anything you want, including a 0 TTL if you need to get truly real-time information. From the console it is not possible to set an arbitrary caching limit, but you can force a refresh of the data, with the checkbox next to the "Run Query" button.

Expert mode

In expert mode, you write the query directly in the the logworm querying language. Basically, you specify a JSON document with one or more of the following elements:

  • fields or aggregate, for a listing of fields or aggregation functions, respectively,
  • conditions and timeframe, to restrict which log entries should be retrieved or considered for the aggregation, and
  • limit, to indicate how many log entries you want to get back

For a complete guide on how to write queries, please consult the logworm querying language reference document.

Back to Logging app-specific data with the HTTP request entries On to logging arbitrary data

Company   |   FAQ   |   Documentation   |   Blog