mirror of
https://github.com/resmoio/kubernetes-event-exporter.git
synced 2026-08-24 01:06:22 +00:00
youyongsong
15f2feb28f
I known File Sink is currently mostly used in local development, but we also tend to use it in our production environment with fluentd, because this combination is very stable and reliable.
Currently File Sink lacks the file rolling function, which is very important for the production environment. So I want to add file rolling function to File Sink through this pr without breaking changes.
file rolling is disabled by default, and can be enabled by adding the following arguments:
```yaml
- receivers:
file:
path: ./test.log
maxsize: 20 // if ./test.log is larger than 20MB, it will be renamed to ./test-<datetime>.log as a backup file,
and create a new file named test.log to receive events. It defaults to 100 megabytes.
maxage: 20 // if backup files ./test-<datetime>.log are created 20 days ago, they will be deleted. The default
is not to remove old log files based on age.
maxbackups: 3 // if backup files are more than 3, older backup files will be removed.
```
the rolling function is powered by [lumberjack](https://github.com/natefinch/lumberjack). Becasue `lumberjack.Logger` implmented `io.WriteCloser` interface, so it is easy to replace `file *os.file` with `writer &lumberjack.Logger`.
run kubernetes-event-exporter with following config:
```yaml
logLevel: debug
route:
match:
- receiver: "file"
receivers:
- name: "file"
file:
path: "./event.log"
maxsize: 1
maxbackups: 4
```
run following script to generate events and output `./event*.log` status:
```shell
while true
do
kubectl run nginx --image nginx || kubectl delete deployment nginx
ls -lh event*.log
sleep 2
done
```
the result is:
```
deployment.apps "nginx" deleted
-rw-r--r-- 1 ysyou staff 1.0M Mar 4 18:03 event-2020-03-04T10-03-30.271.log
-rw-r--r-- 1 ysyou staff 1.0M Mar 4 18:15 event-2020-03-04T10-15-52.496.log
-rw-r--r-- 1 ysyou staff 1.0M Mar 4 18:28 event-2020-03-04T10-28-27.334.log
-rw-r--r-- 1 ysyou staff 1.0M Mar 4 18:41 event-2020-03-04T10-41-11.316.log
-rw-r--r-- 1 ysyou staff 1023K Mar 4 18:54 event.log
deployment.apps/nginx created
-rw-r--r-- 1 ysyou staff 1.0M Mar 4 18:15 event-2020-03-04T10-15-52.496.log
-rw-r--r-- 1 ysyou staff 1.0M Mar 4 18:28 event-2020-03-04T10-28-27.334.log
-rw-r--r-- 1 ysyou staff 1.0M Mar 4 18:41 event-2020-03-04T10-41-11.316.log
-rw-r--r-- 1 ysyou staff 1.0M Mar 4 18:54 event-2020-03-04T10-54-11.451.log
-rw-r--r-- 1 ysyou staff 2.0K Mar 4 18:54 event.log
```
when `event.log` reaches 1M, it is renamed to `event-2020-03-04T10-54-11.451.log`, because backup files are more than 4, the oldest one `event-2020-03-04T10-03-30.271.log` is deleted.
61 lines
1.2 KiB
Go
61 lines
1.2 KiB
Go
package sinks
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"io"
|
|
|
|
"github.com/opsgenie/kubernetes-event-exporter/pkg/kube"
|
|
"gopkg.in/natefinch/lumberjack.v2"
|
|
)
|
|
|
|
type FileConfig struct {
|
|
Path string `yaml:"path"`
|
|
Layout map[string]interface{} `yaml:"layout"`
|
|
MaxSize int `yaml:"maxsize"`
|
|
MaxAge int `yaml:"maxage"`
|
|
MaxBackups int `yaml:"maxbackups"`
|
|
}
|
|
|
|
func (f *FileConfig) Validate() error {
|
|
return nil
|
|
}
|
|
|
|
type File struct {
|
|
writer io.WriteCloser
|
|
encoder *json.Encoder
|
|
layout map[string]interface{}
|
|
}
|
|
|
|
func NewFileSink(config *FileConfig) (*File, error) {
|
|
writer := &lumberjack.Logger{
|
|
Filename: config.Path,
|
|
MaxSize: config.MaxSize,
|
|
MaxBackups: config.MaxBackups,
|
|
MaxAge: config.MaxAge,
|
|
}
|
|
|
|
return &File{
|
|
writer: writer,
|
|
encoder: json.NewEncoder(writer),
|
|
layout: config.Layout,
|
|
}, nil
|
|
}
|
|
|
|
func (f *File) Close() {
|
|
_ = f.writer.Close()
|
|
}
|
|
|
|
func (f *File) Send(ctx context.Context, ev *kube.EnhancedEvent) error {
|
|
if f.layout == nil {
|
|
return f.encoder.Encode(ev)
|
|
}
|
|
|
|
res, err := convertLayoutTemplate(f.layout, ev)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return f.encoder.Encode(res)
|
|
}
|