diff --git a/README.md b/README.md new file mode 100644 index 0000000..55637f3 --- /dev/null +++ b/README.md @@ -0,0 +1,124 @@ +#Hoover + + +A python wrapper used to hit the [Loggly](http://loggly.com "Loggly"). API + +For more information on Hoover see + +##Install + +With this git repo: + cd /hoover + sudo python setup.py install + + + +Easy Install: + $easy_install -U hoover + +Pypi: + + + +##Using Hoover + + +Enter your credentials in hoover.LogglySession after importing: + + + import hoover + . + . + . + i = hoover.LogglySession('','','') + + 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 + +For more details on using search within Loggly check out + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescription
rowsNumber of rows returned by your query. Defaults to 10.
startOffset for starting row. Defaults to 0.
starttimeStart time for the search. Defaults to NOW-24HOURS.
endtimeEnd time for the search. Defaults to NOW.
orderDirection of results returned, either 'asc' or 'desc'. Defaults to 'desc'.
callbackJSONP callback to receive a JSONP response.
formatOutput format, either 'json', 'xml', or 'text'. Defaults to 'json'
fieldsWhich fields should be output. One or more of the following separated by commas: 'id', 'timestamp', 'ip', 'inputname', 'text'.
+ +##More Functions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FunctionDescription
*.config_inputs()Configures each input in your loggly account, register a python logger + with the input's name logging to the input.
*.create_input()Creates a new input on your loggly account.
*.facets()Thin wrapper on Loggly's facet search API. facetby can be input, ip, or date
*.http_inputs()Lists all http inputs
*.search()See above "Search Properties"
*.inputsLists all inputs
+ + +Meta +---- + +Created and maintained by Mike Blume + +If you have questions contact support@loggly.com