middleware/pprof/README.md

# pprof

*pprof* publishes runtime profiling data at endpoints under /debug/pprof. You can visit
 `/debug/pprof`
on your site for an index of the available endpoints. By default it will listen on localhost:6053.

> This is a debugging tool. Certain requests (such as collecting execution traces) can be slow. If
> you use pprof on a live site, consider restricting access or enabling it only temporarily.

For more information, please see [Go's pprof
documentation](https://golang.org/pkg/net/http/pprof/s://golang.org/pkg/net/http/pprof/) and read
[Profiling Go Programs](https://blog.golang.org/profiling-go-programs).

There is not configuration.

## Syntax

~~~
pprof
~~~

## Examples

Enable pprof endpoints:

~~~
pprof
~~~
pprof middleware (#138) Add pprof middleware, enabled by pprof directive. 2016-04-28 10:26:58 +01:00			`# pprof`

docs: rewrite using manpage style (#327) This still needs cleanup, but this is a first pass the cleans some cruft and documents our style (in middleware.md) and makes all the docs match that style. 2016-10-10 20:13:22 +01:00			`pprof publishes runtime profiling data at endpoints under /debug/pprof. You can visit`
			`/debug/pprof`
Make middleware survive a restart (#142) Make middleware that sets up a (http) handler survive a graceful restart. We calls the middleware's Shutdown function(s). If restart fails the Start function is called again. * middleware/health: OK * middleware/pprof: OK * middleware/metrics: OK All restart OK. 2016-04-29 07:28:35 +01:00			`on your site for an index of the available endpoints. By default it will listen on localhost:6053.`
pprof middleware (#138) Add pprof middleware, enabled by pprof directive. 2016-04-28 10:26:58 +01:00
			`> This is a debugging tool. Certain requests (such as collecting execution traces) can be slow. If`
			`> you use pprof on a live site, consider restricting access or enabling it only temporarily.`

			`For more information, please see [Go's pprof`
			`documentation](https://golang.org/pkg/net/http/pprof/s://golang.org/pkg/net/http/pprof/) and read`
			`[Profiling Go Programs](https://blog.golang.org/profiling-go-programs).`

docs: rewrite using manpage style (#327) This still needs cleanup, but this is a first pass the cleans some cruft and documents our style (in middleware.md) and makes all the docs match that style. 2016-10-10 20:13:22 +01:00			`There is not configuration.`

pprof middleware (#138) Add pprof middleware, enabled by pprof directive. 2016-04-28 10:26:58 +01:00			`## Syntax`

			`~~~`
			`pprof`
			`~~~`

			`## Examples`

			`Enable pprof endpoints:`

			`~~~`
			`pprof`
			`~~~`