|
| 1 | +package profiler |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "fmt" |
| 6 | + "os" |
| 7 | + "runtime" |
| 8 | + "strconv" |
| 9 | + "time" |
| 10 | + |
| 11 | + "log/slog" |
| 12 | + "math" |
| 13 | +) |
| 14 | + |
| 15 | +// Profile represents performance metrics for an operation |
| 16 | +type Profile struct { |
| 17 | + Operation string `json:"operation"` |
| 18 | + Duration time.Duration `json:"duration_ns"` |
| 19 | + MemoryBefore uint64 `json:"memory_before_bytes"` |
| 20 | + MemoryAfter uint64 `json:"memory_after_bytes"` |
| 21 | + MemoryDelta int64 `json:"memory_delta_bytes"` |
| 22 | + LinesCount int `json:"lines_count,omitempty"` |
| 23 | + BytesCount int64 `json:"bytes_count,omitempty"` |
| 24 | + Timestamp time.Time `json:"timestamp"` |
| 25 | +} |
| 26 | + |
| 27 | +// String returns a human-readable representation of the profile |
| 28 | +func (p *Profile) String() string { |
| 29 | + return fmt.Sprintf("[%s] %s: duration=%v, memory_delta=%+dB, lines=%d, bytes=%d", |
| 30 | + p.Timestamp.Format("15:04:05.000"), |
| 31 | + p.Operation, |
| 32 | + p.Duration, |
| 33 | + p.MemoryDelta, |
| 34 | + p.LinesCount, |
| 35 | + p.BytesCount, |
| 36 | + ) |
| 37 | +} |
| 38 | + |
| 39 | +func safeMemoryDelta(after, before uint64) int64 { |
| 40 | + if after > math.MaxInt64 || before > math.MaxInt64 { |
| 41 | + if after >= before { |
| 42 | + diff := after - before |
| 43 | + if diff > math.MaxInt64 { |
| 44 | + return math.MaxInt64 |
| 45 | + } |
| 46 | + return int64(diff) |
| 47 | + } |
| 48 | + diff := before - after |
| 49 | + if diff > math.MaxInt64 { |
| 50 | + return -math.MaxInt64 |
| 51 | + } |
| 52 | + return -int64(diff) |
| 53 | + } |
| 54 | + |
| 55 | + return int64(after) - int64(before) |
| 56 | +} |
| 57 | + |
| 58 | +// Profiler provides minimal performance profiling capabilities |
| 59 | +type Profiler struct { |
| 60 | + logger *slog.Logger |
| 61 | + enabled bool |
| 62 | +} |
| 63 | + |
| 64 | +// New creates a new Profiler instance |
| 65 | +func New(logger *slog.Logger, enabled bool) *Profiler { |
| 66 | + return &Profiler{ |
| 67 | + logger: logger, |
| 68 | + enabled: enabled, |
| 69 | + } |
| 70 | +} |
| 71 | + |
| 72 | +// ProfileFunc profiles a function execution |
| 73 | +func (p *Profiler) ProfileFunc(ctx context.Context, operation string, fn func() error) (*Profile, error) { |
| 74 | + if !p.enabled { |
| 75 | + return nil, fn() |
| 76 | + } |
| 77 | + |
| 78 | + profile := &Profile{ |
| 79 | + Operation: operation, |
| 80 | + Timestamp: time.Now(), |
| 81 | + } |
| 82 | + |
| 83 | + var memBefore runtime.MemStats |
| 84 | + runtime.ReadMemStats(&memBefore) |
| 85 | + profile.MemoryBefore = memBefore.Alloc |
| 86 | + |
| 87 | + start := time.Now() |
| 88 | + err := fn() |
| 89 | + profile.Duration = time.Since(start) |
| 90 | + |
| 91 | + var memAfter runtime.MemStats |
| 92 | + runtime.ReadMemStats(&memAfter) |
| 93 | + profile.MemoryAfter = memAfter.Alloc |
| 94 | + profile.MemoryDelta = safeMemoryDelta(memAfter.Alloc, memBefore.Alloc) |
| 95 | + |
| 96 | + if p.logger != nil { |
| 97 | + p.logger.InfoContext(ctx, "Performance profile", "profile", profile.String()) |
| 98 | + } |
| 99 | + |
| 100 | + return profile, err |
| 101 | +} |
| 102 | + |
| 103 | +// ProfileFuncWithMetrics profiles a function execution and captures additional metrics |
| 104 | +func (p *Profiler) ProfileFuncWithMetrics(ctx context.Context, operation string, fn func() (int, int64, error)) (*Profile, error) { |
| 105 | + if !p.enabled { |
| 106 | + _, _, err := fn() |
| 107 | + return nil, err |
| 108 | + } |
| 109 | + |
| 110 | + profile := &Profile{ |
| 111 | + Operation: operation, |
| 112 | + Timestamp: time.Now(), |
| 113 | + } |
| 114 | + |
| 115 | + var memBefore runtime.MemStats |
| 116 | + runtime.ReadMemStats(&memBefore) |
| 117 | + profile.MemoryBefore = memBefore.Alloc |
| 118 | + |
| 119 | + start := time.Now() |
| 120 | + lines, bytes, err := fn() |
| 121 | + profile.Duration = time.Since(start) |
| 122 | + profile.LinesCount = lines |
| 123 | + profile.BytesCount = bytes |
| 124 | + |
| 125 | + var memAfter runtime.MemStats |
| 126 | + runtime.ReadMemStats(&memAfter) |
| 127 | + profile.MemoryAfter = memAfter.Alloc |
| 128 | + profile.MemoryDelta = safeMemoryDelta(memAfter.Alloc, memBefore.Alloc) |
| 129 | + |
| 130 | + if p.logger != nil { |
| 131 | + p.logger.InfoContext(ctx, "Performance profile", "profile", profile.String()) |
| 132 | + } |
| 133 | + |
| 134 | + return profile, err |
| 135 | +} |
| 136 | + |
| 137 | +// Start begins timing an operation and returns a function to complete the profiling |
| 138 | +func (p *Profiler) Start(ctx context.Context, operation string) func(lines int, bytes int64) *Profile { |
| 139 | + if !p.enabled { |
| 140 | + return func(int, int64) *Profile { return nil } |
| 141 | + } |
| 142 | + |
| 143 | + profile := &Profile{ |
| 144 | + Operation: operation, |
| 145 | + Timestamp: time.Now(), |
| 146 | + } |
| 147 | + |
| 148 | + var memBefore runtime.MemStats |
| 149 | + runtime.ReadMemStats(&memBefore) |
| 150 | + profile.MemoryBefore = memBefore.Alloc |
| 151 | + |
| 152 | + start := time.Now() |
| 153 | + |
| 154 | + return func(lines int, bytes int64) *Profile { |
| 155 | + profile.Duration = time.Since(start) |
| 156 | + profile.LinesCount = lines |
| 157 | + profile.BytesCount = bytes |
| 158 | + |
| 159 | + var memAfter runtime.MemStats |
| 160 | + runtime.ReadMemStats(&memAfter) |
| 161 | + profile.MemoryAfter = memAfter.Alloc |
| 162 | + profile.MemoryDelta = safeMemoryDelta(memAfter.Alloc, memBefore.Alloc) |
| 163 | + |
| 164 | + if p.logger != nil { |
| 165 | + p.logger.InfoContext(ctx, "Performance profile", "profile", profile.String()) |
| 166 | + } |
| 167 | + |
| 168 | + return profile |
| 169 | + } |
| 170 | +} |
| 171 | + |
| 172 | +var globalProfiler *Profiler |
| 173 | + |
| 174 | +// IsProfilingEnabled checks if profiling is enabled via environment variables |
| 175 | +func IsProfilingEnabled() bool { |
| 176 | + if enabled, err := strconv.ParseBool(os.Getenv("GITHUB_MCP_PROFILING_ENABLED")); err == nil { |
| 177 | + return enabled |
| 178 | + } |
| 179 | + return false |
| 180 | +} |
| 181 | + |
| 182 | +// Init initializes the global profiler |
| 183 | +func Init(logger *slog.Logger, enabled bool) { |
| 184 | + globalProfiler = New(logger, enabled) |
| 185 | +} |
| 186 | + |
| 187 | +// InitFromEnv initializes the global profiler using environment variables |
| 188 | +func InitFromEnv(logger *slog.Logger) { |
| 189 | + globalProfiler = New(logger, IsProfilingEnabled()) |
| 190 | +} |
| 191 | + |
| 192 | +// ProfileFunc profiles a function using the global profiler |
| 193 | +func ProfileFunc(ctx context.Context, operation string, fn func() error) (*Profile, error) { |
| 194 | + if globalProfiler == nil { |
| 195 | + return nil, fn() |
| 196 | + } |
| 197 | + return globalProfiler.ProfileFunc(ctx, operation, fn) |
| 198 | +} |
| 199 | + |
| 200 | +// ProfileFuncWithMetrics profiles a function with metrics using the global profiler |
| 201 | +func ProfileFuncWithMetrics(ctx context.Context, operation string, fn func() (int, int64, error)) (*Profile, error) { |
| 202 | + if globalProfiler == nil { |
| 203 | + _, _, err := fn() |
| 204 | + return nil, err |
| 205 | + } |
| 206 | + return globalProfiler.ProfileFuncWithMetrics(ctx, operation, fn) |
| 207 | +} |
| 208 | + |
| 209 | +// Start begins timing using the global profiler |
| 210 | +func Start(ctx context.Context, operation string) func(int, int64) *Profile { |
| 211 | + if globalProfiler == nil { |
| 212 | + return func(int, int64) *Profile { return nil } |
| 213 | + } |
| 214 | + return globalProfiler.Start(ctx, operation) |
| 215 | +} |
0 commit comments