Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added some readme info #6

Merged
merged 4 commits into from Jun 27, 2012
Merged
Changes from 1 commit
Commits
File filter...
Filter file types
Jump to…
Jump to file
Failed to load files.

Always

Just for now

Next

Add Some Readme info

  • Loading branch information
Joe Friedrich
Joe Friedrich committed Jun 12, 2012
commit 16bce7768fde9794b8ee79d3bbfabd49fa2745f8
79 README
@@ -0,0 +1,79 @@
Hoover
=====

A python wrapper used to hit the Loggly API

For more information on Hoover see <http://wiki.loggly.com/hooverguide>

Install
-------



Using Hoover
------------

First you'll want to create a Loggly Session that will hold your subdomain, username, and password:
import hoover
.
.
.
i = hoover.LogglySession('<subdomain>','<username>','<password>')

i.search(q='apache2 error', starttime='NOW-2DAYS', format='csv')
i.search(q='json.priority:err', starttime='NOW-15MINUTES') #Defaults to json if format is left out


Search Properties
-----------------

<table>
<tr>
<th>Property</th>
<th>Description</th>
</tr>
<tr>
<td>rows</td>
<td>Number of rows returned by your query. Defaults to 10.</td>
</tr>
<tr>
<td>start</td>
<td>Offset for starting row. Defaults to 0.</td>
</tr>
<tr>
<td>starttime</td>
<td><Start time for the search. Defaults to NOW-24HOURS.</td>
</tr>
<tr>
<td>endtime</td>
<td>End time for the search. Defaults to NOW. </td>
</tr>
<tr>
<td>order</td>
<td>Direction of results returned, either 'asc' or 'desc'. Defaults to 'desc'.</td>
</tr>

<tr>
<td>callback</td>
<td>JSONP callback to receive a JSONP response.</td>
</tr>
<tr>
<td>format</td>
<td>Output format, either 'json', 'xml', or 'text'. Defaults to 'json'</td>
</tr>
<tr>
<td>fields</td>
<td>Which fields should be output. One or more of the following separated by commas: 'id', 'timestamp', 'ip', 'inputname', 'text'.</td>
</tr>
</table>


Python Logging
--------------

Meta
----

Created and maintained by Mike Blume

If you have questions contact support@loggly.com
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.