/
honeycomb.go
256 lines (224 loc) · 6.79 KB
/
honeycomb.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
254
255
256
package logger
import (
"errors"
"fmt"
"net/http"
"os"
"strings"
"time"
"github.com/honeycombio/dynsampler-go"
libhoney "github.com/honeycombio/libhoney-go"
"github.com/honeycombio/libhoney-go/transmission"
"github.com/honeycombio/refinery/config"
)
// HoneycombLogger is a Logger implementation that sends all logs to a Honeycomb
// dataset. It requires a HoneycombLogger section of the config to exist with
// three keys, LoggerHoneycombAPI, LoggerAPIKey, and LoggerDataset.
type HoneycombLogger struct {
Config config.Config `inject:""`
UpstreamTransport *http.Transport `inject:"upstreamTransport"`
Version string `inject:"version"`
loggerConfig config.HoneycombLoggerConfig
libhClient *libhoney.Client
builder *libhoney.Builder
sampler dynsampler.Sampler
}
type HoneycombEntry struct {
loggerConfig config.HoneycombLoggerConfig
builder *libhoney.Builder
sampler dynsampler.Sampler
}
const (
UnknownLevel config.HoneycombLevel = iota
DebugLevel
InfoLevel
WarnLevel
ErrorLevel
PanicLevel
)
func (h *HoneycombLogger) Start() error {
// logLevel is defined outside the HoneycombLogger section
// and is set independently, before Start() is called, so we need to
// preserve it.
// TODO: make LogLevel part of the HoneycombLogger/LogrusLogger sections?
logLevel := h.loggerConfig.Level
loggerConfig, err := h.Config.GetHoneycombLoggerConfig()
if err != nil {
return err
}
loggerConfig.Level = logLevel
h.loggerConfig = loggerConfig
var loggerTx transmission.Sender
if h.loggerConfig.LoggerAPIKey == "" {
loggerTx = &transmission.DiscardSender{}
} else {
loggerTx = &transmission.Honeycomb{
// logs are often sent in flurries; flush every half second
MaxBatchSize: 100,
BatchTimeout: 500 * time.Millisecond,
UserAgentAddition: "refinery/" + h.Version + " (metrics)",
Transport: h.UpstreamTransport,
PendingWorkCapacity: libhoney.DefaultPendingWorkCapacity,
}
}
if loggerConfig.LoggerSamplerEnabled {
h.sampler = &dynsampler.PerKeyThroughput{
ClearFrequencySec: 10,
PerKeyThroughputPerSec: loggerConfig.LoggerSamplerThroughput,
MaxKeys: 1000,
}
err := h.sampler.Start()
if err != nil {
return err
}
}
libhClientConfig := libhoney.ClientConfig{
APIHost: h.loggerConfig.LoggerHoneycombAPI,
APIKey: h.loggerConfig.LoggerAPIKey,
Dataset: h.loggerConfig.LoggerDataset,
Transmission: loggerTx,
}
libhClient, err := libhoney.NewClient(libhClientConfig)
if err != nil {
return err
}
h.libhClient = libhClient
if hostname, err := os.Hostname(); err == nil {
h.libhClient.AddField("hostname", hostname)
}
startTime := time.Now()
h.libhClient.AddDynamicField("process_uptime_seconds", func() interface{} {
return time.Now().Sub(startTime) / time.Second
})
h.builder = h.libhClient.NewBuilder()
// listen for responses from honeycomb, log to STDOUT if something unusual
// comes back
go h.readResponses()
// listen for config reloads
h.Config.RegisterReloadCallback(h.reloadBuilder)
fmt.Printf("Starting Honeycomb Logger - see Honeycomb %s dataset for service logs\n", h.loggerConfig.LoggerDataset)
return nil
}
func (h *HoneycombLogger) readResponses() {
resps := h.libhClient.TxResponses()
for resp := range resps {
respString := fmt.Sprintf("Response: status: %d, duration: %s", resp.StatusCode, resp.Duration)
// read response, log if there's an error
switch {
case resp.StatusCode == 0: // log message dropped due to sampling
continue
case resp.Err != nil:
fmt.Fprintf(os.Stderr, "Honeycomb Logger got an error back from Honeycomb while trying to send a log line: %s, error: %s, body: %s\n", respString, resp.Err.Error(), string(resp.Body))
case resp.StatusCode > 202:
fmt.Fprintf(os.Stderr, "Honeycomb Logger got an unexpected status code back from Honeycomb while trying to send a log line: %s, %s\n", respString, string(resp.Body))
}
}
}
func (h *HoneycombLogger) reloadBuilder() {
h.Debug().Logf("reloading config for Honeycomb logger")
// preserve log level
logLevel := h.loggerConfig.Level
loggerConfig, err := h.Config.GetHoneycombLoggerConfig()
if err != nil {
// complain about this both to STDOUT and to the previously configured
// honeycomb logger
fmt.Printf("failed to reload configs for Honeycomb logger: %+v\n", err)
h.Error().Logf("failed to reload configs for Honeycomb logger: %+v", err)
return
}
loggerConfig.Level = logLevel
h.loggerConfig = loggerConfig
h.builder.APIHost = h.loggerConfig.LoggerHoneycombAPI
h.builder.WriteKey = h.loggerConfig.LoggerAPIKey
h.builder.Dataset = h.loggerConfig.LoggerDataset
}
func (h *HoneycombLogger) Stop() error {
fmt.Printf("stopping honey logger\n")
libhoney.Flush()
return nil
}
func (h *HoneycombLogger) Debug() Entry {
if h.loggerConfig.Level > DebugLevel {
return nullEntry
}
ev := &HoneycombEntry{
loggerConfig: h.loggerConfig,
builder: h.builder.Clone(),
sampler: h.sampler,
}
ev.builder.AddField("level", "debug")
return ev
}
func (h *HoneycombLogger) Info() Entry {
if h.loggerConfig.Level > InfoLevel {
return nullEntry
}
ev := &HoneycombEntry{
loggerConfig: h.loggerConfig,
builder: h.builder.Clone(),
sampler: h.sampler,
}
ev.builder.AddField("level", "info")
return ev
}
func (h *HoneycombLogger) Error() Entry {
if h.loggerConfig.Level > ErrorLevel {
return nullEntry
}
ev := &HoneycombEntry{
loggerConfig: h.loggerConfig,
builder: h.builder.Clone(),
sampler: h.sampler,
}
ev.builder.AddField("level", "error")
return ev
}
func (h *HoneycombLogger) SetLevel(level string) error {
sanitizedLevel := strings.TrimSpace(strings.ToLower(level))
var lvl config.HoneycombLevel
switch sanitizedLevel {
case "debug":
lvl = DebugLevel
case "info":
lvl = InfoLevel
case "warn", "warning":
lvl = WarnLevel
case "error":
lvl = ErrorLevel
case "panic":
lvl = PanicLevel
default:
return errors.New(fmt.Sprintf("unrecognized logging level: %s", level))
}
h.loggerConfig.Level = lvl
return nil
}
func (h *HoneycombEntry) WithField(key string, value interface{}) Entry {
h.builder.AddField(key, value)
return h
}
func (h *HoneycombEntry) WithString(key string, value string) Entry {
return h.WithField(key, value)
}
func (h *HoneycombEntry) WithFields(fields map[string]interface{}) Entry {
h.builder.Add(fields)
return h
}
func (h *HoneycombEntry) Logf(f string, args ...interface{}) {
ev := h.builder.NewEvent()
msg := fmt.Sprintf(f, args...)
ev.AddField("msg", msg)
ev.Metadata = map[string]any{
"api_host": ev.APIHost,
"dataset": ev.Dataset,
}
level, ok := ev.Fields()["level"].(string)
if !ok {
level = "unknown"
}
if h.sampler != nil {
rate := h.sampler.GetSampleRate(fmt.Sprintf(`%s:%s`, level, msg))
ev.SampleRate = uint(rate)
}
ev.Send()
}