https://github.com/colecrouter/log-manager
https://github.com/colecrouter/log-manager
golang log-rotation logging
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/colecrouter/log-manager
- Owner: colecrouter
- License: gpl-3.0
- Created: 2022-05-18T00:36:38.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-12T01:09:25.000Z (over 2 years ago)
- Last Synced: 2024-06-22T02:15:36.882Z (about 2 years ago)
- Topics: golang, log-rotation, logging
- Language: Go
- Homepage:
- Size: 2.5 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Log-Manager
```bash
go get github.com/Mexican-Man/log-manager
```
There are lots of good log rotators out there, but I couldn't find one that gave me the granularity/number of features that I needed. So, I've compiled features from other log rotating packages into this one. If you think it's missing a feature, please open an issue or PR.
## How to Use
```go
import (
lm "github.com/Mexican-Man/log-manager"
)
manager := lm.NewLogManager(lm.LogManagerOptions{
Dir: "/path/to/logs",
RotationInterval: time.Hour * 24,
})
log.SetOutput(manager)
```
## Options
- *`Dir` — Directory to store logs in
- *`RotationInterval` — How often to rotate logs (0 disables it)
- `FilenameFormat` — Template string using [text/template](https://pkg.go.dev/text/template) (more info below)
- `MaxFileSize` — How large a file can get before its rotated (0 for no limit)
- `GZIP` — GZIP old logs
- `LatestDotLog` — Keeps a symlink called `latest` that points to the latest log
## More Details
### `Filenameformat`
Here's the templated struct format:
```go
type LogTemplate struct {
Time time.Time
Iteration uint
}
```
When rotating, `Interation` will increase if another log with the same name already exists. If increasing the iteration does not solve the issue, it will throw an error, and continue writing to the old log.
Here's the default, if not defined in `LogManagerOptions{}`:
```go
{{ .Time.Format "2006-01-02" }}_{{ .Iteration }}.log
```
This will print create logs like this:
- 2022-05-17_0.log
- 2022-05-17_1.log
- 2022-05-18_0.log
Here's another example:
```go
{{ .Time.Format "2006-01-02" }}{{ if .Iteration }}_{{ .Iteration }}{{ end }}.log
```
This will print create logs like this:
- 2022-05-17.log
- 2022-05-17_1.log
- 2022-05-18.log
> Note that the date format is the [Go's standard date formatting](https://pkg.go.dev/time#Time.Format).
### Scheduled Rotation
You can set `RotationInterval` to indicate when your logs should rotate. For example, a `RotationInterval` of
```go
time.Hour * 24
```
would ensure that logs are rotated everyday, at midnight. A `RotationInterval` of
```go
time.Hour * 12
```
would ensure that logs are rotated everyday, at midnight and noon.