Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moul/rrgc
🗑 round-robin garbage-collector
https://github.com/moul/rrgc
backup garbage-collector gc round-robin
Last synced: 30 days ago
JSON representation
🗑 round-robin garbage-collector
- Host: GitHub
- URL: https://github.com/moul/rrgc
- Owner: moul
- License: other
- Created: 2021-06-27T14:30:22.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-07T18:10:56.000Z (about 1 month ago)
- Last Synced: 2024-10-07T20:58:22.779Z (about 1 month ago)
- Topics: backup, garbage-collector, gc, round-robin
- Language: Go
- Homepage: https://manfred.life/oss
- Size: 44.9 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: .github/SUPPORT.md
- Authors: AUTHORS
Awesome Lists containing this project
README
# rrgc
🗑 round-robin garbage-collector
[](https://pkg.go.dev/moul.io/rrgc)
[](https://github.com/moul/rrgc/blob/main/COPYRIGHT)
[](https://github.com/moul/rrgc/releases)
[](https://microbadger.com/images/moul/rrgc)
[](https://manfred.life/)
n
[](https://github.com/moul/rrgc/actions?query=workflow%3AGo)
[](https://github.com/moul/rrgc/actions?query=workflow%3ARelease)
[](https://github.com/moul/rrgc/actions?query=workflow%3APR)
[](https://golangci.com/r/github.com/moul/rrgc)
[](https://codecov.io/gh/moul/rrgc)
[](https://goreportcard.com/report/moul.io/rrgc)
[](https://www.codefactor.io/repository/github/moul/rrgc)
[](https://gitpod.io/#https://github.com/moul/rrgc)
## Usage
### As a CLI tool
[embedmd]:# (.tmp/usage.txt console)
```console
foo@bar:~$ rrgc -h
USAGE
rrgc WINDOWS -- GLOBS
FLAGS
-debug false debug
-keep false print list of files to keep instead of files to delete
foo@bar:~$ ls logs
A.log
B.log
C.log
D.log
E.log
F.log
G.log
H.log
I.log
J.log
K.log
L.log
M.log
N.log
O.log
P.log
Q.log
R.log
foo@bar:~$ rrgc 24h,5 1h,5 -- ./logs/*.log
logs/B.log
logs/C.log
logs/E.log
logs/H.log
logs/M.log
logs/N.log
logs/O.log
logs/P.log
logs/Q.log
logs/R.log
foo@bar:~$ rrgc --keep 24h,5 1h,5 -- ./logs/*.log
logs/A.log
logs/D.log
logs/F.log
logs/G.log
logs/I.log
logs/J.log
logs/K.log
logs/L.log
foo@bar:~$ rrgc 24h,5 1h,5 -- ./logs/*.log | xargs rm -v
removed 'logs/B.log'
removed 'logs/C.log'
removed 'logs/E.log'
removed 'logs/H.log'
removed 'logs/M.log'
removed 'logs/N.log'
removed 'logs/O.log'
removed 'logs/P.log'
removed 'logs/Q.log'
removed 'logs/R.log'
foo@bar:~$ ls logs
A.log
D.log
F.log
G.log
I.log
J.log
K.log
L.log
```
### As a Library
[embedmd]:# (rrgc/example_test.go /import\ / $)
```go
import (
"os"
"time"
"moul.io/rrgc/rrgc"
)
func Example() {
logGlobs := []string{
"*/*.log",
"*/*.log.gz",
}
windows := []rrgc.Window{
{Every: 2 * time.Hour, MaxKeep: 5},
{Every: time.Hour * 24, MaxKeep: 4},
{Every: time.Hour * 24 * 7, MaxKeep: 3},
}
_, toDelete, _ := rrgc.GCListByPathGlobs(logGlobs, windows)
for _, path := range toDelete {
_ = os.Remove(path)
}
}
```
[embedmd]:# (.tmp/godoc.txt txt /FUNCTIONS/ $)
```txt
FUNCTIONS
func GCListByPathGlobs(inputs []string, windows []Window) ([]string, []string, error)
GCListByPathGlobs computes a list of paths that should be kept and deleted,
based on a list of window rules.
TYPES
type Window struct {
Every time.Duration
MaxKeep int
}
Window defines a file preservation rule.
func ParseWindow(input string) (Window, error)
ParseWindow parses a human-readable Window definition.
Syntax: "Duration,MaxKeep".
Examples: "1h,5" "1h2m3s,42".
```
## Install
### Using go
```sh
go get moul.io/rrgc
```
### Releases
See https://github.com/moul/rrgc/releases
## Contribute
I really welcome contributions.
Your input is the most precious material.
I'm well aware of that and I thank you in advance.
Everyone is encouraged to look at what they can do on their own scale;
no effort is too small.
Everything on contribution is sum up here: [CONTRIBUTING.md](./.github/CONTRIBUTING.md)
### Dev helpers
Pre-commit script for install: https://pre-commit.com
### Contributors ✨
[](#contributors)
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Manfred Touron
🚧 📖 ⚠️ 💻
moul-bot
🚧
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors)
specification. Contributions of any kind welcome!
### Stargazers over time
[](https://starchart.cc/moul/rrgc)
## License
© 2021 [Manfred Touron](https://manfred.life)
Licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
([`LICENSE-APACHE`](LICENSE-APACHE)) or the [MIT license](https://opensource.org/licenses/MIT)
([`LICENSE-MIT`](LICENSE-MIT)), at your option.
See the [`COPYRIGHT`](COPYRIGHT) file for more details.
`SPDX-License-Identifier: (Apache-2.0 OR MIT)`