Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitceb48d7

Browse files
committed
chore: add debug logging and recovery to agent api
1 parentfa314fe commitceb48d7

File tree

8 files changed

+138
-83
lines changed

8 files changed

+138
-83
lines changed

‎agent/api.go‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,19 @@ import (
99
"github.com/google/uuid"
1010

1111
"github.com/coder/coder/v2/coderd/httpapi"
12+
"github.com/coder/coder/v2/coderd/httpmw/loggermw"
13+
"github.com/coder/coder/v2/coderd/tracing"
1214
"github.com/coder/coder/v2/codersdk"
15+
"github.com/coder/coder/v2/httpmw"
1316
)
1417

1518
func (a*agent)apiHandler() http.Handler {
1619
r:=chi.NewRouter()
20+
r.Use(
21+
httpmw.Recover(a.logger),
22+
tracing.StatusWriterMiddleware,
23+
loggermw.Logger(a.logger),
24+
)
1725
r.Get("/",func(rw http.ResponseWriter,r*http.Request) {
1826
httpapi.Write(r.Context(),rw,http.StatusOK, codersdk.Response{
1927
Message:"Hello from the agent!",

‎coderd/coderd.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ import (
9999
"github.com/coder/coder/v2/coderd/workspacestats"
100100
"github.com/coder/coder/v2/codersdk"
101101
"github.com/coder/coder/v2/codersdk/healthsdk"
102+
sharedhttpmw"github.com/coder/coder/v2/httpmw"
102103
"github.com/coder/coder/v2/provisionersdk"
103104
"github.com/coder/coder/v2/site"
104105
"github.com/coder/coder/v2/tailnet"
@@ -860,7 +861,7 @@ func New(options *Options) *API {
860861
prometheusMW:=httpmw.Prometheus(options.PrometheusRegistry)
861862

862863
r.Use(
863-
httpmw.Recover(api.Logger),
864+
sharedhttpmw.Recover(api.Logger),
864865
httpmw.WithProfilingLabels,
865866
tracing.StatusWriterMiddleware,
866867
tracing.Middleware(api.TracerProvider),

‎coderd/httpmw/loggermw/logger.go‎

Lines changed: 9 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,17 @@ import (
77
"net/url"
88
"strconv"
99
"strings"
10-
"sync"
1110
"time"
1211

1312
"github.com/go-chi/chi/v5"
1413

1514
"cdr.dev/slog"
1615
"github.com/coder/coder/v2/coderd/httpapi"
17-
"github.com/coder/coder/v2/coderd/rbac"
1816
"github.com/coder/coder/v2/coderd/tracing"
1917
)
2018

2119
var (
22-
safeParams= []string{"page","limit","offset"}
20+
safeParams= []string{"page","limit","offset","path"}
2321
countParams= []string{"ids","template_ids"}
2422
)
2523

@@ -124,95 +122,28 @@ func Logger(log slog.Logger) func(next http.Handler) http.Handler {
124122
}
125123
}
126124

127-
typeRequestLoggerinterface {
128-
WithFields(fields...slog.Field)
129-
WriteLog(ctx context.Context,statusint)
130-
WithAuthContext(actor rbac.Subject)
131-
}
132-
133125
typeSlogRequestLoggerstruct {
134-
log slog.Logger
135-
writtenbool
136-
messagestring
137-
start time.Time
138-
// Protects actors map for concurrent writes.
139-
mu sync.RWMutex
140-
actorsmap[rbac.SubjectType]rbac.Subject
141-
}
142-
143-
var_RequestLogger=&SlogRequestLogger{}
144-
145-
funcNewRequestLogger(log slog.Logger,messagestring,start time.Time)RequestLogger {
146-
return&SlogRequestLogger{
147-
log:log,
148-
written:false,
149-
message:message,
150-
start:start,
151-
actors:make(map[rbac.SubjectType]rbac.Subject),
152-
}
126+
log slog.Logger
127+
writtenbool
128+
messagestring
129+
start time.Time
130+
addFieldsfunc()
153131
}
154132

155133
func (c*SlogRequestLogger)WithFields(fields...slog.Field) {
156134
c.log=c.log.With(fields...)
157135
}
158136

159-
func (c*SlogRequestLogger)WithAuthContext(actor rbac.Subject) {
160-
c.mu.Lock()
161-
deferc.mu.Unlock()
162-
c.actors[actor.Type]=actor
163-
}
164-
165-
func (c*SlogRequestLogger)addAuthContextFields() {
166-
c.mu.RLock()
167-
deferc.mu.RUnlock()
168-
169-
usr,ok:=c.actors[rbac.SubjectTypeUser]
170-
ifok {
171-
c.log=c.log.With(
172-
slog.F("requestor_id",usr.ID),
173-
slog.F("requestor_name",usr.FriendlyName),
174-
slog.F("requestor_email",usr.Email),
175-
)
176-
}else {
177-
// If there is no user, we log the requestor name for the first
178-
// actor in a defined order.
179-
for_,v:=rangeactorLogOrder {
180-
subj,ok:=c.actors[v]
181-
if!ok {
182-
continue
183-
}
184-
c.log=c.log.With(
185-
slog.F("requestor_name",subj.FriendlyName),
186-
)
187-
break
188-
}
189-
}
190-
}
191-
192-
varactorLogOrder= []rbac.SubjectType{
193-
rbac.SubjectTypeAutostart,
194-
rbac.SubjectTypeCryptoKeyReader,
195-
rbac.SubjectTypeCryptoKeyRotator,
196-
rbac.SubjectTypeJobReaper,
197-
rbac.SubjectTypeNotifier,
198-
rbac.SubjectTypePrebuildsOrchestrator,
199-
rbac.SubjectTypeSubAgentAPI,
200-
rbac.SubjectTypeProvisionerd,
201-
rbac.SubjectTypeResourceMonitor,
202-
rbac.SubjectTypeSystemReadProvisionerDaemons,
203-
rbac.SubjectTypeSystemRestricted,
204-
}
205-
206137
func (c*SlogRequestLogger)WriteLog(ctx context.Context,statusint) {
207138
ifc.written {
208139
return
209140
}
210141
c.written=true
211142
end:=time.Now()
212143

213-
// Right before we write the log, we try to find the user in the actors
214-
// and add the fields to the log.
215-
c.addAuthContextFields()
144+
ifc.addFields!=nil {
145+
c.addFields()
146+
}
216147

217148
logger:=c.log.With(
218149
slog.F("took",end.Sub(c.start)),
Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
//go:build !slim
2+
3+
package loggermw
4+
5+
import (
6+
"context"
7+
"sync"
8+
"time"
9+
10+
"cdr.dev/slog"
11+
"github.com/coder/coder/v2/coderd/rbac"
12+
)
13+
14+
typeRequestLoggerinterface {
15+
WithFields(fields...slog.Field)
16+
WriteLog(ctx context.Context,statusint)
17+
WithAuthContext(actor rbac.Subject)
18+
}
19+
20+
typeRbacSlogRequestLoggerstruct {
21+
SlogRequestLogger
22+
// Protects actors map for concurrent writes.
23+
mu sync.RWMutex
24+
actorsmap[rbac.SubjectType]rbac.Subject
25+
}
26+
27+
var_RequestLogger=&RbacSlogRequestLogger{}
28+
29+
funcNewRequestLogger(log slog.Logger,messagestring,start time.Time)RequestLogger {
30+
rlogger:=&RbacSlogRequestLogger{
31+
SlogRequestLogger:SlogRequestLogger{
32+
log:log,
33+
written:false,
34+
message:message,
35+
start:start,
36+
},
37+
actors:make(map[rbac.SubjectType]rbac.Subject),
38+
}
39+
rlogger.addFields=rlogger.addAuthContextFields
40+
returnrlogger
41+
}
42+
43+
func (c*RbacSlogRequestLogger)WithAuthContext(actor rbac.Subject) {
44+
c.mu.Lock()
45+
deferc.mu.Unlock()
46+
c.actors[actor.Type]=actor
47+
}
48+
49+
varactorLogOrder= []rbac.SubjectType{
50+
rbac.SubjectTypeAutostart,
51+
rbac.SubjectTypeCryptoKeyReader,
52+
rbac.SubjectTypeCryptoKeyRotator,
53+
rbac.SubjectTypeJobReaper,
54+
rbac.SubjectTypeNotifier,
55+
rbac.SubjectTypePrebuildsOrchestrator,
56+
rbac.SubjectTypeSubAgentAPI,
57+
rbac.SubjectTypeProvisionerd,
58+
rbac.SubjectTypeResourceMonitor,
59+
rbac.SubjectTypeSystemReadProvisionerDaemons,
60+
rbac.SubjectTypeSystemRestricted,
61+
}
62+
63+
func (c*RbacSlogRequestLogger)addAuthContextFields() {
64+
c.mu.RLock()
65+
deferc.mu.RUnlock()
66+
67+
usr,ok:=c.actors[rbac.SubjectTypeUser]
68+
ifok {
69+
c.log=c.log.With(
70+
slog.F("requestor_id",usr.ID),
71+
slog.F("requestor_name",usr.FriendlyName),
72+
slog.F("requestor_email",usr.Email),
73+
)
74+
}else {
75+
// If there is no user, we log the requestor name for the first
76+
// actor in a defined order.
77+
for_,v:=rangeactorLogOrder {
78+
subj,ok:=c.actors[v]
79+
if!ok {
80+
continue
81+
}
82+
c.log=c.log.With(
83+
slog.F("requestor_name",subj.FriendlyName),
84+
)
85+
break
86+
}
87+
}
88+
}
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
//go:build slim
2+
3+
package loggermw
4+
5+
import (
6+
"context"
7+
"time"
8+
9+
"cdr.dev/slog"
10+
)
11+
12+
typeRequestLoggerinterface {
13+
WithFields(fields...slog.Field)
14+
WriteLog(ctx context.Context,statusint)
15+
}
16+
17+
var_RequestLogger=&SlogRequestLogger{}
18+
19+
funcNewRequestLogger(log slog.Logger,messagestring,start time.Time)RequestLogger {
20+
return&SlogRequestLogger{
21+
log:log,
22+
written:false,
23+
message:message,
24+
start:start,
25+
}
26+
}

‎enterprise/wsproxy/wsproxy.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ import (
3939
"github.com/coder/coder/v2/enterprise/derpmesh"
4040
"github.com/coder/coder/v2/enterprise/replicasync"
4141
"github.com/coder/coder/v2/enterprise/wsproxy/wsproxysdk"
42+
sharedhttpmw"github.com/coder/coder/v2/httpmw"
4243
"github.com/coder/coder/v2/site"
4344
"github.com/coder/coder/v2/tailnet"
4445
)
@@ -328,7 +329,7 @@ func New(ctx context.Context, opts *Options) (*Server, error) {
328329
// Persistent middlewares to all routes
329330
r.Use(
330331
// TODO: @emyrk Should we standardize these in some other package?
331-
httpmw.Recover(s.Logger),
332+
sharedhttpmw.Recover(s.Logger),
332333
httpmw.WithProfilingLabels,
333334
tracing.StatusWriterMiddleware,
334335
tracing.Middleware(s.TracerProvider),
File renamed without changes.

‎coderd/httpmw/recover_test.go‎renamed to ‎httpmw/recover_test.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ import (
77

88
"github.com/stretchr/testify/require"
99

10-
"github.com/coder/coder/v2/coderd/httpmw"
11-
"github.com/coder/coder/v2/coderd/tracing"
10+
"github.com/coder/coder/v2/httpmw"
1211
"github.com/coder/coder/v2/testutil"
12+
"github.com/coder/coder/v2/tracing"
1313
)
1414

1515
funcTestRecover(t*testing.T) {
@@ -58,7 +58,7 @@ func TestRecover(t *testing.T) {
5858
var (
5959
log=testutil.Logger(t)
6060
r=httptest.NewRequest("GET","/",nil)
61-
w=&tracing.StatusWriter{
61+
w=&loggermw.StatusWriter{
6262
ResponseWriter:httptest.NewRecorder(),
6363
Hijacked:c.Hijack,
6464
}

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp