https://github.com/requilence/logspout-regexp
logspout regexp adapter to match docker containers logs and send them to Telegram chat
https://github.com/requilence/logspout-regexp
containers devops devops-tools docker logging logs logspout telegram
Last synced: 4 months ago
JSON representation
logspout regexp adapter to match docker containers logs and send them to Telegram chat
- Host: GitHub
- URL: https://github.com/requilence/logspout-regexp
- Owner: requilence
- License: mit
- Created: 2019-11-27T10:52:03.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-11-27T12:55:30.000Z (over 5 years ago)
- Last Synced: 2024-05-01T14:27:31.085Z (about 1 year ago)
- Topics: containers, devops, devops-tools, docker, logging, logs, logspout, telegram
- Language: Go
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# logspout-regexp
A minimalistic adapter for github.com/gliderlabs/logspout to match docker containers logs with regexp and notify in case the match found.
Currently, supporting Telegram and StdErr as output.
## How to build
Follow the instructions in https://github.com/gliderlabs/logspout/tree/master/custom on how to build your own Logspout container with custom modules.
Basically just copy the contents of the custom folder and include:
```go
package main
import (
_ "github.com/requilence/logspout-regexp"
)
```
in modules.go. Or just clone this repo and use [logspout-module](https://github.com/requilence/logspout-regexp/tree/master/logspout-module) dir from this repo.
Then you can run `docker build -t logspout-regexp .` inside this dir.
## How to use
Use by setting a docker environment variable: `ROUTE_URIS=regexp://bot?file=regexps.txt&hide_matched_string=1"`
The default transport is `stderr`, but this adapter mainly created to work with Telegram. You should put the right bot's token(you've got from [@BotFather](https://t.me/BotFather) and chat's id.
Here is an example:
`ROUTE_URIS=regexp+tg://bot?file=regexps.txt&throttle_seconds=600&hide_matched_string=1&chat=123&token=112233444:AAEfzA2_Q-FnUfasuib2_DAfdsn23jnK5s6QcQ"`
Full command to run docker container with `logspout-regexp`:
```bash
docker run --name="logspout" \
--volume=/var/run/docker.sock:/var/run/docker.sock \
--mount type=bind,source=$(pwd)/regexps.txt,target=/regexps.txt \
-e "ROUTE_URIS=regexp+tg://bot?file=regexps.txt&throttle_seconds=600&hide_matched_string=1&chat=123&token=112233444:AAEfzA2_Q-FnUfasuib2_DAfdsn23jnK5s6QcQ" \
logspout-regexp:latest
```
## Regexps file
In your `regexps.txt` you can put regexps to match containers logs. Each line should be a new regexp:
```
(?i)([A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,24})
part_of_sensitive_info
```