Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/umputun/docker-logger
Logs collector for docker
https://github.com/umputun/docker-logger
docker logger logging sidecar syslog
Last synced: 9 days ago
JSON representation
Logs collector for docker
- Host: GitHub
- URL: https://github.com/umputun/docker-logger
- Owner: umputun
- License: mit
- Created: 2018-01-07T04:30:18.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-01T02:40:25.000Z (2 months ago)
- Last Synced: 2024-10-16T09:20:33.032Z (25 days ago)
- Topics: docker, logger, logging, sidecar, syslog
- Language: Go
- Size: 6.28 MB
- Stars: 246
- Watchers: 12
- Forks: 36
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# docker-logger [](https://goreportcard.com/report/github.com/umputun/docker-logger) [](https://hub.docker.com/r/umputun/docker-logger/)
**docker-logger** is a small application collecting logs from other containers on the host that started without
the `-t` option and configured with a logging driver that works with docker logs (journald and json-file).
It can forward both stdout and stderr of containers to local, rotated files and/or to remote syslog.
_note: [dkll](https://github.com/umputun/dkll) inlcudes all functionality of docker-logger, but adds server and cli client_
## Install
Copy provided [docker-compose.yml](https://github.com/umputun/docker-logger/blob/master/docker-compose.yml), customize if needed and run with `docker-compose up -d`. By default `docker-logger` will collect all logs from containers and put it to `./logs` directory.
## Customization
All changes can be done via container's environment in `docker-compose.yml` or with command line
| Command line | Environment | Default | Description |
|---------------------|-------------------| --------------------------- |-----------------------------------------------|
| `--docker` | `DOCKER_HOST` | unix:///var/run/docker.sock | docker host |
| `--syslog-host` | `SYSLOG_HOST` | 127.0.0.1:514 | syslog remote host (udp4) |
| `--files` | `LOG_FILES` | No | enable logging to files |
| `--syslog` | `LOG_SYSLOG` | No | enable logging to syslog |
| `--max-size` | `MAX_SIZE` | 10 | size of log triggering rotation (MB) |
| `--max-files` | `MAX_FILES` | 5 | number of rotated files to retain |
| `--mix-err` | `MIX_ERR` | false | send error to std output log file |
| `--max-age` | `MAX_AGE` | 30 | maximum number of days to retain |
| `--exclude` | `EXCLUDE` | | excluded container names, comma separated |
| `--include` | `INCLUDE` | | only included container names, comma separated |
| `--include-pattern` | `INCLUDE_PATTERN` | | only include container names matching a regex |
| `--exclude-pattern` | `EXCLUDE_PATTERN` | | only exclude container names matching a regex |
| | `TIME_ZONE` | UTC | time zone for container |
| `--json`, `-j` | `JSON` | false | output formatted as JSON |
- at least one of destinations (`files` or `syslog`) should be allowed
- location of log files can be mapped to host via `volume`, ex: `- ./logs:/srv/logs` (see `docker-compose.yml`)
- both `--exclude` and `--include` flags are optional and mutually exclusive, i.e. if `--exclude` defined `--include` not allowed, and vise versa.
- both `--include` and `--include-pattern` flags are optional and mutually exclusive, i.e. if `--include` defined `--include-pattern` not allowed, and vise versa.
## Build from the source
- clone this repo - `git clone https://github.com/umputun/docker-logger.git`
- build the logger - `cd docker-logger && docker build -t umputun/docker-logger .`
- try it - `docker run -it --rm -v $(pwd)/logs:/srv/logs -v /var/run/docker.sock:/var/run/docker.sock umputun/docker-logger /srv/docker-logger --files`