-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Add actions job log buffer and profiler #866
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
Merged
+493
−55
Merged
Changes from all commits
Commits
Show all changes
46 commits
Select commit
Hold shift + click to select a range
8a5efb9
add sliding window for actions logs
mattdholloway e6ef962
refactor: fix sliding
mattdholloway 271c7c2
remove trim content
mattdholloway e65c0f0
only use up to 1mb of memory for logs
mattdholloway ade3852
update to tail lines in second pass
mattdholloway 5a76cbd
add better memory usage calculation
mattdholloway 8e60fb2
increase window size to 5MB
mattdholloway e1c3143
update test
mattdholloway 75dc8e7
Merge branch 'main' into actions-job-log-buffer
mattdholloway b128e44
Merge branch 'actions-job-log-buffer' of https://github.com/github/gi…
mattdholloway 88d16d2
Merge branch 'main' into actions-job-log-buffer
mattdholloway 4bf84b2
Merge branch 'main' into actions-job-log-buffer
mattdholloway 6b8f2ba
update vers
mattdholloway 8002fbd
undo vers change
mattdholloway 52e531e
add incremental memory tracking
mattdholloway 8f85398
use ring buffer
mattdholloway 0d19480
remove unused ctx param
mattdholloway f104e67
remove manual GC clear
mattdholloway 9d273b9
fix cca feedback
mattdholloway 4e43327
extract ring buffer logic to new package
mattdholloway 2ff2d4f
handle log content processing errors and use correct param for maxjob…
mattdholloway c6f5f7f
fix tailing
mattdholloway 1c1061c
account for if tailLines exceeds window size
mattdholloway 75b8c94
add profiling thats reusable
mattdholloway 71bfac8
remove profiler testing
mattdholloway a43b03c
refactor profiler: introduce safeMemoryDelta for accurate memory delt…
mattdholloway d9c8825
linter fixes
mattdholloway ec070ee
Update pkg/buffer/buffer.go
mattdholloway 0434b7e
use flag for maxJobLogLines
mattdholloway fb301c6
add param passing for context window size
mattdholloway 106d802
refactor: rename contextWindowSize to contentWindowSize for consistency
mattdholloway 516c0f7
fix: use tailLines if bigger but only if <= 5000
mattdholloway 6c3c31a
fix: limit tailLines to a maximum of 500 for log content download
mattdholloway 82d4ce2
Update cmd/github-mcp-server/main.go
mattdholloway e40e289
Update cmd/github-mcp-server/main.go
mattdholloway 4310db8
move profiler to internal/
mattdholloway e0767fe
update actions test with new profiler location
mattdholloway 9677c07
fix: adjust buffer size limits
mattdholloway ed6bc2d
make line buffer 1028kb
mattdholloway 696e5fd
fix mod path
mattdholloway 10e1995
change test to use same buffer size as normal use
mattdholloway 2eb2e16
improve test for non-sliding window implementation to not count empty…
mattdholloway 47aaa01
make test memory measurement more accurate
mattdholloway 6b910ff
Merge branch 'main' into actions-job-log-buffer
mattdholloway 4a673c9
Merge branch 'main' into actions-job-log-buffer
mattdholloway 556a41c
remove impossible conditional
mattdholloway 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,215 @@ | ||
package profiler | ||
|
||
import ( | ||
"context" | ||
"fmt" | ||
"os" | ||
"runtime" | ||
"strconv" | ||
"time" | ||
|
||
"log/slog" | ||
"math" | ||
) | ||
|
||
// Profile represents performance metrics for an operation | ||
type Profile struct { | ||
Operation string `json:"operation"` | ||
Duration time.Duration `json:"duration_ns"` | ||
MemoryBefore uint64 `json:"memory_before_bytes"` | ||
MemoryAfter uint64 `json:"memory_after_bytes"` | ||
MemoryDelta int64 `json:"memory_delta_bytes"` | ||
LinesCount int `json:"lines_count,omitempty"` | ||
BytesCount int64 `json:"bytes_count,omitempty"` | ||
Timestamp time.Time `json:"timestamp"` | ||
} | ||
|
||
// String returns a human-readable representation of the profile | ||
func (p *Profile) String() string { | ||
return fmt.Sprintf("[%s] %s: duration=%v, memory_delta=%+dB, lines=%d, bytes=%d", | ||
p.Timestamp.Format("15:04:05.000"), | ||
p.Operation, | ||
p.Duration, | ||
p.MemoryDelta, | ||
p.LinesCount, | ||
p.BytesCount, | ||
) | ||
} | ||
|
||
func safeMemoryDelta(after, before uint64) int64 { | ||
if after > math.MaxInt64 || before > math.MaxInt64 { | ||
if after >= before { | ||
diff := after - before | ||
if diff > math.MaxInt64 { | ||
return math.MaxInt64 | ||
} | ||
return int64(diff) | ||
} | ||
diff := before - after | ||
if diff > math.MaxInt64 { | ||
return -math.MaxInt64 | ||
} | ||
return -int64(diff) | ||
} | ||
|
||
return int64(after) - int64(before) | ||
} | ||
|
||
// Profiler provides minimal performance profiling capabilities | ||
type Profiler struct { | ||
logger *slog.Logger | ||
enabled bool | ||
} | ||
|
||
// New creates a new Profiler instance | ||
func New(logger *slog.Logger, enabled bool) *Profiler { | ||
return &Profiler{ | ||
logger: logger, | ||
enabled: enabled, | ||
} | ||
} | ||
|
||
// ProfileFunc profiles a function execution | ||
func (p *Profiler) ProfileFunc(ctx context.Context, operation string, fn func() error) (*Profile, error) { | ||
if !p.enabled { | ||
return nil, fn() | ||
} | ||
|
||
profile := &Profile{ | ||
Operation: operation, | ||
Timestamp: time.Now(), | ||
} | ||
|
||
var memBefore runtime.MemStats | ||
runtime.ReadMemStats(&memBefore) | ||
profile.MemoryBefore = memBefore.Alloc | ||
|
||
start := time.Now() | ||
err := fn() | ||
profile.Duration = time.Since(start) | ||
|
||
var memAfter runtime.MemStats | ||
runtime.ReadMemStats(&memAfter) | ||
profile.MemoryAfter = memAfter.Alloc | ||
profile.MemoryDelta = safeMemoryDelta(memAfter.Alloc, memBefore.Alloc) | ||
|
||
if p.logger != nil { | ||
p.logger.InfoContext(ctx, "Performance profile", "profile", profile.String()) | ||
} | ||
|
||
return profile, err | ||
} | ||
|
||
// ProfileFuncWithMetrics profiles a function execution and captures additional metrics | ||
func (p *Profiler) ProfileFuncWithMetrics(ctx context.Context, operation string, fn func() (int, int64, error)) (*Profile, error) { | ||
if !p.enabled { | ||
_, _, err := fn() | ||
return nil, err | ||
} | ||
|
||
profile := &Profile{ | ||
Operation: operation, | ||
Timestamp: time.Now(), | ||
} | ||
|
||
var memBefore runtime.MemStats | ||
runtime.ReadMemStats(&memBefore) | ||
profile.MemoryBefore = memBefore.Alloc | ||
|
||
start := time.Now() | ||
lines, bytes, err := fn() | ||
profile.Duration = time.Since(start) | ||
profile.LinesCount = lines | ||
profile.BytesCount = bytes | ||
|
||
var memAfter runtime.MemStats | ||
runtime.ReadMemStats(&memAfter) | ||
profile.MemoryAfter = memAfter.Alloc | ||
profile.MemoryDelta = safeMemoryDelta(memAfter.Alloc, memBefore.Alloc) | ||
|
||
if p.logger != nil { | ||
p.logger.InfoContext(ctx, "Performance profile", "profile", profile.String()) | ||
} | ||
|
||
return profile, err | ||
} | ||
|
||
// Start begins timing an operation and returns a function to complete the profiling | ||
func (p *Profiler) Start(ctx context.Context, operation string) func(lines int, bytes int64) *Profile { | ||
if !p.enabled { | ||
return func(int, int64) *Profile { return nil } | ||
} | ||
|
||
profile := &Profile{ | ||
Operation: operation, | ||
Timestamp: time.Now(), | ||
} | ||
|
||
var memBefore runtime.MemStats | ||
runtime.ReadMemStats(&memBefore) | ||
profile.MemoryBefore = memBefore.Alloc | ||
|
||
start := time.Now() | ||
|
||
return func(lines int, bytes int64) *Profile { | ||
profile.Duration = time.Since(start) | ||
profile.LinesCount = lines | ||
profile.BytesCount = bytes | ||
|
||
var memAfter runtime.MemStats | ||
runtime.ReadMemStats(&memAfter) | ||
profile.MemoryAfter = memAfter.Alloc | ||
profile.MemoryDelta = safeMemoryDelta(memAfter.Alloc, memBefore.Alloc) | ||
|
||
if p.logger != nil { | ||
p.logger.InfoContext(ctx, "Performance profile", "profile", profile.String()) | ||
} | ||
|
||
return profile | ||
} | ||
} | ||
|
||
var globalProfiler *Profiler | ||
|
||
// IsProfilingEnabled checks if profiling is enabled via environment variables | ||
func IsProfilingEnabled() bool { | ||
if enabled, err := strconv.ParseBool(os.Getenv("GITHUB_MCP_PROFILING_ENABLED")); err == nil { | ||
return enabled | ||
} | ||
return false | ||
} | ||
|
||
// Init initializes the global profiler | ||
func Init(logger *slog.Logger, enabled bool) { | ||
globalProfiler = New(logger, enabled) | ||
} | ||
|
||
// InitFromEnv initializes the global profiler using environment variables | ||
func InitFromEnv(logger *slog.Logger) { | ||
globalProfiler = New(logger, IsProfilingEnabled()) | ||
} | ||
|
||
// ProfileFunc profiles a function using the global profiler | ||
func ProfileFunc(ctx context.Context, operation string, fn func() error) (*Profile, error) { | ||
if globalProfiler == nil { | ||
return nil, fn() | ||
} | ||
return globalProfiler.ProfileFunc(ctx, operation, fn) | ||
} | ||
|
||
// ProfileFuncWithMetrics profiles a function with metrics using the global profiler | ||
func ProfileFuncWithMetrics(ctx context.Context, operation string, fn func() (int, int64, error)) (*Profile, error) { | ||
if globalProfiler == nil { | ||
_, _, err := fn() | ||
return nil, err | ||
} | ||
return globalProfiler.ProfileFuncWithMetrics(ctx, operation, fn) | ||
} | ||
|
||
// Start begins timing using the global profiler | ||
func Start(ctx context.Context, operation string) func(int, int64) *Profile { | ||
if globalProfiler == nil { | ||
return func(int, int64) *Profile { return nil } | ||
} | ||
return globalProfiler.Start(ctx, operation) | ||
} |
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,69 @@ | ||
package buffer | ||
|
||
import ( | ||
"bufio" | ||
"fmt" | ||
"net/http" | ||
"strings" | ||
) | ||
|
||
mattdholloway marked this conversation as resolved.
Show resolved
Hide resolved
|
||
// ProcessResponseAsRingBufferToEnd reads the body of an HTTP response line by line, | ||
// storing only the last maxJobLogLines lines using a ring buffer (sliding window). | ||
// This efficiently retains the most recent lines, overwriting older ones as needed. | ||
// | ||
// Parameters: | ||
// | ||
// httpResp: The HTTP response whose body will be read. | ||
// maxJobLogLines: The maximum number of log lines to retain. | ||
// | ||
// Returns: | ||
// | ||
// string: The concatenated log lines (up to maxJobLogLines), separated by newlines. | ||
// int: The total number of lines read from the response. | ||
// *http.Response: The original HTTP response. | ||
// error: Any error encountered during reading. | ||
// | ||
// The function uses a ring buffer to efficiently store only the last maxJobLogLines lines. | ||
// If the response contains more lines than maxJobLogLines, only the most recent lines are kept. | ||
func ProcessResponseAsRingBufferToEnd(httpResp *http.Response, maxJobLogLines int) (string, int, *http.Response, error) { | ||
lines := make([]string, maxJobLogLines) | ||
validLines := make([]bool, maxJobLogLines) | ||
totalLines := 0 | ||
writeIndex := 0 | ||
|
||
scanner := bufio.NewScanner(httpResp.Body) | ||
scanner.Buffer(make([]byte, 0, 64*1024), 1024*1024) | ||
mattdholloway marked this conversation as resolved.
Show resolved
Hide resolved
mattdholloway marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
for scanner.Scan() { | ||
line := scanner.Text() | ||
totalLines++ | ||
|
||
lines[writeIndex] = line | ||
validLines[writeIndex] = true | ||
writeIndex = (writeIndex + 1) % maxJobLogLines | ||
} | ||
|
||
if err := scanner.Err(); err != nil { | ||
return "", 0, httpResp, fmt.Errorf("failed to read log content: %w", err) | ||
} | ||
|
||
var result []string | ||
linesInBuffer := totalLines | ||
if linesInBuffer > maxJobLogLines { | ||
linesInBuffer = maxJobLogLines | ||
} | ||
|
||
startIndex := 0 | ||
if totalLines > maxJobLogLines { | ||
startIndex = writeIndex | ||
} | ||
|
||
for i := 0; i < linesInBuffer; i++ { | ||
idx := (startIndex + i) % maxJobLogLines | ||
if validLines[idx] { | ||
result = append(result, lines[idx]) | ||
} | ||
} | ||
|
||
return strings.Join(result, "\n"), totalLines, httpResp, nil | ||
} |
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.
This condition checks if either value exceeds MaxInt64, but since these are uint64 values, they can legitimately be larger than MaxInt64. The logic should handle the conversion more clearly by checking if the difference itself would overflow int64 bounds.
Copilot uses AI. Check for mistakes.