-
Notifications
You must be signed in to change notification settings - Fork 64
[wip] adding more mo telemetry events #247
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Sayan-
wants to merge
3
commits into
main
Choose a base branch
from
sayan/kernel-1301-add-more-events
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| package api | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "net/http" | ||
| "sync/atomic" | ||
| "time" | ||
|
|
||
| chiMiddleware "github.com/go-chi/chi/v5/middleware" | ||
|
|
||
| "github.com/kernel/kernel-images/server/lib/events" | ||
| oapi "github.com/kernel/kernel-images/server/lib/oapi" | ||
| ) | ||
|
|
||
| // Per-request scratch shared between the chi-level HTTP middleware and the | ||
| // strict-server middleware so the latter can stamp the matched operationId. | ||
| type telemetryCtxKey struct{} | ||
|
|
||
| type telemetryRequestCtx struct { | ||
| operationID string | ||
| } | ||
|
|
||
| // Process-wide toggle for the api_call middleware. Flipped by | ||
| // Enable/DisableTelemetryMiddleware; both middleware layers short-circuit | ||
| // to passthroughs when false. | ||
| var telemetryMiddlewareEnabled atomic.Bool | ||
|
|
||
| // EnableTelemetryMiddleware turns on api_call event emission. | ||
| func EnableTelemetryMiddleware() { telemetryMiddlewareEnabled.Store(true) } | ||
|
|
||
| // DisableTelemetryMiddleware turns api_call event emission off. | ||
| func DisableTelemetryMiddleware() { telemetryMiddlewareEnabled.Store(false) } | ||
|
|
||
| // TelemetryMiddlewareEnabled reports the current state. | ||
| func TelemetryMiddlewareEnabled() bool { return telemetryMiddlewareEnabled.Load() } | ||
|
|
||
| // TelemetryHTTPMiddleware emits a BrowserApiCallEvent per documented operation, | ||
| // capturing the final status and wall-clock duration. | ||
| func TelemetryHTTPMiddleware(publish func(events.Event)) func(http.Handler) http.Handler { | ||
| return func(next http.Handler) http.Handler { | ||
| return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| if !telemetryMiddlewareEnabled.Load() { | ||
| next.ServeHTTP(w, r) | ||
| return | ||
| } | ||
| tc := &telemetryRequestCtx{} | ||
| ctx := context.WithValue(r.Context(), telemetryCtxKey{}, tc) | ||
| ww := chiMiddleware.NewWrapResponseWriter(w, r.ProtoMajor) | ||
| start := time.Now() | ||
|
|
||
| next.ServeHTTP(ww, r.WithContext(ctx)) | ||
|
|
||
| if tc.operationID == "" { | ||
| return | ||
| } | ||
| data, err := json.Marshal(map[string]any{ | ||
| "request_id": chiMiddleware.GetReqID(ctx), | ||
| "operation_id": tc.operationID, | ||
| "status": ww.Status(), | ||
| "duration_ms": float64(time.Since(start).Microseconds()) / 1000.0, | ||
| }) | ||
| if err != nil { | ||
| return | ||
| } | ||
| publish(events.Event{ | ||
| Ts: time.Now().UnixMicro(), | ||
| Type: "api_call", | ||
| Category: events.Api, | ||
| Source: oapi.BrowserEventSource{Kind: oapi.KernelApi}, | ||
| Data: data, | ||
| }) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| // TelemetryStrictMiddleware records the matched OpenAPI operationId onto the | ||
| // per-request scratch so TelemetryHTTPMiddleware can include it in the event. | ||
| func TelemetryStrictMiddleware() oapi.StrictMiddlewareFunc { | ||
| return func(next oapi.StrictHandlerFunc, operationID string) oapi.StrictHandlerFunc { | ||
| return func(ctx context.Context, w http.ResponseWriter, r *http.Request, request any) (any, error) { | ||
| if !telemetryMiddlewareEnabled.Load() { | ||
| return next(ctx, w, r, request) | ||
| } | ||
| if tc, ok := ctx.Value(telemetryCtxKey{}).(*telemetryRequestCtx); ok { | ||
| tc.operationID = operationID | ||
| } | ||
| return next(ctx, w, r, request) | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| package api | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "sync" | ||
| "testing" | ||
|
|
||
| chiMiddleware "github.com/go-chi/chi/v5/middleware" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/kernel/kernel-images/server/lib/events" | ||
| oapi "github.com/kernel/kernel-images/server/lib/oapi" | ||
| ) | ||
|
|
||
| // recordingPublisher captures published events for assertion. | ||
| type recordingPublisher struct { | ||
| mu sync.Mutex | ||
| events []events.Event | ||
| } | ||
|
|
||
| func (rp *recordingPublisher) publish(ev events.Event) { | ||
| rp.mu.Lock() | ||
| defer rp.mu.Unlock() | ||
| rp.events = append(rp.events, ev) | ||
| } | ||
|
|
||
| func (rp *recordingPublisher) snapshot() []events.Event { | ||
| rp.mu.Lock() | ||
| defer rp.mu.Unlock() | ||
| out := make([]events.Event, len(rp.events)) | ||
| copy(out, rp.events) | ||
| return out | ||
| } | ||
|
|
||
| // Mirrors the oapi-codegen strict dispatcher: middleware chain -> inner | ||
| // handler -> response write. | ||
| func fakeStrictHandler(operationID string, status int, mws []oapi.StrictMiddlewareFunc) http.Handler { | ||
| inner := oapi.StrictHandlerFunc(func(ctx context.Context, w http.ResponseWriter, r *http.Request, request any) (any, error) { | ||
| return nil, nil | ||
| }) | ||
| for _, mw := range mws { | ||
| inner = mw(inner, operationID) | ||
| } | ||
| return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| _, _ = inner(r.Context(), w, r, nil) | ||
| w.WriteHeader(status) | ||
| }) | ||
| } | ||
|
|
||
| // Flips the package-level toggle on for the test, restoring prior state | ||
| // via t.Cleanup. | ||
| func withTelemetryMiddlewareEnabled(t *testing.T) { | ||
| t.Helper() | ||
| prev := TelemetryMiddlewareEnabled() | ||
| EnableTelemetryMiddleware() | ||
| t.Cleanup(func() { | ||
| if prev { | ||
| EnableTelemetryMiddleware() | ||
| } else { | ||
| DisableTelemetryMiddleware() | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| func TestTelemetryMiddleware_EmitsApiCallEventOnDocumentedRoute(t *testing.T) { | ||
| withTelemetryMiddlewareEnabled(t) | ||
| rp := &recordingPublisher{} | ||
| chain := chiHandler(t, rp.publish, "ProcessExec", http.StatusOK) | ||
|
|
||
| req := httptest.NewRequest(http.MethodPost, "/process/exec", nil) | ||
| rec := httptest.NewRecorder() | ||
| chain.ServeHTTP(rec, req) | ||
|
|
||
| captured := rp.snapshot() | ||
| require.Len(t, captured, 1) | ||
| ev := captured[0] | ||
| assert.Equal(t, "api_call", ev.Type) | ||
| assert.Equal(t, events.Api, ev.Category) | ||
| assert.Equal(t, oapi.KernelApi, ev.Source.Kind) | ||
|
|
||
| var data struct { | ||
| RequestID string `json:"request_id"` | ||
| OperationID string `json:"operation_id"` | ||
| Status int `json:"status"` | ||
| DurationMs float64 `json:"duration_ms"` | ||
| } | ||
| require.NoError(t, json.Unmarshal(ev.Data, &data)) | ||
| assert.NotEmpty(t, data.RequestID, "request_id should be set by chi RequestID middleware") | ||
| assert.Equal(t, "ProcessExec", data.OperationID) | ||
| assert.Equal(t, http.StatusOK, data.Status) | ||
| assert.GreaterOrEqual(t, data.DurationMs, 0.0) | ||
| } | ||
|
|
||
| func TestTelemetryMiddleware_CapturesNonOKStatus(t *testing.T) { | ||
| withTelemetryMiddlewareEnabled(t) | ||
| rp := &recordingPublisher{} | ||
| chain := chiHandler(t, rp.publish, "ProcessExec", http.StatusInternalServerError) | ||
|
|
||
| req := httptest.NewRequest(http.MethodPost, "/process/exec", nil) | ||
| rec := httptest.NewRecorder() | ||
| chain.ServeHTTP(rec, req) | ||
|
|
||
| captured := rp.snapshot() | ||
| require.Len(t, captured, 1) | ||
| var data struct { | ||
| Status int `json:"status"` | ||
| } | ||
| require.NoError(t, json.Unmarshal(captured[0].Data, &data)) | ||
| assert.Equal(t, http.StatusInternalServerError, data.Status) | ||
| } | ||
|
|
||
| func TestTelemetryMiddleware_SkipsUndocumentedRoutes(t *testing.T) { | ||
| withTelemetryMiddlewareEnabled(t) | ||
| rp := &recordingPublisher{} | ||
| mw := TelemetryHTTPMiddleware(rp.publish) | ||
| plain := mw(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| })) | ||
|
|
||
| req := httptest.NewRequest(http.MethodGet, "/health", nil) | ||
| chiMiddleware.RequestID(plain).ServeHTTP(httptest.NewRecorder(), req) | ||
|
|
||
| assert.Empty(t, rp.snapshot(), "no event should be emitted when operationId is unset") | ||
| } | ||
|
|
||
| func TestTelemetryMiddleware_ShortCircuitsWhenDisabled(t *testing.T) { | ||
| DisableTelemetryMiddleware() | ||
| rp := &recordingPublisher{} | ||
| chain := chiHandler(t, rp.publish, "ProcessExec", http.StatusOK) | ||
|
|
||
| req := httptest.NewRequest(http.MethodPost, "/process/exec", nil) | ||
| rec := httptest.NewRecorder() | ||
| chain.ServeHTTP(rec, req) | ||
|
|
||
| assert.Empty(t, rp.snapshot(), "disabled middleware must not emit") | ||
| } | ||
|
|
||
| // Builds the same middleware stack as main.go: RequestID -> HTTP middleware -> | ||
| // strict dispatch -> inner handler. | ||
| func chiHandler(t *testing.T, publish func(events.Event), operationID string, status int) http.Handler { | ||
| t.Helper() | ||
| inner := fakeStrictHandler(operationID, status, []oapi.StrictMiddlewareFunc{TelemetryStrictMiddleware()}) | ||
| telemetry := TelemetryHTTPMiddleware(publish)(inner) | ||
| return chiMiddleware.RequestID(telemetry) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ad-hoc map literals instead of generated oapi types
Medium Severity
Event data payloads in
TelemetryHTTPMiddlewareandpublishCdpDisconnectare constructed usingmap[string]anyliterals instead of the generatedoapi.BrowserApiCallEventDataandoapi.BrowserCdpDisconnectEventDatatypes. The existing cdpmonitor producers already use generated types (e.g.,oapi.BrowserConsoleLogEventData). Using ad-hoc maps bypasses compile-time checking and risks drift between the documented API contract and actual event shapes — for instance, the generatedDurationMsfield isfloat32but the map usesfloat64, andMessageCountisintin the schema butint64in the map.Additional Locations (1)
server/lib/devtoolsproxy/proxy.go#L449-L454Triggered by learned rule: Producer repo must own typed event schemas in OpenAPI and use generated oapi types
Reviewed by Cursor Bugbot for commit 0e22845. Configure here.