PPROF
Enable pprof UI
Install#
../../img/user go get github.com/rookie-ninja/rk-boot/v2 go get github.com/rookie-ninja/rk-mux
## Options
| options | description | type | default |
|--------------------|----------------------|---------|---------|
| mux.pprof.enabled | Enable pprof web UI | boolean | false |
| mux.pprof.path | Path of pprof web UI | string | pprof |
## Quick start
### 1.Create boot.yaml
```yaml
---
mux:
- name: greeter
port: 8080
enabled: true
pprof:
enabled: true
# path: ""
2.Create main.go#
// Copyright (c) 2021 rookie-ninja
//
// Use of this source code is governed by an Apache-style
// license that can be found in the LICENSE file.
package main
import (
"context"
_ "embed"
"fmt"
"github.com/rookie-ninja/rk-boot/v2"
"github.com/rookie-ninja/rk-mux/boot"
"github.com/rookie-ninja/rk-mux/middleware"
"net/http"
)
// @title RK Swagger for Mux
// @version 1.0
// @description This is a greeter service with rk-boot.
func main() {
// Create a new boot instance.
boot := rkboot.NewBoot()
// Get MuxEntry
muxEntry := rkmux.GetMuxEntry("greeter")
// Use *mux.Router adding handler.
muxEntry.Router.NewRoute().Path("/v1/greeter").HandlerFunc(Greeter)
// Bootstrap
boot.Bootstrap(context.TODO())
boot.WaitForShutdownSig(context.TODO())
}
// Greeter handler
// @Summary Greeter service
// @Id 1
// @version 1.0
// @produce application/json
// @Param name query string true "Input name"
// @Success 200 {object} GreeterResponse
// @Router /v1/greeter [get]
func Greeter(writer http.ResponseWriter, req *http.Request) {
rkmuxmid.WriteJson(writer, http.StatusOK, &GreeterResponse{
Message: fmt.Sprintf("Hello %s!", req.URL.Query().Get("name")),
})
}
type GreeterResponse struct {
Message string
}
3.Validate#
PPROF: http://localhost:8080/pprof