forked from caicloud/nirvana
-
Notifications
You must be signed in to change notification settings - Fork 0
/
profiling.go
218 lines (194 loc) · 5.09 KB
/
profiling.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
/*
Copyright 2017 Caicloud Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package profiling
import (
"html/template"
"log"
"net/http"
"net/http/pprof"
"runtime"
rpprof "runtime/pprof"
"github.com/caicloud/nirvana"
"github.com/caicloud/nirvana/definition"
"github.com/caicloud/nirvana/service"
)
func init() {
nirvana.RegisterConfigInstaller(&profilingInstaller{})
}
// ExternalConfigName is the external config name of profiling.
const ExternalConfigName = "profiling"
// config is profiling config.
type config struct {
path string
contention bool
}
type profilingInstaller struct{}
// Name is the external config name.
func (i *profilingInstaller) Name() string {
return ExternalConfigName
}
// Install installs config to builder.
func (i *profilingInstaller) Install(builder service.Builder, cfg *nirvana.Config) error {
var err error
wrapper(cfg, func(c *config) {
if err = builder.AddDescriptor(descriptor(c.path)); err != nil {
return
}
if c.contention {
runtime.SetBlockProfileRate(1)
}
})
return err
}
// Uninstall uninstalls stuffs after server terminating.
func (i *profilingInstaller) Uninstall(builder service.Builder, cfg *nirvana.Config) error {
return nil
}
// Disable returns a configurer to disable profiling.
func Disable() nirvana.Configurer {
return func(c *nirvana.Config) error {
c.Set(ExternalConfigName, nil)
return nil
}
}
func wrapper(c *nirvana.Config, f func(c *config)) {
conf := c.Config(ExternalConfigName)
var cfg *config
if conf == nil {
// Default config.
cfg = &config{
path: "/debug/pprof/",
}
} else {
// Panic if config type is wrong.
cfg = conf.(*config)
}
f(cfg)
c.Set(ExternalConfigName, cfg)
}
// Path returns a configurer to set metrics path.
// Default path is /debug/pprof.
// Then these path is used:
// /debug/pprof/profile
// /debug/pprof/symbol
// /debug/pprof/trace
func Path(path string) nirvana.Configurer {
if path == "" {
path = "/debug/pprof/"
}
return func(c *nirvana.Config) error {
wrapper(c, func(c *config) {
c.path = path
})
return nil
}
}
// Contention returns a configurer to enable or
// disable contention profiling.
// Defaults to false.
func Contention(enable bool) nirvana.Configurer {
return func(c *nirvana.Config) error {
wrapper(c, func(c *config) {
c.contention = enable
})
return nil
}
}
// descriptor creates descriptor for profiling.
func descriptor(path string) definition.Descriptor {
return definition.Descriptor{
Path: path,
Consumes: []string{definition.MIMEAll},
Produces: []string{definition.MIMEAll},
Definitions: []definition.Definition{{
Method: definition.Get,
Function: service.WrapHTTPHandlerFunc(index),
}},
Children: []definition.Descriptor{
{
Path: "/profile",
Definitions: []definition.Definition{{
Method: definition.Get,
Function: service.WrapHTTPHandlerFunc(pprof.Profile),
}},
},
{
Path: "/symbol",
Definitions: []definition.Definition{{
Method: definition.Get,
Function: service.WrapHTTPHandlerFunc(pprof.Symbol),
}},
},
{
Path: "/trace",
Definitions: []definition.Definition{{
Method: definition.Get,
Function: service.WrapHTTPHandlerFunc(pprof.Trace),
}},
},
},
}
}
func index(w http.ResponseWriter, r *http.Request) {
profiles := rpprof.Profiles()
if err := indexTmpl.Execute(w, profiles); err != nil {
log.Print(err)
}
}
// indexTmpl is modified from http/pprof/pprof.go, adding 'pprof/' prefix for all href content
// go pprof http index page served the path '/debug/pprof/' which will be redirected to '/debug/pprof'
// by nirvana
var indexTmpl = template.Must(template.New("index").Parse(`<html>
<head>
<title>Profiling</title>
</head>
<body>
Profiling<br>
<br>
profiles:<br>
<table>
{{range .}}
<tr><td align=right>{{.Count}}<td><a href="./{{.Name}}?debug=1">{{.Name}}</a>
{{end}}
</table>
<br>
<a href=",/goroutine?debug=2">full goroutine stack dump</a><br>
</body>
</html>
`))
// Option contains basic configurations of profiling.
type Option struct {
// Contention enables contention profiling.
Contention bool `desc:"Enable contention profiling"`
// Path is profiling path.
Path string `desc:"Profiling path"`
}
// NewDefaultOption creates default option.
func NewDefaultOption() *Option {
return &Option{
Contention: false,
Path: "/debug/pprof/",
}
}
// Name returns plugin name.
func (p *Option) Name() string {
return ExternalConfigName
}
// Configure configures nirvana config via current options.
func (p *Option) Configure(cfg *nirvana.Config) error {
cfg.Configure(
Contention(p.Contention),
Path(p.Path),
)
return nil
}