-
Notifications
You must be signed in to change notification settings - Fork 0
/
gcplog.go
255 lines (209 loc) · 5.5 KB
/
gcplog.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
package gcplog
import (
"context"
"fmt"
"log"
"net/http"
"os"
"regexp"
"runtime/debug"
"time"
"cloud.google.com/go/errorreporting"
"cloud.google.com/go/logging"
)
/*
Structs
*/
type GcpLogOptions struct {
ExtractUserFromRequest func(r *http.Request) string
DevelopmentLogger *log.Logger
}
type ResponseMetadata struct {
Status int
Size int
Latency time.Duration
}
// type GcpLog interface {
// Log(log LogEntry)
// Warn(err ErrorEntry)
// Error(err ErrorEntry)
// Close()
// }
/*
Constructor
*/
type GcpLog struct {
projectId string
serviceName string
loggingClient *logging.Client
errorClient *errorreporting.Client
logger *logging.Logger
options *GcpLogOptions
}
func NewGcpLog(projectId string, serviceName string, options GcpLogOptions) GcpLog {
if projectId == "" || serviceName == "" {
panic("Gcp log not correctly initialized.")
}
ctx := context.Background()
// Creates a Logging client.
loggingClient, err := logging.NewClient(ctx, projectId)
if err != nil {
log.Fatalf("Failed to create logging client: %v", err)
}
// Selects the log to write to.
logger := loggingClient.Logger(serviceName)
// Creates a Error reporting client.
errorClient, err := errorreporting.NewClient(ctx, projectId, errorreporting.Config{
ServiceName: serviceName,
OnError: func(err error) {
log.Printf("Could not log error: %v", err)
},
})
if err != nil {
log.Fatalf("Failed to create error reporting client: %v", err)
}
instance := GcpLog{
projectId: projectId,
serviceName: serviceName,
loggingClient: loggingClient,
errorClient: errorClient,
logger: logger,
options: &options,
}
return instance
}
/*
Public methods
*/
func (g *GcpLog) Close() {
errLogging := g.loggingClient.Close()
errError := g.errorClient.Close()
if errLogging != nil || errError != nil {
log.Printf("Failed to close client: %v, %v", errLogging, errError)
}
}
// LOG
func (g *GcpLog) Log(log interface{}) {
go g.log(log, nil, nil, logging.Info)
}
func (g *GcpLog) LogR(log interface{}, request *http.Request) {
go g.log(log, request, nil, logging.Info)
}
func (g *GcpLog) LogRM(log interface{}, request *http.Request, responseMeta *ResponseMetadata) {
go g.log(log, request, responseMeta, logging.Info)
}
// WARN
func (g *GcpLog) Warn(err error) {
go g.log(err, nil, nil, logging.Warning)
if os.Getenv("GO_ENV") == "production" {
go g.err(err, nil)
}
}
func (g *GcpLog) WarnR(err error, request *http.Request) {
go g.log(err, request, nil, logging.Warning)
if os.Getenv("GO_ENV") == "production" {
go g.err(err, request)
}
}
func (g *GcpLog) WarnRM(err error, request *http.Request, responseMeta *ResponseMetadata) {
go g.log(err, request, responseMeta, logging.Warning)
if os.Getenv("GO_ENV") == "production" {
go g.err(err, request)
}
}
// ERROR
func (g *GcpLog) Error(err error) {
go g.log(err.Error(), nil, nil, logging.Error)
if os.Getenv("GO_ENV") == "production" {
go g.err(err, nil)
}
}
func (g *GcpLog) ErrorR(err error, request *http.Request) {
go g.log(err.Error(), request, nil, logging.Error)
if os.Getenv("GO_ENV") == "production" {
go g.err(err, request)
}
}
func (g *GcpLog) ErrorRM(err error, request *http.Request, responseMeta *ResponseMetadata) {
go g.log(err.Error(), request, responseMeta, logging.Error)
if os.Getenv("GO_ENV") == "production" {
go g.err(err, request)
}
}
/*
Internal methods
*/
func (g *GcpLog) log(payload interface{}, request *http.Request, responseMeta *ResponseMetadata, severity logging.Severity) {
if os.Getenv("GO_ENV") == "development" && g.options.DevelopmentLogger != nil {
g.options.DevelopmentLogger.Println(payload)
} else {
defer g.logger.Flush()
entry := logging.Entry{
Payload: payload,
Severity: severity,
}
if request != nil {
httpRequest := parseRequest(request, responseMeta)
entry.HTTPRequest = &httpRequest
trace, span, traceSampled := parseTrace(request, g.projectId)
entry.Trace = trace
entry.SpanID = span
entry.TraceSampled = traceSampled
if g.options.ExtractUserFromRequest != nil {
user := g.options.ExtractUserFromRequest(request)
entry.Labels = map[string]string{"user": user}
}
}
g.logger.Log(entry)
}
}
func (g *GcpLog) err(err error, request *http.Request) {
defer g.errorClient.Flush()
errorEntry := errorreporting.Entry{
Error: err,
Stack: debug.Stack(),
}
if request != nil {
errorEntry.Req = request
}
g.errorClient.Report(errorEntry)
}
func parseRequest(r *http.Request, w *ResponseMetadata) logging.HTTPRequest {
localIp := r.Header.Get("X-Real-Ip")
if localIp == "" {
localIp = r.Header.Get("X-Forwarded-For")
}
if localIp == "" {
localIp = r.RemoteAddr
}
request := logging.HTTPRequest{
Request: r,
RequestSize: r.ContentLength,
LocalIP: localIp,
RemoteIP: r.RemoteAddr,
}
if w != nil {
request.Status = w.Status
request.ResponseSize = int64(w.Size)
request.Latency = w.Latency
}
return request
}
func parseTrace(r *http.Request, projectId string) (traceId string, spanId string, traceSampled bool) {
var traceRegex = regexp.MustCompile(
// Matches on "TRACE_ID"
`([a-f\d]+)?` +
// Matches on "/SPAN_ID"
`(?:/([a-f\d]+))?` +
// Matches on ";0=TRACE_TRUE"
`(?:;o=(\d))?`)
matches := traceRegex.FindStringSubmatch(r.Header.Get("X-Cloud-Trace-Context"))
traceId, spanId, traceSampled = matches[1], matches[2], matches[3] == "1"
if traceId != "" {
traceId = fmt.Sprintf("projects/%s/traces/%s", projectId, traceId)
}
if spanId == "0" {
spanId = ""
}
return
}