Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ichtrojan/thoth
An Error Logger for Go
https://github.com/ichtrojan/thoth
error error-handling go golang-package logger logging
Last synced: 2 months ago
JSON representation
An Error Logger for Go
- Host: GitHub
- URL: https://github.com/ichtrojan/thoth
- Owner: ichtrojan
- License: mit
- Created: 2020-01-05T11:57:56.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-04-06T16:56:24.000Z (almost 5 years ago)
- Last Synced: 2024-06-18T17:16:21.063Z (8 months ago)
- Topics: error, error-handling, go, golang-package, logger, logging
- Language: Go
- Homepage:
- Size: 37.1 KB
- Stars: 32
- Watchers: 3
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Thoth
## What is Thoth?
In Egyptian Mythology, Thoth was the Egyptian ibis-headed god of knowledge, magic and wisdom.
### In this Context
Thoth is an error logger for golang. It helps log errors to a log file so you can go back to find how why and when something breaks in production.
## Installation
You can install Thoth by running:
```bash
go get github.com/ichtrojan/thoth
```
## Usage
Thoth supports logging to two filetypes:
* log
* json
### Step one - Initiate Thoth
#### Thoth Initiation for `log`
```go
...
file, err := thoth.Init("log")
if err != nil {
log.Fatal(err)
}
...
```
#### Thoth Initiation for `json`
```go
...
json, err := thoth.Init("json")
if err != nil {
log.Fatal(err)
}
...
```
### Step two - Log errors
Regardless of the variable assigned to a Thoth `Init` function and log format; errors can be logged using the `Log` function.
#### Thoth Initiation for `log`
**Logging errors from packages**
```go
...
if err != nil {
file.Log(err)
}
...
```
**Logging custom errors based on a given condition**
```go
...
isBroke := true
if isBroke {
file.Log(errors.New("something went wrong"))
}
...
```
#### Thoth Initiation for `json`
**Logging errors from packages**
```go
...
if err != nil {
json.Log(err)
}
...
```
**Logging custom errors based on a given condition**
```go
...
high := true
if high {
json.Log(errors.New("highest in the room"))
}
...
```
### Step three - Serve real-time logs dashboard
You can serve a dashboard to view your logs in realtime using the `Serve` function. Depending on the filetype specified in the `Init` function, it will serve the content of your log file.
#### Usage format
```go
file.Serve({dashboard route}, {dashboard password})
```
#### Thoth serve for `log`
```go
...
if err := file.Serve("/logs", "12345"); err != nil {
log.Fatal(err)
}
if err := http.ListenAndServe(":8000", nil); err != nil {
file.Log(err)
}
...
```
The snippet above will serve your realtime log dashboard on port `8000` and can be visited on `/logs` route.
You can also check the [example](https://github.com/ichtrojan/thoth/tree/master/example) directory to see a sample usage.
>**NOTE**
>The realtime dashboard for `json` is currently on beta, it can be used but still looks experimental.
## Contributors
* Elvis Chuks - [GitHub](https://github.com/elvis-chuks) [Twitter](https://twitter.com/ElvisChuks15)
* Jude Dike - [GitHub](https://github.com/dumebi) [Twitter](https://twitter.com/bigbrutha_)
* Trojan Okoh - [GitHub](https://github.com/ichtrojan) [Twitter](https://twitter.com/ichtrojan)
## Conclusion
Contributions are welcome to this project to further improve it to suit the general public need. I hope you enjoy the simplicity of Thoth and cannot wait to see the wonderful project you build with it.