Skip to content

Commit 79bc477

Browse files
Vasilii Iakliushine_forbes
authored and
GitLab
committed
Merge branch 'ef-migrate-to-labkit-fields' into 'main'
Migrate logging to labkit v2 log helper methods See merge request https://gitlab.com/gitlab-org/gitlab-shell/-/merge_requests/1394 Merged-by: Vasilii Iakliushin <viakliushin@gitlab.com> Approved-by: Vasilii Iakliushin <viakliushin@gitlab.com> Approved-by: Kerri Miller <kerrizor@kerrizor.com> Reviewed-by: Kerri Miller <kerrizor@kerrizor.com> Reviewed-by: Vasilii Iakliushin <viakliushin@gitlab.com> Co-authored-by: e_forbes <eforbes@gitlab.com>
2 parents aae6a7f + 0bb087f commit 79bc477

22 files changed

Lines changed: 195 additions & 219 deletions

File tree

‎client/transport.go‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ import (
77
"time"
88

99
"gitlab.com/gitlab-org/labkit/correlation"
10-
"gitlab.com/gitlab-org/labkit/fields"
1110
"gitlab.com/gitlab-org/labkit/tracing"
1211
"gitlab.com/gitlab-org/labkit/v2/log"
1312
)
@@ -31,16 +30,16 @@ func (rt *transport) RoundTrip(request *http.Request) (*http.Response, error) {
3130

3231
response, err := rt.next.RoundTrip(request)
3332
ctx = log.WithFields(ctx,
34-
slog.String("method", request.Method),
35-
slog.String("url", request.URL.String()),
36-
slog.Float64("duration_s", time.Since(start).Seconds()),
33+
log.HTTPMethod(request.Method),
34+
log.HTTPURL(request.URL.String()),
35+
log.DurationS(time.Since(start)),
3736
)
3837
if err != nil {
39-
slog.ErrorContext(ctx, "Internal API unreachable", slog.String(fields.ErrorMessage, err.Error()))
38+
slog.ErrorContext(ctx, "Internal API unreachable", log.ErrorMessage(err.Error()))
4039
return response, err
4140
}
4241

43-
ctx = log.WithFields(ctx, slog.Int(fields.HTTPStatusCode, response.StatusCode))
42+
ctx = log.WithFields(ctx, log.HTTPStatusCode(response.StatusCode))
4443

4544
if response.StatusCode >= 400 {
4645
slog.ErrorContext(ctx, "Internal API error")

‎cmd/gitlab-shell/main.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ import (
1010
grpccodes "google.golang.org/grpc/codes"
1111
grpcstatus "google.golang.org/grpc/status"
1212

13-
"gitlab.com/gitlab-org/labkit/fields"
1413
"gitlab.com/gitlab-org/labkit/fips"
14+
"gitlab.com/gitlab-org/labkit/v2/log"
1515

1616
shellCmd "gitlab.com/gitlab-org/gitlab-shell/v14/cmd/gitlab-shell/command"
1717
"gitlab.com/gitlab-org/gitlab-shell/v14/internal/command"
@@ -74,7 +74,7 @@ func run() int {
7474
fips.Check()
7575

7676
if _, err := cmd.Execute(ctx); err != nil {
77-
slog.WarnContext(ctx, "gitlab-shell: main: command execution failed", slog.String(fields.ErrorMessage, err.Error()))
77+
slog.WarnContext(ctx, "gitlab-shell: main: command execution failed", log.ErrorMessage(err.Error()))
7878
if grpcstatus.Convert(err).Code() != grpccodes.Internal {
7979
console.DisplayWarningMessage(err.Error(), readWriter.ErrOut)
8080
}

‎cmd/gitlab-sshd/main.go‎

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ import (
1717
"gitlab.com/gitlab-org/gitlab-shell/v14/internal/logger"
1818
"gitlab.com/gitlab-org/gitlab-shell/v14/internal/sshd"
1919

20-
"gitlab.com/gitlab-org/labkit/fields"
2120
"gitlab.com/gitlab-org/labkit/monitoring"
2221
v2log "gitlab.com/gitlab-org/labkit/v2/log"
2322
)
@@ -54,9 +53,7 @@ func main() {
5453
var err error
5554
cfg, err = config.NewFromDir(*configDir)
5655
if err != nil {
57-
v2log.New().ErrorContext(ctx, "failed to load configuration from specified directory", slog.String(
58-
fields.ErrorMessage, err.Error(),
59-
))
56+
v2log.New().ErrorContext(ctx, "failed to load configuration from specified directory", v2log.ErrorMessage(err.Error()))
6057
}
6158
}
6259
logCloser := logger.ConfigureLogger(cfg)
@@ -67,7 +64,7 @@ func main() {
6764

6865
overrideConfigFromEnvironment(cfg)
6966
if err := isConfigSane(cfg); err != nil {
70-
ctx = v2log.WithFields(ctx, slog.String(fields.ErrorMessage, err.Error()))
67+
ctx = v2log.WithFields(ctx, v2log.ErrorMessage(err.Error()))
7168
if *configDir == "" {
7269
slog.ErrorContext(ctx, "no config-dir provided, using only environment variables")
7370
} else {
@@ -83,9 +80,7 @@ func main() {
8380

8481
server, err := sshd.NewServer(cfg)
8582
if err != nil {
86-
slog.ErrorContext(ctx, "Failed to start Gitlab built-in sshd", slog.String(
87-
fields.ErrorMessage, err.Error(),
88-
))
83+
slog.ErrorContext(ctx, "Failed to start Gitlab built-in sshd", v2log.ErrorMessage(err.Error()))
8984
}
9085

9186
// Startup monitoring endpoint.
@@ -103,7 +98,7 @@ func main() {
10398

10499
if err := server.ListenAndServe(ctx); err != nil {
105100
slog.ErrorContext(ctx, "GitLab built-in sshd failed to listen for new connections",
106-
slog.String(fields.ErrorMessage, err.Error()))
101+
v2log.ErrorMessage(err.Error()))
107102
}
108103
}
109104

@@ -123,8 +118,7 @@ func gracefulShutdown(
123118
slog.String("signal", sig.String()))
124119

125120
if err := server.Shutdown(); err != nil {
126-
slog.ErrorContext(ctx, "Error shutting down the server", slog.String(
127-
fields.ErrorMessage, err.Error()))
121+
slog.ErrorContext(ctx, "Error shutting down the server", v2log.ErrorMessage(err.Error()))
128122
}
129123
<-time.After(gracePeriod)
130124

@@ -140,9 +134,7 @@ func startupMonitoringEndpoint(ctx context.Context, cfg *config.Config, server *
140134
monitoring.WithServeMux(server.MonitoringServeMux()),
141135
)
142136

143-
slog.ErrorContext(ctx, "monitoring service raised an error", slog.String(
144-
fields.ErrorMessage, err.Error(),
145-
))
137+
slog.ErrorContext(ctx, "monitoring service raised an error", v2log.ErrorMessage(err.Error()))
146138
panic(err)
147139
}()
148140
}

‎go.mod‎

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ require (
1717
github.com/stretchr/testify v1.11.1
1818
gitlab.com/gitlab-org/cells/topology-service v0.0.0-20260213143839-af4593cd7194
1919
gitlab.com/gitlab-org/gitaly/v18 v18.9.0-rc4
20-
gitlab.com/gitlab-org/labkit v1.38.6
21-
golang.org/x/crypto v0.47.0
20+
gitlab.com/gitlab-org/labkit v1.40.1
21+
gitlab.com/gitlab-org/labkit/v2 v2.0.0-20260303104025-2b90740e814f
22+
golang.org/x/crypto v0.48.0
2223
golang.org/x/sync v0.19.0
23-
google.golang.org/grpc v1.77.0
24+
google.golang.org/grpc v1.79.1
2425
google.golang.org/protobuf v1.36.11
2526
gopkg.in/yaml.v3 v3.0.1
2627
)
@@ -51,7 +52,6 @@ require (
5152
github.com/felixge/httpsnoop v1.0.4 // indirect
5253
github.com/go-logr/logr v1.4.3 // indirect
5354
github.com/go-logr/stdr v1.2.2 // indirect
54-
github.com/go-ole/go-ole v1.3.0 // indirect
5555
github.com/gogo/protobuf v1.3.2 // indirect
5656
github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect
5757
github.com/golang/protobuf v1.5.4 // indirect
@@ -63,15 +63,14 @@ require (
6363
github.com/googleapis/gax-go/v2 v2.15.0 // indirect
6464
github.com/grpc-ecosystem/go-grpc-middleware v1.4.0 // indirect
6565
github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.3.3 // indirect
66-
github.com/grpc-ecosystem/grpc-gateway/v2 v2.27.3 // indirect
66+
github.com/grpc-ecosystem/grpc-gateway/v2 v2.28.0 // indirect
6767
github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
6868
github.com/hashicorp/yamux v0.1.2-0.20220728231024-8f49b6f63f18 // indirect
6969
github.com/jmespath/go-jmespath v0.4.0 // indirect
7070
github.com/klauspost/compress v1.18.1 // indirect
7171
github.com/kylelemons/godebug v1.1.0 // indirect
7272
github.com/lightstep/lightstep-tracer-common/golang/gogo v0.0.0-20210210170715-a8dfcb80d3a7 // indirect
73-
github.com/lightstep/lightstep-tracer-go v0.25.0 // indirect
74-
github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 // indirect
73+
github.com/lightstep/lightstep-tracer-go v0.26.0 // indirect
7574
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
7675
github.com/oklog/ulid/v2 v2.1.1 // indirect
7776
github.com/onsi/ginkgo v1.16.5 // indirect
@@ -80,21 +79,15 @@ require (
8079
github.com/philhofer/fwd v1.1.3-0.20240916144458-20a13a1f6b7c // indirect
8180
github.com/pkg/errors v0.9.1 // indirect
8281
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
83-
github.com/power-devops/perfstat v0.0.0-20240221224432-82ca36839d55 // indirect
8482
github.com/prometheus/client_model v0.6.2 // indirect
8583
github.com/prometheus/common v0.67.5 // indirect
8684
github.com/prometheus/procfs v0.19.2 // indirect
8785
github.com/prometheus/prometheus v0.54.0 // indirect
8886
github.com/sebest/xff v0.0.0-20210106013422-671bd2870b3a // indirect
89-
github.com/shirou/gopsutil/v3 v3.24.5 // indirect
90-
github.com/shoenig/go-m1cpu v0.1.6 // indirect
9187
github.com/sirupsen/logrus v1.9.4 // indirect
9288
github.com/tinylib/msgp v1.3.0 // indirect
93-
github.com/tklauser/go-sysconf v0.3.15 // indirect
94-
github.com/tklauser/numcpus v0.10.0 // indirect
9589
github.com/uber/jaeger-client-go v2.30.0+incompatible // indirect
9690
github.com/uber/jaeger-lib v2.4.1+incompatible // indirect
97-
github.com/yusufpapurcu/wmi v1.2.4 // indirect
9891
gitlab.com/gitlab-org/go/reopen v1.0.0 // indirect
9992
go.etcd.io/raft/v3 v3.6.0 // indirect
10093
go.opencensus.io v0.24.0 // indirect
@@ -103,27 +96,27 @@ require (
10396
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.63.0 // indirect
10497
go.opentelemetry.io/contrib/propagators/jaeger v1.39.0 // indirect
10598
go.opentelemetry.io/contrib/propagators/ot v1.39.0 // indirect
106-
go.opentelemetry.io/otel v1.39.0 // indirect
107-
go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.39.0 // indirect
99+
go.opentelemetry.io/otel v1.41.0 // indirect
100+
go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.41.0 // indirect
108101
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.39.0 // indirect
109-
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.39.0 // indirect
110-
go.opentelemetry.io/otel/metric v1.39.0 // indirect
111-
go.opentelemetry.io/otel/sdk v1.39.0 // indirect
112-
go.opentelemetry.io/otel/trace v1.39.0 // indirect
102+
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.41.0 // indirect
103+
go.opentelemetry.io/otel/metric v1.41.0 // indirect
104+
go.opentelemetry.io/otel/sdk v1.41.0 // indirect
105+
go.opentelemetry.io/otel/trace v1.41.0 // indirect
113106
go.opentelemetry.io/proto/otlp v1.9.0 // indirect
114107
go.uber.org/atomic v1.11.0 // indirect
115108
go.uber.org/multierr v1.11.0 // indirect
116109
go.yaml.in/yaml/v2 v2.4.3 // indirect
117-
golang.org/x/net v0.48.0 // indirect
118-
golang.org/x/oauth2 v0.34.0 // indirect
119-
golang.org/x/sys v0.40.0 // indirect
120-
golang.org/x/text v0.33.0 // indirect
110+
golang.org/x/net v0.50.0 // indirect
111+
golang.org/x/oauth2 v0.35.0 // indirect
112+
golang.org/x/sys v0.41.0 // indirect
113+
golang.org/x/text v0.34.0 // indirect
121114
golang.org/x/time v0.14.0 // indirect
122115
golang.org/x/xerrors v0.0.0-20240716161551-93cc26a95ae9 // indirect
123116
google.golang.org/api v0.256.0 // indirect
124117
google.golang.org/genproto v0.0.0-20250922171735-9219d122eba9 // indirect
125-
google.golang.org/genproto/googleapis/api v0.0.0-20251202230838-ff82c1b0f217 // indirect
126-
google.golang.org/genproto/googleapis/rpc v0.0.0-20251202230838-ff82c1b0f217 // indirect
118+
google.golang.org/genproto/googleapis/api v0.0.0-20260209200024-4cfbd4190f57 // indirect
119+
google.golang.org/genproto/googleapis/rpc v0.0.0-20260209200024-4cfbd4190f57 // indirect
127120
gopkg.in/DataDog/dd-trace-go.v1 v1.32.0 // indirect
128121
)
129122

0 commit comments

Comments
 (0)