bonfire
Bonfire is a command line interface to query Graylog searches via the REST API. It tries to emulate the feeling of using tail on a local file.
Usage
Examples:
> bonfire -h logserver -u jdoe -@ "10 minutes ago" "*" ... > bonfire -h logserver -u jdoe -f "source:localhost AND level:2" ...
Bonfire usage:
Usage: bonfire [OPTIONS] [QUERY]
Bonfire - An interactive graylog cli client
Options:
--node TEXT Label of a preconfigured graylog node
-h, --host TEXT Your graylog node's host
-s, --tls Use HTTPS
--port INTEGER Your graylog port (default: 12900)
--endpoint TEXT Your graylog API endpoint e.g /api (default:
/)
-u, --username TEXT Your graylog username
-p, --password TEXT Your graylog password (default: prompt)
-k, --keyring / -nk, --no-keyring
Use keyring to store/retrieve password
-@, --search-from TEXT Query range from
-#, --search-to TEXT Query range to (default: now)
-t, --tail Show the last n lines for the query
(default)
-d, --dump Print the query result as a csv
-o, --output TEXT Output logs to file (only tail/dump mode)
-f, --follow Poll the logging server for new logs
matching the query (sets search from to now,
limit to None)
-l, --interval INTEGER Polling interval in ms (default: 1000)
-n, --limit INTEGER Limit the number of results (default: 10)
-a, --latency INTEGER Latency of polling queries (default: 2)
-r, --stream TEXT Stream ID of the stream to query (default:
no stream filter)
-e, --field TEXT Fields to include in the query result
-x, --template-option TEXT Template options for the stored query
-s, --sort TEXT Field used for sorting (default: timestamp)
--asc / --desc Sort ascending / descending
--help Show this message and exit.
Configuration
Bonfire can be configured. It will look for a ~/.bonfire.cfg or a bonfire.cfg (in the current directory). The configuration file can specify API nodes. If no host is specified a node with the name default will be used. You can also configure queries which can be referenced by starting your query with a colon:
[node:default] host=1.2.3.4 port=12900 endpoint=/ username=jdoe [node:dev] host=4.3.2.1 port=9000 endpoint=/api username=jdoe [query:example] query=facility:*foo* AND source:*bar* from=2015-03-01 15:00:00 limit=100 fields=message,name,facility,source
Now you can run queries via such as:
> bonfire --node=dev :example ... runs the example query on the node dev > bonfire :example ... runs the example query on the default node
Query Templates
Options
Queries
Known Bugs
bonfire expects graylog’s timezone to be UTC.
Release Notes
- v0.0.7: Issues fixes, TLS and Proxy support
Adds support for proxies
Adds support for https urls
Add timestamps to the dump format
- v0.0.6: Documentation fix
Change of README.rst
- v0.0.5: Clean up
Removed terminal UI ideas
Added first tests
Fixed date and time handling with timezones
Added python3 compatibility
- v0.0.4: Extended documentation & stream access
Use the first stream the user has access to if no stream is specified and the user has no global search rights
- v0.0.3: Small fixes
Use accept header in GET requests.
Fix bug when querying specific fields
- v0.0.1: Initial release
Limited feature set.
Metadata
Release files for bonfire 0.0.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| bonfire-0.0.8.tar.gz | 15.0 kB | Without provenance | Details for bonfire-0.0.8.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| bonfire-0.0.8-py3-none-any.whl | Python 3 | none | any | Details for bonfire-0.0.8-py3-none-any.whl |
Total release size: 31.3 kB
Release files / bonfire-0.0.8.tar.gz
| Download URL | bonfire-0.0.8.tar.gz |
|---|---|
| Size | 15.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a2931515fe632c32a4cfbbb7d0b3ae159b84025c1c7dab7089ee9406cda588e6
|
|
BLAKE2b-256 checksum How to use checksums |
ecf070f29be40113055ada0429d750df3e0cdaad42e5944a83b5b1851328c3a9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.7.3
|
Release files / bonfire-0.0.8-py3-none-any.whl
| Download URL | bonfire-0.0.8-py3-none-any.whl |
|---|---|
| Size | 16.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
490b31dc92a803691414242f1becf353cb566d80934b50932f9dea25af1cf5cf
|
|
BLAKE2b-256 checksum How to use checksums |
8fe983a05260acdd3d778b194d8c2fcd0078fe04add43e99681568317a4bfc61
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.7.3
|
Security for bonfire 0.0.8
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.