/
p.go
408 lines (373 loc) · 10.2 KB
/
p.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
/*
* Copyright © 2021 Hedzr Yeh.
*/
package pprof
import (
"os"
"path/filepath"
"runtime"
"runtime/pprof"
traceR "runtime/trace"
"github.com/hedzr/log"
"github.com/hedzr/log/trace"
)
// ProfType represents the profile type
type ProfType int
const (
// CPUProf represents cpu profiling
CPUProf ProfType = 1
// MemProf represents memory profiling
MemProf ProfType = 2
// MutexProf represents mutex profiling
MutexProf ProfType = 4
// BlockProf represents block profiling
BlockProf ProfType = 8
// ThreadCreateProf represents thread creation profiling
ThreadCreateProf ProfType = 16
// TraceProf represents trace profiling
TraceProf ProfType = 32
// GoRoutineProf represents go-routine profiling
GoRoutineProf ProfType = 64
)
// DefaultMemProfileRate is the default memory profiling rate.
// See also http://golang.org/pkg/runtime/#pkg-variables
const DefaultMemProfileRate = 4096
// profile represents the profiling options holder
type profile struct {
path string
types []ProfType
cpuProfName string
memProfName string
mutexProfName string
blockProfName string
threadCreateProfName string
traceProfName string
goRoutineProfName string
memProfileRate int
// memProfileType holds the profile type for memory
// profiles. Allowed values are `heap` and `allocs`.
memProfileType string
}
// var cpuProfile, memProfile string
// EnableCPUProfile enables cpu profiling.
// And review the pprof result in a web ui:
//
// go tool pprof -http=:8555 ./cpu.pprof
//
// Now you can open 'http://localhost:8555/ui' in a browser
//
func EnableCPUProfile(cpuProfilePath string) (closer func()) {
closer = func() {}
if cpuProfilePath != "" {
f, err := os.Create(cpuProfilePath)
if err != nil {
log.Fatal("could not create cpu profile: %v", err)
}
err = pprof.StartCPUProfile(f)
if err != nil {
log.Fatal("error: %v", err)
}
closer = pprof.StopCPUProfile
}
runtime.SetBlockProfileRate(20)
return
}
// EnableMemProfile enables memory profiling.
// And review the pprof result in a web ui:
//
// go tool pprof -http=:8555 ./mem.pprof
//
// Now you can open 'http://localhost:8555/ui' in a browser
//
func EnableMemProfile(memProfilePath string) (closer func()) {
closer = func() {}
if memProfilePath != "" {
closer = func() {
f, err := os.Create(memProfilePath)
if err != nil {
log.Fatal("could not create memory profile: ", err)
}
defer f.Close()
runtime.GC() // get up-to-date statistics
if err := pprof.WriteHeapProfile(f); err != nil {
log.Fatal("could not write memory profile: ", err)
}
}
}
return
}
func (s *profile) enableCPUProfile(profilePath string) (closer func()) {
closer = func() {}
if profilePath != "" {
fn := filepath.Join(s.path, profilePath)
f, err := os.Create(fn)
if err != nil {
log.Fatalf("profile: could not create cou profile %q: %v", fn, err)
}
err = pprof.StartCPUProfile(f)
if err != nil {
return
}
log.Debugf("profile: cpu profiling enabled, %s", fn)
closer = func() {
pprof.StopCPUProfile()
_ = f.Close()
log.Debugf("profile: cpu profiling disabled, %s", fn)
}
}
return
}
func (s *profile) enableMemProfile(profilePath string) (closer func()) {
closer = func() {}
if profilePath != "" {
fn := filepath.Join(s.path, profilePath)
f, err := os.Create(fn)
if err != nil {
log.Fatalf("profile: could not create memory profile %q: %v", fn, err)
}
old := runtime.MemProfileRate
runtime.MemProfileRate = s.memProfileRate
if err != nil {
return
}
log.Debugf("profile: memory profiling enabled (rate %d), %s", runtime.MemProfileRate, fn)
closer = func() {
_ = pprof.Lookup(s.memProfileType).WriteTo(f, 0)
_ = f.Close()
runtime.MemProfileRate = old
log.Debugf("profile: memory profiling disabled, %s", fn)
}
}
return
}
func (s *profile) enableMutexProfile(profilePath string) (closer func()) {
closer = func() {}
if profilePath != "" {
fn := filepath.Join(s.path, profilePath)
f, err := os.Create(fn)
if err != nil {
log.Fatalf("profile: could not create mutex profile %q: %v", fn, err)
}
runtime.SetMutexProfileFraction(1)
log.Debugf("profile: mutex profiling enabled, %s", fn)
closer = func() {
if mp := pprof.Lookup("mutex"); mp != nil {
_ = mp.WriteTo(f, 0)
}
_ = f.Close()
runtime.SetMutexProfileFraction(0)
log.Debugf("profile: mutex profiling disabled, %s", fn)
}
}
return
}
func (s *profile) enableBlockProfile(profilePath string) (closer func()) {
closer = func() {}
if profilePath != "" {
fn := filepath.Join(s.path, profilePath)
f, err := os.Create(fn)
if err != nil {
log.Fatalf("profile: could not create block profile %q: %v", fn, err)
}
runtime.SetBlockProfileRate(1)
log.Debugf("profile: block profiling enabled, %s", fn)
closer = func() {
_ = pprof.Lookup("block").WriteTo(f, 0)
_ = f.Close()
runtime.SetBlockProfileRate(0)
log.Debugf("profile: block profiling disabled, %s", fn)
}
}
return
}
func (s *profile) enableThreadCreateProfile(profilePath string) (closer func()) {
closer = func() {}
if profilePath != "" {
fn := filepath.Join(s.path, profilePath)
f, err := os.Create(fn)
if err != nil {
log.Fatalf("profile: could not create thread creation profile %q: %v", fn, err)
}
runtime.SetBlockProfileRate(1)
log.Debugf("profile: thread creation profiling enabled, %s", fn)
closer = func() {
if mp := pprof.Lookup("threadcreate"); mp != nil {
_ = mp.WriteTo(f, 0)
}
_ = f.Close()
log.Debugf("profile: thread creation profiling disabled, %s", fn)
}
}
return
}
func (s *profile) enableTraceProfile(profilePath string) (closer func()) {
closer = func() {}
if profilePath != "" {
fn := filepath.Join(s.path, profilePath)
f, err := os.Create(fn)
if err != nil {
log.Fatalf("profile: could not create trace profile %q: %v", fn, err)
}
if err := trace.Start(); err != nil {
log.Fatalf("profile: could not start trace: %v", err)
}
if err := traceR.Start(f); err != nil {
log.Fatalf("profile: could not start trace: %v", err)
}
log.Debugf("profile: trace profiling enabled, %s", fn)
closer = func() {
trace.Stop()
traceR.Stop()
log.Debugf("profile: trace profiling disabled, %s", fn)
}
}
return
}
func (s *profile) enableGoRoutineProfile(profilePath string) (closer func()) {
closer = func() {}
if profilePath != "" {
fn := filepath.Join(s.path, profilePath)
f, err := os.Create(fn)
if err != nil {
log.Fatalf("profile: could not create goroutine profile %q: %v", fn, err)
}
log.Debugf("profile: goroutine profiling enabled, %s", fn)
closer = func() {
if mp := pprof.Lookup("goroutine"); mp != nil {
_ = mp.WriteTo(f, 0)
}
_ = f.Close()
log.Debugf("profile: goroutine profiling disabled, %s", fn)
}
}
return
}
// ProfOpt provides a wrapped functional options type for Start(...)
type ProfOpt func(*profile)
// Start constructs any profiling sessions from `types`.
// `types` is a OR-combined ProfType value, it looks like CPUProf | MemProf.
//
func Start(types ProfType, opts ...ProfOpt) (stop func()) {
p := &profile{
path: ".",
cpuProfName: "cpu.prof",
memProfName: "mem.prof",
mutexProfName: "mutex.prof",
blockProfName: "block.prof",
threadCreateProfName: "thread-create.prof",
traceProfName: "trace.out",
goRoutineProfName: "go-routine.prof",
memProfileRate: DefaultMemProfileRate,
memProfileType: "heap",
}
for _, opt := range opts {
opt(p)
}
var closers []func()
for _, t := range p.types {
types |= t
}
if types&CPUProf == CPUProf {
c := p.enableCPUProfile(p.cpuProfName)
closers = append(closers, c)
}
if types&MemProf == MemProf {
c := p.enableMemProfile(p.memProfName)
closers = append(closers, c)
}
if types&MutexProf == MutexProf {
c := p.enableMutexProfile(p.mutexProfName)
closers = append(closers, c)
}
if types&BlockProf == BlockProf {
c := p.enableBlockProfile(p.blockProfName)
closers = append(closers, c)
}
if types&ThreadCreateProf == ThreadCreateProf {
c := p.enableThreadCreateProfile(p.threadCreateProfName)
closers = append(closers, c)
}
if types&TraceProf == TraceProf {
c := p.enableTraceProfile(p.traceProfName)
closers = append(closers, c)
}
if types&GoRoutineProf == GoRoutineProf {
c := p.enableGoRoutineProfile(p.goRoutineProfName)
closers = append(closers, c)
}
stop = func() {
for _, c := range closers {
c()
}
}
return
}
// WithTypes allows a list of ProfType specified. For Example:
//
// Start(0, WithTypes(CPUProf, MemProf, BlockProf))
//
func WithTypes(types ...ProfType) ProfOpt {
return func(profile *profile) {
profile.types = append(profile.types, types...)
}
}
// WithOutputDirectory specify a directory for writing profiles. Default is '.'.
func WithOutputDirectory(path string) ProfOpt {
return func(profile *profile) {
profile.path = path
}
}
// WithCPUProfName ..
func WithCPUProfName(filename string) ProfOpt {
return func(profile *profile) {
profile.cpuProfName = filename
}
}
// WithMemProfName ..
func WithMemProfName(filename string) ProfOpt {
return func(profile *profile) {
profile.memProfName = filename
}
}
// WithMutexProfName ..
func WithMutexProfName(filename string) ProfOpt {
return func(profile *profile) {
profile.mutexProfName = filename
}
}
// WithBlockProfName ..
func WithBlockProfName(filename string) ProfOpt {
return func(profile *profile) {
profile.blockProfName = filename
}
}
// WithThreadCreateProfName ..
func WithThreadCreateProfName(filename string) ProfOpt {
return func(profile *profile) {
profile.threadCreateProfName = filename
}
}
// WithTraceProfName ..
func WithTraceProfName(filename string) ProfOpt {
return func(profile *profile) {
profile.traceProfName = filename
}
}
// WithGoRoutineProfName ..
func WithGoRoutineProfName(filename string) ProfOpt {
return func(profile *profile) {
profile.goRoutineProfName = filename
}
}
// WithMemProfileType specify the typename of memory profiling, "heap" or "allocs"
func WithMemProfileType(typ string) ProfOpt {
return func(profile *profile) {
profile.memProfileType = typ
}
}
// WithMemProfileRate enables memory profiling with a special rate
func WithMemProfileRate(rate int) ProfOpt {
return func(profile *profile) {
profile.memProfileRate = rate
}
}