https://github.com/stephenmoloney/docker-log-cleaner
A standalone docker container designed to clear the log files for a docker container at specified intervals.
https://github.com/stephenmoloney/docker-log-cleaner
clean cleanup docker logs
Last synced: 3 months ago
JSON representation
A standalone docker container designed to clear the log files for a docker container at specified intervals.
- Host: GitHub
- URL: https://github.com/stephenmoloney/docker-log-cleaner
- Owner: stephenmoloney
- License: mit
- Created: 2017-02-05T14:18:20.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-02-09T14:18:47.000Z (over 8 years ago)
- Last Synced: 2025-01-11T14:30:55.223Z (5 months ago)
- Topics: clean, cleanup, docker, logs
- Language: Shell
- Homepage: https://hub.docker.com/r/smoloney/docker-log-cleaner/
- Size: 12.7 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## log-cleaner
### Features
- A standalone docker container.
- Designed to clear the log files for a docker container at specified intervals.
- Can be used for clearing logs in multiple containers.
- Only functional with the `driver: "json-file"`.
### Startup commands
```
sudo docker-compose up -d
```
force recreate and show logs
```
sudo docker-compose up -d --build --force-recreate && sudo docker-compose logs -f
```
### Environment variables
- `CLEAN_FREQUENCY` - an integer and represents seconds so 60 = 1 minute, 3600 = 1 hour
- `CONTAINERS_T0_CLEAN` - the ***container_name*** of the containers to have their logs cleaned.
- `INCLUDE_SELF` - whether the current container (`log-cleaner` by default) should also have it's logs cleaned, defaults to `TRUE`
- `SELF_NAME` - name of the current container (defaults to `log_cleaner`)
### Examples
The following `docker-compose.yml` example will clear the logs of containers with names `mongo nginx`
every 3600 seconds (hourly)
```
version: '2'
services:
log-cleaner:
image: smoloney/docker-log-cleaner:latest
build:
context: .
dockerfile: Dockerfile
container_name: log-cleaner
restart: unless-stopped
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- /var/lib/docker/containers/:/var/lib/docker/containers/
environment:
- CLEAN_FREQUENCY=3600
- CONTAINERS_T0_CLEAN=mongo nginx
- INCLUDE_SELF=FALSE
logging:
driver: "json-file"
options:
max-size: "1m"
max-file: "1"
```
The following `docker-compose.yml` example will clear the logs of containers with names `mongo nginx log-cleaner`
every 3600 seconds (hourly)
```
version: '2'
services:
log-cleaner:
image: smoloney/docker-log-cleaner:latest
build:
context: .
dockerfile: Dockerfile
container_name: log-cleaner
restart: unless-stopped
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- /var/lib/docker/containers/:/var/lib/docker/containers/
environment:
- CLEAN_FREQUENCY=3600
- CONTAINERS_T0_CLEAN=mongo nginx
- INCLUDE_SELF=TRUE
logging:
driver: "json-file"
options:
max-size: "1m"
max-file: "1"
```
The following `docker-compose.yml` example will clear the logs of containers with names `mongo nginx my-logger-cleaner`
every 3600 seconds (hourly)
```
version: '2'
services:
log-cleaner:
image: smoloney/docker-log-cleaner:latest
build:
context: .
dockerfile: Dockerfile
container_name: my-logger-cleaner
restart: unless-stopped
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- /var/lib/docker/containers/:/var/lib/docker/containers/
environment:
- CLEAN_FREQUENCY=3600
- CONTAINERS_T0_CLEAN=mongo nginx
- INCLUDE_SELF=TRUE
- SELF_NAME=my-logger-cleaner
logging:
driver: "json-file"
options:
max-size: "1m"
max-file: "1"
```
### Notes
- This project is not designed as a replacement for the [docker-compose logging directives](https://docs.docker.com/compose/compose-file/#/logging)
but rather as an adjunct to the logging directive.
- If this feature is implemented in `docker` then this project will become defunct and hopefully this will be the case. There
was an [issue about this](https://github.com/docker/compose/issues/1083) in `docker/compose` in github.
### Acknowledgement
- This project uses the [s6 process supervisor](http://skarnet.org/software/s6/)
### Licence
[MIT Licence](./LICENCE.md)