-
-
Notifications
You must be signed in to change notification settings - Fork 3.3k
feat(api): Allow tracing of requests and responses #7609
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
richiejp
wants to merge
2
commits into
mudler:master
Choose a base branch
from
richiejp:feat/tracing
base: master
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
2 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
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
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
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,156 @@ | ||
| package middleware | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "github.com/emirpasic/gods/v2/queues/circularbuffer" | ||
| "io" | ||
| "net/http" | ||
| "sort" | ||
| "sync" | ||
| "time" | ||
|
|
||
| "github.com/labstack/echo/v4" | ||
| "github.com/mudler/LocalAI/core/application" | ||
| "github.com/mudler/xlog" | ||
| ) | ||
|
|
||
| type APIExchangeRequest struct { | ||
| Method string `json:"method"` | ||
| Path string `json:"path"` | ||
| Headers *http.Header `json:"headers"` | ||
| Body *[]byte `json:"body"` | ||
| } | ||
|
|
||
| type APIExchangeResponse struct { | ||
| Status int `json:"status"` | ||
| Headers *http.Header `json:"headers"` | ||
| Body *[]byte `json:"body"` | ||
| } | ||
|
|
||
| type APIExchange struct { | ||
| Timestamp time.Time `json:"timestamp"` | ||
| Request APIExchangeRequest `json:"request"` | ||
| Response APIExchangeResponse `json:"response"` | ||
| } | ||
|
|
||
| var traceBuffer *circularbuffer.Queue[APIExchange] | ||
| var mu sync.Mutex | ||
| var logChan = make(chan APIExchange, 100) | ||
|
|
||
| type bodyWriter struct { | ||
| http.ResponseWriter | ||
| body *bytes.Buffer | ||
| } | ||
|
|
||
| func (w *bodyWriter) Write(b []byte) (int, error) { | ||
| w.body.Write(b) | ||
| return w.ResponseWriter.Write(b) | ||
| } | ||
|
|
||
| func (w *bodyWriter) Flush() { | ||
| if flusher, ok := w.ResponseWriter.(http.Flusher); ok { | ||
| flusher.Flush() | ||
| } | ||
| } | ||
|
|
||
| // TraceMiddleware intercepts and logs JSON API requests and responses | ||
| func TraceMiddleware(app *application.Application) echo.MiddlewareFunc { | ||
| if app.ApplicationConfig().EnableTracing && traceBuffer == nil { | ||
| traceBuffer = circularbuffer.New[APIExchange](app.ApplicationConfig().TracingMaxItems) | ||
|
|
||
| go func() { | ||
| for exchange := range logChan { | ||
| mu.Lock() | ||
| traceBuffer.Enqueue(exchange) | ||
| mu.Unlock() | ||
| } | ||
| }() | ||
| } | ||
|
|
||
| return func(next echo.HandlerFunc) echo.HandlerFunc { | ||
| return func(c echo.Context) error { | ||
| if !app.ApplicationConfig().EnableTracing { | ||
| return next(c) | ||
| } | ||
|
|
||
| if c.Request().Header.Get("Content-Type") != "application/json" { | ||
| return next(c) | ||
| } | ||
|
|
||
| body, err := io.ReadAll(c.Request().Body) | ||
| if err != nil { | ||
| xlog.Error("Failed to read request body") | ||
| return err | ||
| } | ||
|
|
||
| // Restore the body for downstream handlers | ||
| c.Request().Body = io.NopCloser(bytes.NewBuffer(body)) | ||
|
|
||
| startTime := time.Now() | ||
|
|
||
| // Wrap response writer to capture body | ||
| resBody := new(bytes.Buffer) | ||
| mw := &bodyWriter{ | ||
| ResponseWriter: c.Response().Writer, | ||
| body: resBody, | ||
| } | ||
| c.Response().Writer = mw | ||
|
|
||
| err = next(c) | ||
| if err != nil { | ||
| c.Response().Writer = mw.ResponseWriter // Restore original writer if error | ||
| return err | ||
| } | ||
|
|
||
| // Create exchange log | ||
| requestHeaders := c.Request().Header.Clone() | ||
| requestBody := make([]byte, len(body)) | ||
| copy(requestBody, body) | ||
| responseHeaders := c.Response().Header().Clone() | ||
| responseBody := make([]byte, resBody.Len()) | ||
| copy(responseBody, resBody.Bytes()) | ||
| exchange := APIExchange{ | ||
| Timestamp: startTime, | ||
| Request: APIExchangeRequest{ | ||
| Method: c.Request().Method, | ||
| Path: c.Path(), | ||
| Headers: &requestHeaders, | ||
| Body: &requestBody, | ||
| }, | ||
| Response: APIExchangeResponse{ | ||
| Status: c.Response().Status, | ||
| Headers: &responseHeaders, | ||
| Body: &responseBody, | ||
| }, | ||
| } | ||
|
|
||
| select { | ||
| case logChan <- exchange: | ||
| default: | ||
| xlog.Warn("Trace channel full, dropping trace") | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // GetTraces returns a copy of the logged API exchanges for display | ||
| func GetTraces() []APIExchange { | ||
| mu.Lock() | ||
| traces := traceBuffer.Values() | ||
| mu.Unlock() | ||
|
|
||
| sort.Slice(traces, func(i, j int) bool { | ||
| return traces[i].Timestamp.Before(traces[j].Timestamp) | ||
| }) | ||
|
|
||
| return traces | ||
| } | ||
|
|
||
| // ClearTraces clears the in-memory logs | ||
| func ClearTraces() { | ||
| mu.Lock() | ||
| traceBuffer.Clear() | ||
| mu.Unlock() | ||
| } |
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
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.
Should this be as well a runtime setting?