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

Prev

Update master

  • Loading branch information
Joe Friedrich
Joe Friedrich committed Jun 12, 2012
commit d8fa5e664c906bb1b3dc2ab0e0d02f232d9b3785
@@ -1,7 +1,7 @@
#Hoover


A python wrapper used to hit the Loggly API
A python wrapper used to hit the [Loggly](http://loggly.com "Loggly"). API

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

@@ -16,9 +16,7 @@ With this git repo:
Easy Install:
$easy_install -U hoover

Pypi:

<http://pypi.python.org/pypi/Hoover>
Pypi: <http://pypi.python.org/pypi/Hoover>



@@ -40,6 +38,7 @@ Enter your credentials in hoover.LogglySession after importing:

##Search Properties

For more details on using search within Loggly check out <http://wiki.loggly.com/searchguide>

<table>
<tr>
@@ -56,7 +55,7 @@ Enter your credentials in hoover.LogglySession after importing:
</tr>
<tr>
<td>starttime</td>
<td><Start time for the search. Defaults to NOW-24HOURS.</td>
<td>Start time for the search. Defaults to NOW-24HOURS.</td>
</tr>
<tr>
<td>endtime</td>
@@ -81,16 +80,6 @@ Enter your credentials in hoover.LogglySession after importing:
</tr>
</table>

##Search Guide


Be Aware:

* Does not support case-sensitive searches. Everything is case-insensitive.
* Punctuations are not search-able. For example, '[' or ']' are not indexed, so a search for: '[error]' is the same as a search for 'error'
* Right now, we break on case-changes or changes from numerical to alpha characters. So, a search for 'www' will find results containing 'www111' or 'www112ww'.


##More Functions

<table>
@@ -101,23 +90,28 @@ Be Aware:
</tr>
<tr>
<td>*.config_inputs()</td>
<td></td>
<td>Configures each input in your loggly account, register a python logger
with the input's name logging to the input.</td>
</tr>
<tr>
<td>*.create_input()</td>
<td></td>
<td>Creates a new input on your loggly account.</td>
</tr>
<tr>
<td>*.facets()</td>
<td></td>
<td>Thin wrapper on Loggly's facet search API. facetby can be input, ip, or date</td>
</tr>
<tr>
<td>*.http_inputs()</td>
<td></td>
<td>Lists all http inputs</td>
</tr>
<tr>
<td>*.search()</td>
<td></td>
<td>See above "Search Properties"</td>
</tr>
<tr>
<td>*.inputs</td>
<td>Lists all inputs</td>
</tr>
</table>

ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.