update README

zhufuyi · zhufuyi · commit a1af23f08ffb · 2024-07-30T21:20:01.000+08:00
diff --git a/.github/RELEASE.md b/.github/RELEASE.md
@@ -2,4 +2,4 @@
 
 1. Modify the returned ID type, it will affect the ID types of GetByID and List for `⓵Create web service based on sql`, which are consistent with the ID types in the database.
 
-> If you are using code for `⓵Create web service based on sql` before v1.8.6, do not modify the sponge version under go.mod and upgrade to v1.8.6 or above. Otherwise, the List interface will return empty data because the original `size` field has become invalid (replaced by `limit` field).
+> Warning: If you are using code for `⓵Create web service based on sql` before v1.8.6, do not modify the sponge version under go.mod and upgrade to v1.8.6 or above. Otherwise, the List interface will return empty data because the original `size` field has become invalid (replaced by `limit` field).
diff --git a/cmd/serverNameExample_grpcExample/initial/initApp.go b/cmd/serverNameExample_grpcExample/initial/initApp.go
@@ -49,12 +49,15 @@ func InitApp() {
 		panic(err)
 	}
 	logger.Debug(config.Show())
-	logger.Info("init logger succeeded")
+	logger.Info("[logger] was initialized")
 
 	// initializing database
 	model.InitDB()
-	logger.Infof("init %s succeeded", cfg.Database.Driver)
+	logger.Infof("[%s] was initialized", cfg.Database.Driver)
 	model.InitCache(cfg.App.CacheType)
+	if cfg.App.CacheType != "" {
+		logger.Infof("[%s] was initialized", cfg.App.CacheType)
+	}
 
 	// initializing tracing
 	if cfg.App.EnableTrace {
@@ -66,7 +69,7 @@ func InitApp() {
 			strconv.Itoa(cfg.Jaeger.AgentPort),
 			cfg.App.TracingSamplingRate,
 		)
-		logger.Info("init tracer succeeded")
+		logger.Info("[tracer] was initialized")
 	}
 
 	// initializing the print system and process resources
@@ -75,7 +78,7 @@ func InitApp() {
 			stat.WithLog(logger.Get()),
 			stat.WithAlarm(), // invalid if it is windows, the default threshold for cpu and memory is 0.8, you can modify them
 		)
-		logger.Info("init statistics succeeded")
+		logger.Info("[resource statistics] was initialized")
 	}
 }
 
diff --git a/cmd/serverNameExample_grpcGwPbExample/initial/initApp.go b/cmd/serverNameExample_grpcGwPbExample/initial/initApp.go
@@ -49,7 +49,7 @@ func InitApp() {
 		panic(err)
 	}
 	logger.Debug(config.Show())
-	logger.Info("init logger succeeded")
+	logger.Info("[logger] was initialized")
 
 	// initializing tracing
 	if cfg.App.EnableTrace {
@@ -61,7 +61,7 @@ func InitApp() {
 			strconv.Itoa(cfg.Jaeger.AgentPort),
 			cfg.App.TracingSamplingRate,
 		)
-		logger.Info("init tracer succeeded")
+		logger.Info("[tracer] was initialized")
 	}
 
 	// initializing the rpc server connection
@@ -74,7 +74,7 @@ func InitApp() {
 			stat.WithLog(logger.Get()),
 			stat.WithAlarm(), // invalid if it is windows, the default threshold for cpu and memory is 0.8, you can modify them
 		)
-		logger.Info("init statistics succeeded")
+		logger.Info("[resource statistics] was initialized")
 	}
 }
 
diff --git a/cmd/serverNameExample_grpcHttpPbExample/initial/initApp.go b/cmd/serverNameExample_grpcHttpPbExample/initial/initApp.go
@@ -49,12 +49,15 @@ func InitApp() {
 		panic(err)
 	}
 	logger.Debug(config.Show())
-	logger.Info("init logger succeeded")
+	logger.Info("[logger] was initialized")
 
 	// initializing database
 	//model.InitDB()
-	//logger.Infof("init %s succeeded", cfg.Database.Driver)
+	//logger.Infof("[%s] was initialized", cfg.Database.Driver)
 	//model.InitCache(cfg.App.CacheType)
+	//if cfg.App.CacheType != "" {
+	//	logger.Infof("[%s] was initialized", cfg.App.CacheType)
+	//}
 
 	// initializing tracing
 	if cfg.App.EnableTrace {
@@ -66,7 +69,7 @@ func InitApp() {
 			strconv.Itoa(cfg.Jaeger.AgentPort),
 			cfg.App.TracingSamplingRate,
 		)
-		logger.Info("init tracer succeeded")
+		logger.Info("[tracer] was initialized")
 	}
 
 	// initializing the print system and process resources
@@ -75,7 +78,7 @@ func InitApp() {
 			stat.WithLog(logger.Get()),
 			stat.WithAlarm(), // invalid if it is windows, the default threshold for cpu and memory is 0.8, you can modify them
 		)
-		logger.Info("init statistics succeeded")
+		logger.Info("[resource statistics] was initialized")
 	}
 }
 
diff --git a/cmd/serverNameExample_grpcPbExample/initial/initApp.go b/cmd/serverNameExample_grpcPbExample/initial/initApp.go
@@ -49,12 +49,15 @@ func InitApp() {
 		panic(err)
 	}
 	logger.Debug(config.Show())
-	logger.Info("init logger succeeded")
+	logger.Info("[logger] was initialized")
 
 	// initializing database
 	//model.InitDB()
-	//logger.Infof("init %s succeeded", cfg.Database.Driver)
+	//logger.Infof("[%s] was initialized", cfg.Database.Driver)
 	//model.InitCache(cfg.App.CacheType)
+	//if cfg.App.CacheType != "" {
+	//	logger.Infof("[%s] was initialized", cfg.App.CacheType)
+	//}
 
 	// initializing tracing
 	if cfg.App.EnableTrace {
@@ -66,7 +69,7 @@ func InitApp() {
 			strconv.Itoa(cfg.Jaeger.AgentPort),
 			cfg.App.TracingSamplingRate,
 		)
-		logger.Info("init tracer succeeded")
+		logger.Info("[tracer] was initialized")
 	}
 
 	// initializing the print system and process resources
@@ -75,7 +78,7 @@ func InitApp() {
 			stat.WithLog(logger.Get()),
 			stat.WithAlarm(), // invalid if it is windows, the default threshold for cpu and memory is 0.8, you can modify them
 		)
-		logger.Info("init statistics succeeded")
+		logger.Info("[resource statistics] was initialized")
 	}
 }
 
diff --git a/cmd/serverNameExample_httpExample/initial/initApp.go b/cmd/serverNameExample_httpExample/initial/initApp.go
@@ -49,12 +49,15 @@ func InitApp() {
 		panic(err)
 	}
 	logger.Debug(config.Show())
-	logger.Info("init logger succeeded")
+	logger.Info("[logger] was initialized")
 
 	// initializing database
 	model.InitDB()
-	logger.Infof("init %s succeeded", cfg.Database.Driver)
+	logger.Infof("[%s] was initialized", cfg.Database.Driver)
 	model.InitCache(cfg.App.CacheType)
+	if cfg.App.CacheType != "" {
+		logger.Infof("[%s] was initialized", cfg.App.CacheType)
+	}
 
 	// initializing tracing
 	if cfg.App.EnableTrace {
@@ -66,7 +69,7 @@ func InitApp() {
 			strconv.Itoa(cfg.Jaeger.AgentPort),
 			cfg.App.TracingSamplingRate,
 		)
-		logger.Info("init tracer succeeded")
+		logger.Info("[tracer] was initialized")
 	}
 
 	// initializing the print system and process resources
@@ -75,7 +78,7 @@ func InitApp() {
 			stat.WithLog(logger.Get()),
 			stat.WithAlarm(), // invalid if it is windows, the default threshold for cpu and memory is 0.8, you can modify them
 		)
-		logger.Info("init statistics succeeded")
+		logger.Info("[resource statistics] was initialized")
 	}
 }
 
diff --git a/cmd/serverNameExample_httpPbExample/initial/initApp.go b/cmd/serverNameExample_httpPbExample/initial/initApp.go
@@ -49,12 +49,15 @@ func InitApp() {
 		panic(err)
 	}
 	logger.Debug(config.Show())
-	logger.Info("init logger succeeded")
+	logger.Info("[logger] was initialized")
 
 	// initializing database
 	//model.InitDB()
-	//logger.Infof("init %s succeeded", cfg.Database.Driver)
+	//logger.Infof("[%s] was initialized", cfg.Database.Driver)
 	//model.InitCache(cfg.App.CacheType)
+	//if cfg.App.CacheType != "" {
+	//	logger.Infof("[%s] was initialized", cfg.App.CacheType)
+	//}
 
 	// initializing tracing
 	if cfg.App.EnableTrace {
@@ -66,7 +69,7 @@ func InitApp() {
 			strconv.Itoa(cfg.Jaeger.AgentPort),
 			cfg.App.TracingSamplingRate,
 		)
-		logger.Info("init tracer succeeded")
+		logger.Info("[tracer] was initialized")
 	}
 
 	// initializing the print system and process resources
@@ -75,7 +78,7 @@ func InitApp() {
 			stat.WithLog(logger.Get()),
 			stat.WithAlarm(), // invalid if it is windows, the default threshold for cpu and memory is 0.8, you can modify them
 		)
-		logger.Info("init statistics succeeded")
+		logger.Info("[resource statistics] was initialized")
 	}
 }
 
diff --git a/cmd/serverNameExample_mixExample/initial/initApp.go b/cmd/serverNameExample_mixExample/initial/initApp.go
@@ -49,12 +49,15 @@ func InitApp() {
 		panic(err)
 	}
 	logger.Debug(config.Show())
-	logger.Info("init logger succeeded")
+	logger.Info("[logger] was initialized")
 
 	// initializing database
 	model.InitDB()
-	logger.Infof("init %s succeeded", cfg.Database.Driver)
+	logger.Infof("[%s] was initialized", cfg.Database.Driver)
 	model.InitCache(cfg.App.CacheType)
+	if cfg.App.CacheType != "" {
+		logger.Infof("[%s] was initialized", cfg.App.CacheType)
+	}
 
 	// initializing tracing
 	if cfg.App.EnableTrace {
@@ -66,7 +69,7 @@ func InitApp() {
 			strconv.Itoa(cfg.Jaeger.AgentPort),
 			cfg.App.TracingSamplingRate,
 		)
-		logger.Info("init tracer succeeded")
+		logger.Info("[tracer] was initialized")
 	}
 
 	// initializing the print system and process resources
@@ -75,7 +78,7 @@ func InitApp() {
 			stat.WithLog(logger.Get()),
 			stat.WithAlarm(), // invalid if it is windows, the default threshold for cpu and memory is 0.8, you can modify them
 		)
-		logger.Info("init statistics succeeded")
+		logger.Info("[resource statistics] was initialized")
 	}
 }
 
diff --git a/pkg/grpc/metrics/monitor-example-cn.md b/pkg/grpc/metrics/monitor-example-cn.md
@@ -67,7 +67,7 @@ wrk -t2 -c10 -d10s http://192.168.3.27:8080/api/v1/course/1
 
 监控界面如下图所示：
 
-![http-grafana](https://go-sponge.com/assets/images/http-grafana.jpg)
+![http-grafana](https://raw.githubusercontent.com/zhufuyi/sponge_examples/main/assets/http-grafana.jpg)
 
 <br>
 
@@ -103,7 +103,7 @@ wrk -t2 -c10 -d10s http://192.168.3.27:8080/api/v1/course/1
 使用`Goland` IDE打开`internal/service/teacher_client_test.go`文件，对**Test_teacherService_methods** 或 **Test_teacherService_benchmark** 下各个方法进行测试。
 
 监控界面如下图所示。
-![rpc-grafana](https://go-sponge.com/assets/images/rpc-grafana.jpg)
+![rpc-grafana](https://raw.githubusercontent.com/zhufuyi/sponge_examples/main/assets/rpc-grafana.jpg)
 
 <br>
 
diff --git a/pkg/grpc/metrics/monitor-example-en.md b/pkg/grpc/metrics/monitor-example-en.md
@@ -67,7 +67,7 @@ wrk -t2 -c10 -d10s http://192.168.3.27:8080/api/v1/course/1
 
 The monitoring interface will look like the following image:
 
-![http-grafana](https://go-sponge.com/assets/images/http-grafana.jpg)
+![http-grafana](https://raw.githubusercontent.com/zhufuyi/sponge_examples/main/assets/http-grafana.jpg)
 
 <br>
 
@@ -104,7 +104,7 @@ Open the `internal/service/teacher_client_test.go` file using the `Goland` IDE a
 
 The monitoring interface will look like the following image:
 
-![rpc-grafana](https://go-sponge.com/assets/images/rpc-grafana.jpg)
+![rpc-grafana](https://raw.githubusercontent.com/zhufuyi/sponge_examples/main/assets/rpc-grafana.jpg)
 
 <br>
 
diff --git a/pkg/tracer/example-cn.md b/pkg/tracer/example-cn.md
@@ -36,7 +36,7 @@ make run
 
 复制 [http://localhost:8080/swagger/index.html](http://localhost:8080/apis/swagger/index.html) 到浏览器访问swagger主页，以请求get查询为例，连续请求同一个id两次，链路跟踪如下图所示。
 
-![one-server-trace](https://go-sponge.com/assets/images/one-server-trace.jpg)
+![one-server-trace](https://raw.githubusercontent.com/zhufuyi/sponge_examples/main/assets/one-server-trace.jpg)
 
 <br>
 
@@ -76,7 +76,7 @@ defer span.End()
 
 启动 **shopgw**、**product**、**inventory**、**comment** 四个服务，在浏览器访问 [http://localhost:8080/apis/swagger/index.html](http://localhost:8080/apis/swagger/index.html) ，执行get请求，链路跟踪界面如下图所示。
 
-![multi-servers-trace](https://go-sponge.com/assets/images/multi-servers-trace.jpg)
+![multi-servers-trace](https://raw.githubusercontent.com/zhufuyi/sponge_examples/main/assets/multi-servers-trace.jpg)
 
 <br>
 
diff --git a/pkg/tracer/example-en.md b/pkg/tracer/example-en.md
@@ -35,7 +35,7 @@ make run
 
 Copy [http://localhost:8080/swagger/index.html](http://localhost:8080/apis/swagger/index.html) into your browser to access the Swagger homepage. As an example, for a GET request, make two consecutive requests with the same ID. The distributed tracing results are shown in the following image:
 
-![one-server-trace](https://go-sponge.com/assets/images/one-server-trace.jpg)
+![one-server-trace](https://raw.githubusercontent.com/zhufuyi/sponge_examples/main/assets/one-server-trace.jpg)
 
 From the image, you can see that the first request consists of 4 spans:
 
@@ -73,7 +73,7 @@ In the **product**, **inventory**, and **comment** services, locate the template
 
 Start the **shopgw**, **product**, **inventory**, and **comment** services. Access [http://localhost:8080/apis/swagger/index.html](http://localhost:8080/apis/swagger/index.html) in your browser and execute a GET request. The distributed tracing interface will look like the image below:
 
-![multi-servers-trace](https://go-sponge.com/assets/images/multi-servers-trace.jpg)
+![multi-servers-trace](https://raw.githubusercontent.com/zhufuyi/sponge_examples/main/assets/multi-servers-trace.jpg)
 
 From the image, you can see a total of 10 spans in the primary trace:
 

Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,4 @@`
`2`	`2`
`3`	`3`	1. Modify the returned ID type, it will affect the ID types of GetByID and List for `⓵Create web service based on sql`, which are consistent with the ID types in the database.
`4`	`4`
`5`		-> If you are using code for `⓵Create web service based on sql` before v1.8.6, do not modify the sponge version under go.mod and upgrade to v1.8.6 or above. Otherwise, the List interface will return empty data because the original `size` field has become invalid (replaced by `limit` field).
	`5`	+> Warning: If you are using code for `⓵Create web service based on sql` before v1.8.6, do not modify the sponge version under go.mod and upgrade to v1.8.6 or above. Otherwise, the List interface will return empty data because the original `size` field has become invalid (replaced by `limit` field).
Original file line number	Diff line number	Diff line change
`@@ -49,12 +49,15 @@ func InitApp() {`
`49`	`49`	`panic(err)`
`50`	`50`	`}`
`51`	`51`	`logger.Debug(config.Show())`
`52`		`- logger.Info("init logger succeeded")`
	`52`	`+ logger.Info("[logger] was initialized")`
`53`	`53`
`54`	`54`	`// initializing database`
`55`	`55`	`model.InitDB()`
`56`		`- logger.Infof("init %s succeeded", cfg.Database.Driver)`
	`56`	`+ logger.Infof("[%s] was initialized", cfg.Database.Driver)`
`57`	`57`	`model.InitCache(cfg.App.CacheType)`
	`58`	`+ if cfg.App.CacheType != "" {`
	`59`	`+ logger.Infof("[%s] was initialized", cfg.App.CacheType)`
	`60`	`+ }`
`58`	`61`
`59`	`62`	`// initializing tracing`
`60`	`63`	`if cfg.App.EnableTrace {`
`@@ -66,7 +69,7 @@ func InitApp() {`
`66`	`69`	`strconv.Itoa(cfg.Jaeger.AgentPort),`
`67`	`70`	`cfg.App.TracingSamplingRate,`
`68`	`71`	`)`
`69`		`- logger.Info("init tracer succeeded")`
	`72`	`+ logger.Info("[tracer] was initialized")`
`70`	`73`	`}`
`71`	`74`
`72`	`75`	`// initializing the print system and process resources`
`@@ -75,7 +78,7 @@ func InitApp() {`
`75`	`78`	`stat.WithLog(logger.Get()),`
`76`	`79`	`stat.WithAlarm(), // invalid if it is windows, the default threshold for cpu and memory is 0.8, you can modify them`
`77`	`80`	`)`
`78`		`- logger.Info("init statistics succeeded")`
	`81`	`+ logger.Info("[resource statistics] was initialized")`
`79`	`82`	`}`
`80`	`83`	`}`
`81`	`84`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ func InitApp() {`
`49`	`49`	`panic(err)`
`50`	`50`	`}`
`51`	`51`	`logger.Debug(config.Show())`
`52`		`- logger.Info("init logger succeeded")`
	`52`	`+ logger.Info("[logger] was initialized")`
`53`	`53`
`54`	`54`	`// initializing tracing`
`55`	`55`	`if cfg.App.EnableTrace {`
`@@ -61,7 +61,7 @@ func InitApp() {`
`61`	`61`	`strconv.Itoa(cfg.Jaeger.AgentPort),`
`62`	`62`	`cfg.App.TracingSamplingRate,`
`63`	`63`	`)`
`64`		`- logger.Info("init tracer succeeded")`
	`64`	`+ logger.Info("[tracer] was initialized")`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`// initializing the rpc server connection`
`@@ -74,7 +74,7 @@ func InitApp() {`
`74`	`74`	`stat.WithLog(logger.Get()),`
`75`	`75`	`stat.WithAlarm(), // invalid if it is windows, the default threshold for cpu and memory is 0.8, you can modify them`
`76`	`76`	`)`
`77`		`- logger.Info("init statistics succeeded")`
	`77`	`+ logger.Info("[resource statistics] was initialized")`
`78`	`78`	`}`
`79`	`79`	`}`
`80`	`80`