Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/martinbaillie/go-graylog
Golang library and reference client for interfacing the Graylog API.
https://github.com/martinbaillie/go-graylog
api cli golang graylog graylog-server library
Last synced: 11 days ago
JSON representation
Golang library and reference client for interfacing the Graylog API.
- Host: GitHub
- URL: https://github.com/martinbaillie/go-graylog
- Owner: martinbaillie
- License: bsd-3-clause
- Created: 2018-01-27T10:08:27.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-31T09:52:24.000Z (almost 6 years ago)
- Last Synced: 2024-06-20T05:21:12.322Z (5 months ago)
- Topics: api, cli, golang, graylog, graylog-server, library
- Language: Go
- Homepage:
- Size: 3.09 MB
- Stars: 9
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](/LICENSE)
[](https://goreportcard.com/report/github.com/martinbaillie/go-graylog)
[](http://godoc.org/github.com/martinbaillie/go-graylog)
[](https://travis-ci.org/martinbaillie/go-graylog)
[](https://github.com/martinbaillie/go-graylog/releases/latest)
# go-graylog
This repository contains Golang bindings for the complete Graylog API and a reference CLI that implements a very small subset of the API.
The CLI is self-serving at this stage i.e. I needed the current subset of commands implemented. However, if you find it useful and but lacking a certain command you need then don't be shy about raising an issue. Likewise, PRs are most welcome.
### API
The library is currently coded to Graylog `v2.4.0-beta.3+a6b18a2`. YMMV if you're not on the 2.4 stream of Graylog (latest at the time of writing this).
It starts here: `go get -u github.com/martinbaillie/go-graylog/...` [[Godoc]](https://godoc.org/github.com/martinbaillie/go-graylog/pkg).
If you're developing with the library I would start by referencing your Graylog server's API browser at `/api/api-browser` but then searching through `pkg` or the Godoc for the name of the endpoint—it's often not in the package you would expect due to some [awkward codegen](./api/README.md).
### CLI
At this time, only search functionality is implemented in the CLI.
Features of note:
- Ability to search and merge messages from *multiple* Graylog servers with (`-s`) with colour coded results to differentiate (if `$TERM` supports).
- Follow mode (`-f`) in `search relative` command for tail-like behaviour.
- Use `-p, --pass -` to keep passwords out of your shell history.
- Show/hide Graylog's own timestamp (in UTC or Local) with `-t, --timestamps`.
##### Search Options
```
Usage:
graylog search [command]
Available Commands:
absolute Search for messages using an absolute timerange
keyword Search for messages in a natural language timerange
relative Search for messages starting from a relative timestamp
Flags:
-h, --help help for search
-t, --timestamps print message timestamps (local timezone)
--utc -t print UTC message timestamps (has no effect without -t)
Global Flags:
-p, --pass string graylog pass (use "-" for masked prompt) (default "admin")
-s, --servers strings graylog server(s) to query (default [localhost:9000])
-u, --user string graylog user (default "admin")
Use "graylog search [command] --help" for more information about a command.
```
##### Search: Absolute
```
Search for messages using an absolute timerange, specified as from/to
with format yyyy-MM-ddTHH:mm:ss.SSSZ (e.g. 2014-01-23T15:34:49.000Z) or
yyyy-MM-dd HH:mm:ss.
Usage:
graylog search absolute [flags]
Flags:
--from string from this absolute timestamp e.g. "2018-01-01 00:00:00"
-h, --help help for absolute
--to string to this absolute timestamp e.g. "2018-02-01 00:00:00"
Global Flags:
-d, --debug print debug information
-p, --pass string graylog pass (use "-" for masked prompt) (default "admin")
-s, --servers stringSlice graylog server(s) to query (default [localhost:9000])
-t, --timestamps print message timestamps (local timezone)
-u, --user string graylog user (default "admin")
--utc -t print UTC message timestamps (has no effect without -t)
-x, --filter Filter e.g. (streams:stream_id)
```
##### Search: Keyword
```
Search for messages in a natural language timerange e.g. "yesterday" or "2 weeks ago to wednesday".
Usage:
graylog search keyword [flags]
Flags:
-h, --help help for keyword
--keyword string natural language timerange e.g. "yesterday" or "2 weeks ago to wednesday"
Global Flags:
-p, --pass string graylog pass (use "-" for masked prompt) (default "admin")
-s, --servers strings graylog server(s) to query (default [localhost:9000])
-t, --timestamps print message timestamps (local timezone)
-u, --user string graylog user (default "admin")
--utc -t print UTC message timestamps (has no effect without -t)
-x, --filter Filter e.g. (streams:stream_id)
```
##### Search: Relative
```
Search for messages starting from a relative timestamp until now.
The timestamp must be a valid Golang duration e.g. "2h".
Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
Usage:
graylog search relative [flags]
Flags:
-f, --follow follow mode (tail-like functionality)
-h, --help help for relative
-i, --interval duration follow mode polling interval e.g. "5m" (default 5s)
--since duration from this relative Golang timestamp until now e.g. "2h"
Global Flags:
-p, --pass string graylog pass (use "-" for masked prompt) (default "admin")
-s, --servers strings graylog server(s) to query (default [localhost:9000])
-t, --timestamps print message timestamps (local timezone)
-u, --user string graylog user (default "admin")
--utc -t print UTC message timestamps (has no effect without -t)
-x, --filter Filter e.g. (streams:stream_id)
```