Merge pull request #327 from alimy/feature/pr-pprof

add pprof feature and pgo support

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 All notable changes to paopao-ce are documented in this file.
 ## 0.4.0+dev ([`dev`](https://github.com/rocboss/paopao-ce/tree/dev))
+### Added
+- add `pprof` feature support [#327](https://github.com/rocboss/paopao-ce/pull/327)  
+- use compiler profile-guided optimization (PGO) to further optimize builds. [#327](https://github.com/rocboss/paopao-ce/pull/327)  
 
 ## 0.3.0
 ### Added

Makefile

@@ -32,10 +32,10 @@ all: fmt build
 build:
 	@go mod download
 	@echo Build paopao-ce
-	@go build -trimpath -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_ROOT)/$(TARGET)
+	@go build -pgo=auto -trimpath -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_ROOT)/$(TARGET)
 
 run:
-	@go run -trimpath -gcflags "all=-N -l" -tags '$(TAGS)' -ldflags '$(LDFLAGS)' .
+	@go run -pgo=auto -trimpath -gcflags "all=-N -l" -tags '$(TAGS)' -ldflags '$(LDFLAGS)' .
 
 .PHONY: release
 release: linux-amd64 darwin-amd64 darwin-arm64 windows-x64
@@ -52,22 +52,22 @@ release: linux-amd64 darwin-amd64 darwin-arm64 windows-x64
 .PHONY: linux-amd64
 linux-amd64:
 	@echo Build paopao-ce [linux-amd64] CGO_ENABLED=$(CGO_ENABLED) TAGS="'$(TAGS)'"
-	@CGO_ENABLED=$(CGO_ENABLED) GOOS=linux GOARCH=amd64 go build -trimpath -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_LINUX_AMD64)/$(TARGET_BIN)
+	@CGO_ENABLED=$(CGO_ENABLED) GOOS=linux GOARCH=amd64 go build -pgo=auto -trimpath -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_LINUX_AMD64)/$(TARGET_BIN)
 
 .PHONY: darwin-amd64
 darwin-amd64:
 	@echo Build paopao-ce [darwin-amd64] CGO_ENABLED=$(CGO_ENABLED) TAGS="'$(TAGS)'"
-	@CGO_ENABLED=$(CGO_ENABLED) GOOS=darwin GOARCH=amd64 go build -trimpath  -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_DARWIN_AMD64)/$(TARGET_BIN)
+	@CGO_ENABLED=$(CGO_ENABLED) GOOS=darwin GOARCH=amd64 go build -pgo=auto -trimpath  -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_DARWIN_AMD64)/$(TARGET_BIN)
 
 .PHONY: darwin-arm64
 darwin-arm64:
 	@echo Build paopao-ce [darwin-arm64] CGO_ENABLED=$(CGO_ENABLED) TAGS="'$(TAGS)'"
-	@CGO_ENABLED=$(CGO_ENABLED) GOOS=darwin GOARCH=arm64 go build -trimpath -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_DARWIN_ARM64)/$(TARGET_BIN)
+	@CGO_ENABLED=$(CGO_ENABLED) GOOS=darwin GOARCH=arm64 go build -pgo=auto -trimpath -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_DARWIN_ARM64)/$(TARGET_BIN)
 
 .PHONY: windows-x64
 windows-x64:
 	@echo Build paopao-ce [windows-x64] CGO_ENABLED=$(CGO_ENABLED) TAGS="'$(TAGS)'"
-	@CGO_ENABLED=$(CGO_ENABLED) GOOS=windows GOARCH=amd64 go build -trimpath  -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_WINDOWS_AMD64)/$(TARGET_BIN).exe
+	@CGO_ENABLED=$(CGO_ENABLED) GOOS=windows GOARCH=amd64 go build -pgo=auto -trimpath  -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o $(RELEASE_WINDOWS_AMD64)/$(TARGET_BIN).exe
 
 .PHONY: generate
 generate: gen-mir gen-grpc

README.md

@@ -375,7 +375,8 @@ release/paopao-ce --no-default-features --features sqlite3,localoss,loggerfile,r
 |`Alipay` | 支付 | 稳定 | 开启基于[支付宝开放平台](https://open.alipay.com/)的钱包功能 |
 |`Sms` | 短信验证 | 稳定 | 开启短信验证码功能，用于手机绑定验证手机是否注册者的；功能如果没有开启，手机绑定时任意短信验证码都可以绑定手机 |
 |`Docs:OpenAPI` | 开发文档 | 稳定 | 开启openapi文档功能，提供web api文档说明(visit http://127.0.0.1:8008/docs/openapi) |
-|[`Pyroscope`](docs/proposal/016-关于使用pyroscope用于性能调试的设计.md)| 性能优化 | 内测 | 开启Pyroscope功能用于性能调试 |   
+|[`Pyroscope`](docs/proposal/23021510-关于使用pyroscope用于性能调试的设计.md)| 性能优化 | 内测 | 开启Pyroscope功能用于性能调试 |   
+|[`Pprof`](docs/proposal/23062905-添加Pprof功能特性用于获取Profile.md)| 性能优化 | 内测 | 开启Pprof功能收集Profile信息 |  
 |`PhoneBind` | 其他 | 稳定 | 手机绑定功能 |   
 |`Web:DisallowUserRegister` | 功能特性 | 稳定 | 不允许用户注册 |     
 

docs/proposal/23062905-添加Pprof功能特性用于获取Profile.md

@@ -0,0 +1,67 @@
+| 编号 | 作者 | 发表时间 | 变更时间 | 版本 | 状态 |
+| ----- | ----- | ----- | ----- | ----- | ----- |
+| 23062905| 北野 | 2023-06-29 | 2023-06-29 | v1.0 | 提议 |
+
+### 概述  
+使用net/http/pprof获取Profile信息。添加`Pprof`功能特性用于开启PprofServer服务。
+
+### 需求   
+- 只在开发环境下获取profile信息
+- 可以在配置文件中开启获取profile的服务
+
+### 方案  
+- 添加`Pprof`功能特性
+- 添加`PprofServer`服务
+
+#### 设计细节 
+- 配置文件中添加`PprofServer`项用于配制http server
+- 添加`Pprof`功能特性
+- 添加`PprofServer`服务
+- 使用`//go:build pprof`按需编译profile功能
+- `PprofServer` 不能和其他服务共用一个端口
+
+### 疑问
+
+1. 为什么要添加`pprof`功能特性？   
+使用 net/http/pprof 在线获取CPU profile信息，用于 [PGO](https://go.dev/doc/pgo) 编译优化。   
+
+2. 如何开启`Pprof`服务？   
+* 构建时将 `pprof` 添加到TAGS中:
+    ```sh
+    make run TAGS='pprof'   
+    ```          
+* 在配置文件config.yaml中的`Features`中添加`Pprof`功能项开启该功能：
+    ```yaml
+    ...
+    # features中加上 Friendship
+    Features:
+      Default: ["Meili", "LoggerMeili", "Base", "Sqlite3", "BigCacheIndex", "MinIO", "Pprof"]
+      Base: ["Redis", "PhoneBind"]
+    ...
+    ```
+
+3. 常见命令  
+
+#### Merging profiles
+The pprof tool can merge multiple profiles like this:
+```sh
+$ go tool pprof -proto a.pprof b.pprof > merged.pprof
+```
+This merge is effectively a straightforward sum of samples in the input, regardless of wall duration of the profile. As a result, when profiling a small time slice of an application (e.g., a server that runs indefinitely), you likely want to ensure that all profiles have the same wall duration (i.e., all profiles are collected for 30s). Otherwise, profiles with longer wall duration will be overrepresented in the merged profile.
+
+#### look at a 30-second CPU profile:
+```sh
+go tool pprof http://localhost:6060/debug/pprof/profile?seconds=30
+```
+
+### 参考文档
+* [PGO](https://go.dev/doc/pgo)
+* [net/http/pprof](https://pkg.go.dev/net/http/pprof)
+* [runtime/pprof](https://pkg.go.dev/runtime/pprof)  
+
+### 参考实现
+- [#327](https://github.com/rocboss/paopao-ce/pull/327)
+
+### 更新记录
+#### v1.0(2023-06-20) - 北野
+* 初始文档

docs/proposal/23062906-关于开启pgo编译优化.md

@@ -0,0 +1,38 @@
+| 编号 | 作者 | 发表时间 | 变更时间 | 版本 | 状态 |
+| ----- | ----- | ----- | ----- | ----- | ----- |
+| 23062906| 北野 | 2023-06-29 | 2023-06-29 | v1.0 | 提议 |
+
+### 概述  
+Beginning in Go 1.20, the Go compiler supports profile-guided optimization ([PGO](https://go.dev/doc/pgo)) to further optimize builds.
+
+
+### 疑问
+
+1. 为什么要添加`pprof`功能特性？   
+使用 net/http/pprof 在线获取CPU profile信息，用于 [PGO](https://go.dev/doc/pgo) 编译优化。   
+
+2. 如何开启`pgo`编译优化？ 
+The standard approach is to store a pprof CPU profile with filename default.pgo in the main package directory of the profiled binary, and build with go build -pgo=auto, which will pick up default.pgo files automatically.  
+
+3. 常见命令  
+
+#### Merging profiles
+The pprof tool can merge multiple profiles like this:
+```sh
+$ go tool pprof -proto a.pprof b.pprof > default.pgo
+```
+This merge is effectively a straightforward sum of samples in the input, regardless of wall duration of the profile. As a result, when profiling a small time slice of an application (e.g., a server that runs indefinitely), you likely want to ensure that all profiles have the same wall duration (i.e., all profiles are collected for 30s). Otherwise, profiles with longer wall duration will be overrepresented in the merged profile.
+
+#### look at a 30-second CPU profile:
+```sh
+go tool pprof http://localhost:6060/debug/pprof/profile?seconds=30
+```
+
+### 参考文档
+* [PGO](https://go.dev/doc/pgo)
+* [net/http/pprof](https://pkg.go.dev/net/http/pprof)
+* [runtime/pprof](https://pkg.go.dev/runtime/pprof)  
+
+### 更新记录
+#### v1.0(2023-06-20) - 北野
+* 初始文档

features-status.md

@@ -146,15 +146,15 @@
 
 #### 关系模式:    
 * `Friendship` 弱关系好友模式，类似微信朋友圈(目前状态: 内测); 
-    * [x] [提按文档](docs/proposal/002-关于Friendship功能项的设计.md)
+    * [x] [提按文档](docs/proposal/22110410-关于Friendship功能项的设计.md)
     * [x] 接口定义
     * [x] 业务逻辑实现     
 * `Followship` 关注者模式，类似Twitter的Follow模式(目前状态: WIP);  
-    * [ ] [提按文档](docs/proposal/003-关于Followship功能项的设计.md)
+    * [ ] [提按文档](docs/proposal/22110409-关于Followship功能项的设计.md)
     * [ ] 接口定义
     * [ ] 业务逻辑实现   
 * `Lightship` 开放模式，所有推文都公开可见(目前状态: 内测、默认);  
-    * [x] [提按文档](docs/proposal/011-关于Lightship功能项的设计.md)
+    * [x] [提按文档](docs/proposal/22121409-关于Lightship功能项的设计.md)
     * [x] 接口定义
     * [x] 业务逻辑实现 
 
@@ -181,10 +181,13 @@
     * [x] 业务逻辑实现   
 
 ### 性能优化
-* [`Pyroscope`](docs/proposal/016-关于使用pyroscope用于性能调试的设计.md) 开启Pyroscope功能用于性能调试(目前状态: 内测);  
+* [`Pyroscope`](docs/proposal/23021510-关于使用pyroscope用于性能调试的设计.md) 开启Pyroscope功能用于性能调试(目前状态: 内测);  
     * [x] 提按文档  
     * [x] 业务逻辑实现  
- 
+* [`Pprof`](docs/proposal/23062905-添加Pprof功能特性用于获取Profile.md) 开启Pprof功能收集Profile信息(目前状态: 内测);  
+    * [x] 提按文档  
+    * [x] 业务逻辑实现  
+
 ### 其他:    
 * `PhoneBind` 手机绑定功能； 
     * [ ] 提按文档  

internal/conf/conf.go

@@ -24,6 +24,7 @@ var (
 	MysqlSetting            *mysqlConf
 	PostgresSetting         *postgresConf
 	Sqlite3Setting          *sqlite3Conf
+	PprofServerSetting      *httpServerConf
 	WebServerSetting        *httpServerConf
 	AdminServerSetting      *httpServerConf
 	SpaceXServerSetting     *httpServerConf
@@ -67,6 +68,7 @@ func setupSetting(suite []string, noDefault bool) error {
 
 	objects := map[string]any{
 		"App":               &AppSetting,
+		"PprofServer":       &PprofServerSetting,
 		"WebServer":         &WebServerSetting,
 		"AdminServer":       &AdminServerSetting,
 		"SpaceXServer":      &SpaceXServerSetting,

internal/conf/config.yaml

@@ -37,6 +37,12 @@ LocalossServer: # Localoss服务
   HttpPort: 8018
   ReadTimeout: 60
   WriteTimeout: 60
+PprofServer: # Pprof服务
+  RunMode: debug
+  HttpIp: 0.0.0.0
+  HttpPort: 6060
+  ReadTimeout: 60
+  WriteTimeout: 60
 FrontendWebServer: # Web前端静态资源服务
   RunMode: debug
   HttpIp: 0.0.0.0

internal/service/pprof.go

@@ -0,0 +1,61 @@
+// Copyright 2023 ROC. All rights reserved.
+// Use of this source code is governed by a MIT style
+// license that can be found in the LICENSE file.
+
+package service
+
+import (
+	"fmt"
+	"net/http"
+
+	"github.com/Masterminds/semver/v3"
+	"github.com/fatih/color"
+	"github.com/gin-gonic/gin"
+	"github.com/rocboss/paopao-ce/internal/conf"
+)
+
+var (
+	_ Service = (*pprofService)(nil)
+)
+
+type pprofService struct {
+	*baseHttpService
+}
+
+func (s *pprofService) Name() string {
+	return "PprofService"
+}
+
+func (s *pprofService) Version() *semver.Version {
+	return semver.MustParse("v0.1.0")
+}
+
+func (s *pprofService) OnInit() error {
+	s.registerRoute(s, func(*gin.Engine) {})
+	return nil
+}
+
+func (s *pprofService) String() string {
+	return fmt.Sprintf("listen on %s\n", color.GreenString("http://%s:%s", conf.PprofServerSetting.HttpIp, conf.PprofServerSetting.HttpPort))
+}
+
+func newPprofService() Service {
+	addr := conf.PprofServerSetting.HttpIp + ":" + conf.PprofServerSetting.HttpPort
+	// notice this step just to register pprof server to start. don't share server with pprof.
+	server := httpServers.from(addr, func() *httpServer {
+		engine := newWebEngine()
+		return &httpServer{
+			baseServer: newBaseServe(),
+			e:          engine,
+			server: &http.Server{
+				Addr:    addr,
+				Handler: http.DefaultServeMux,
+			},
+		}
+	})
+	return &pprofService{
+		baseHttpService: &baseHttpService{
+			server: server,
+		},
+	}
+}

internal/service/service.go

@@ -72,6 +72,9 @@ func newService() (ss []Service) {
 		"Docs": func() {
 			ss = append(ss, newDocsService())
 		},
+		"Pprof": func() {
+			ss = append(ss, newPprofService())
+		},
 	})
 	return
 }

pkg/debug/pprof_embed.go

@@ -0,0 +1,12 @@
+// Copyright 2023 ROC. All rights reserved.
+// Use of this source code is governed by a MIT style
+// license that can be found in the LICENSE file.
+
+//go:build pprof
+// +build pprof
+
+package debug
+
+import (
+	_ "net/http/pprof"
+)