-
Notifications
You must be signed in to change notification settings - Fork 8
/
zerolog.go
253 lines (214 loc) · 5.55 KB
/
zerolog.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
package zerolog
import (
"bytes"
"context"
"errors"
"io"
"log"
"os"
"sync"
"time"
"github.com/buger/jsonparser"
"github.com/rs/zerolog"
"github.com/axiomhq/axiom-go/axiom"
"github.com/axiomhq/axiom-go/axiom/ingest"
)
var (
_ = io.Writer(new(Writer))
// ErrMissingDataset is raised when a dataset name is not provided. Set it
// manually using the [SetDataset] option or export "AXIOM_DATASET".
ErrMissingDataset = errors.New("missing dataset name")
logger = log.New(os.Stderr, "[AXIOM|ZEROLOG]", 0)
loggerName = []byte(`"zerolog"`)
)
const (
defaultBatchSize = 10_000
flushInterval = time.Second
)
// Writer is a axiom events writer with std io.Writer interface.
type Writer struct {
client *axiom.Client
dataset string
clientOptions []axiom.Option
ingestOptions []ingest.Option
levels map[zerolog.Level]struct{}
byteCh chan []byte
closeOnce sync.Once
closeCh chan struct{}
}
// Write must not modify the slice data, even temporarily.
func (w *Writer) Write(data []byte) (int, error) {
select {
case <-w.closeCh:
default:
b := make([]byte, len(data))
copy(b, data)
w.byteCh <- b
}
return len(data), nil
}
func (w *Writer) Close() {
w.closeOnce.Do(func() {
close(w.byteCh)
<-w.closeCh
})
}
// Option configures axiom events writer.
type Option func(*Writer)
// SetClient configures a custom axiom client.
func SetClient(client *axiom.Client) Option {
return Option(func(cfg *Writer) {
cfg.client = client
})
}
// SetLevels configures zerolog levels that have to be sent to Axiom.
func SetLevels(levels []zerolog.Level) Option {
return Option(func(cfg *Writer) {
for _, level := range levels {
cfg.levels[level] = struct{}{}
}
})
}
// SetDataset configures the axiom dataset name.
func SetDataset(dataset string) Option {
return Option(func(cfg *Writer) {
cfg.dataset = dataset
})
}
// SetClientOptions configures the axiom client options.
func SetClientOptions(clientOptions []axiom.Option) Option {
return Option(func(cfg *Writer) {
cfg.clientOptions = clientOptions
})
}
// SetIngestOptions configures the axiom ingest options.
func SetIngestOptions(ingestOptions []ingest.Option) Option {
return Option(func(cfg *Writer) {
cfg.ingestOptions = ingestOptions
})
}
// New creates a new Writer that ingests logs into Axiom. It automatically takes
// its configuration from the environment. To connect, export the following
// environment variables:
//
// - AXIOM_TOKEN
// - AXIOM_ORG_ID (only when using a personal token)
// - AXIOM_DATASET
//
// The configuration can be set manually using options which are prefixed with
// "Set".
//
// An API token with "ingest" permission is sufficient enough.
//
// A Writer needs to be closed properly to make sure all logs are sent by calling
// [Writer.Close].
func New(opts ...Option) (*Writer, error) {
w := &Writer{
levels: make(map[zerolog.Level]struct{}),
ingestOptions: []ingest.Option{ingest.SetTimestampField(zerolog.TimestampFieldName), ingest.SetTimestampFormat(zerolog.TimeFieldFormat)},
clientOptions: []axiom.Option{},
byteCh: make(chan []byte, defaultBatchSize),
closeCh: make(chan struct{}),
}
// func supplied options.
for _, option := range opts {
if option == nil {
continue
}
option(w)
}
if len(w.levels) == 0 {
for _, level := range []zerolog.Level{zerolog.InfoLevel, zerolog.WarnLevel, zerolog.ErrorLevel, zerolog.FatalLevel, zerolog.PanicLevel} {
w.levels[level] = struct{}{}
}
}
// Create client, if not set.
if w.client == nil {
var err error
if w.client, err = axiom.NewClient(w.clientOptions...); err != nil {
return nil, err
}
}
// When the dataset name is not set, use "AXIOM_DATASET".
if w.dataset == "" {
w.dataset = os.Getenv("AXIOM_DATASET")
if w.dataset == "" {
return nil, ErrMissingDataset
}
}
go w.runBackgroundJob()
return w, nil
}
func (w *Writer) runBackgroundJob() {
var (
counter = 0
buffer = &bytes.Buffer{}
t = time.NewTicker(flushInterval)
encoder = axiom.ZstdEncoder()
)
defer t.Stop()
flush := func() error {
defer func() {
counter = 0
t.Reset(flushInterval)
buffer.Reset()
}()
if buffer.Len() == 0 {
return nil
}
r, err := encoder(buffer)
if err != nil {
return err
}
ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
defer cancel()
res, err := w.client.Ingest(ctx, w.dataset, r, axiom.NDJSON, axiom.Zstd, w.ingestOptions...)
if err != nil {
return err
}
if res.Failed > 0 {
logger.Printf("event(s) [%v] at %s failed to ingest: %s\n", res.Failed, res.Failures[0].Timestamp, res.Failures[0].Error)
}
return nil
}
defer close(w.closeCh)
for {
select {
case data, ok := <-w.byteCh:
if !ok {
if err := flush(); err != nil {
logger.Printf("failed to ingest events: %s\n", err)
}
return
}
if len(data) == 0 {
continue
}
counter++
lvlStr, err := jsonparser.GetUnsafeString(data, zerolog.LevelFieldName)
if err != nil {
logger.Printf("failed to retrieve level field name from data: %s\n", err)
continue
}
lvl, err := zerolog.ParseLevel(lvlStr)
if err != nil {
logger.Printf("failed to parse level: %s\n", err)
continue
}
if _, enabled := w.levels[lvl]; !enabled {
continue
}
data, _ = jsonparser.Set(data, loggerName, "logger")
buffer.Write(data)
if counter >= defaultBatchSize {
if err := flush(); err != nil {
logger.Printf("failed to ingest events: %s\n", err)
}
}
case <-t.C:
if err := flush(); err != nil {
logger.Printf("failed to ingest events: %s\n", err)
}
}
}
}