File: logging.go

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (112 lines) | stat: -rw-r--r-- 2,451 bytes parent folder | download
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
// Package log provides logging utilities
package log

import (
	"net/http"

	"github.com/sirupsen/logrus"
	"gitlab.com/gitlab-org/labkit/log"
	"gitlab.com/gitlab-org/labkit/mask"
	"golang.org/x/net/context"

	"gitlab.com/gitlab-org/gitlab/workhorse/internal/helper/exception"
)

// Fields represents logrus fields
type Fields = log.Fields

// Builder provides a fluent API for logging
type Builder struct {
	entry  *logrus.Entry
	fields log.Fields
	req    *http.Request
	err    error
}

// NewBuilder creates a new log builder
func NewBuilder() *Builder {
	return &Builder{entry: log.WithFields(nil)}
}

// WithRequest sets the request for logging
func WithRequest(r *http.Request) *Builder {
	return NewBuilder().WithRequest(r)
}

// WithRequest sets the request for logging
func (b *Builder) WithRequest(r *http.Request) *Builder {
	if r == nil {
		return b
	}

	b.req = r
	b.WithFields(log.ContextFields(r.Context())).WithFields(
		Fields{
			"method": r.Method,
			"uri":    mask.URL(r.RequestURI),
		},
	)
	return b
}

// WithFields sets the additional fields for logging
func WithFields(fields Fields) *Builder {
	return NewBuilder().WithFields(fields)
}

// WithFields sets the additional fields for logging
func (b *Builder) WithFields(fields Fields) *Builder {
	b.fields = fields
	b.entry = b.entry.WithFields(fields)
	return b
}

// WithContextFields sets the context fields for logging
func WithContextFields(ctx context.Context, fields Fields) *Builder {
	return WithFields(log.ContextFields(ctx)).WithFields(fields)
}

// WithError sets the error for logging
func WithError(err error) *Builder {
	return NewBuilder().WithError(err)
}

// WithError sets the error for logging
func (b *Builder) WithError(err error) *Builder {
	b.err = err
	b.entry = b.entry.WithError(err)
	return b
}

// Info logs informational messages
func Info(args ...interface{}) {
	NewBuilder().Info(args...)
}

// Info logs informational messages
func (b *Builder) Info(args ...interface{}) {
	b.entry.Info(args...)
}

// Error logs error messages
func Error(args ...interface{}) {
	NewBuilder().Error(args...)
}

func (b *Builder) trackException() {
	if b.err != nil {
		exception.Track(b.req, b.err, b.fields)
	}
}

// Error logs error messages
func (b *Builder) Error(args ...interface{}) {
	b.trackException()
	b.entry.Error(args...)
}

// Fatal logs fatal messages
func (b *Builder) Fatal(args ...interface{}) {
	b.trackException()
	b.entry.Fatal(args...)
}