add Option notes

zhufuyi · Aug 24, 2022 · 3e946a0 · 3e946a0
1 parent 5ab9d45
commit 3e946a0
Show file tree

Hide file tree

Showing 11 changed files with 14 additions and 10 deletions.
diff --git a/gin/middleware/logging.go b/gin/middleware/logging.go
@@ -44,7 +44,7 @@ type options struct {
 	requestIDName string
 }
 
-// Option logger middleware options
+// Option set the gin logger options.
 type Option func(*options)
 
 func (o *options) apply(opts ...Option) {

diff --git a/gin/middleware/metrics/metrics.go b/gin/middleware/metrics/metrics.go
@@ -62,9 +62,9 @@ func initPrometheus() {
 	go recordUptime()
 }
 
-// recordUptime increases service uptime per second.
+// recordUptime increases service uptime per 30 second.
 func recordUptime() {
-	for range time.Tick(time.Second) {
+	for range time.Tick(time.Second * 30) {
 		uptime.WithLabelValues().Inc()
 	}
 }

diff --git a/gin/middleware/metrics/option.go b/gin/middleware/metrics/option.go
@@ -4,7 +4,7 @@ import (
 	"strings"
 )
 
-// Option set fields
+// Option set the metrics options.
 type Option func(*options)
 
 type options struct {

diff --git a/gin/middleware/ratelimiter/option.go b/gin/middleware/ratelimiter/option.go
@@ -15,7 +15,7 @@ var (
 	defaultIsIP = false
 )
 
-// Option logger middleware options
+// Option set the rate limits options.
 type Option func(*options)
 
 func defaultOptions() *options {
@@ -39,9 +39,9 @@ func (o *options) apply(opts ...Option) {
 }
 
 // WithQPS set the qps value
-func WithQPS(qps rate.Limit) Option {
+func WithQPS(qps int) Option {
 	return func(o *options) {
-		o.qps = qps
+		o.qps = rate.Limit(qps)
 	}
 }
 

diff --git a/gocron/option.go b/gocron/option.go
@@ -18,6 +18,7 @@ func (o *options) apply(opts ...Option) {
 	}
 }
 
+// Option set the cron options.
 type Option func(*options)
 
 // WithLog 设置日志

diff --git a/gofile/option.go b/gofile/option.go
@@ -21,6 +21,7 @@ func defaultOptions() *options {
 	}
 }
 
+// Option set the file options.
 type Option func(*options)
 
 func (o *options) apply(opts ...Option) {

diff --git a/goredis/option.go b/goredis/option.go
@@ -1,6 +1,6 @@
 package goredis
 
-// Option set fields
+// Option set the redis options.
 type Option func(*options)
 
 type options struct {

diff --git a/grpc/middleware/retry.go b/grpc/middleware/retry.go
@@ -36,7 +36,7 @@ func (o *options) apply(opts ...Option) {
 	}
 }
 
-// Option retry option function
+// Option set the retry options.
 type Option func(*options)
 
 // WithRetryTimes 设置重试次数，最大10次

diff --git a/jwt/option.go b/jwt/option.go
@@ -39,6 +39,7 @@ func defaultOptions() *options {
 	}
 }
 
+// Option set the jwt options.
 type Option func(*options)
 
 func (o *options) apply(opts ...Option) {

diff --git a/logger/option.go b/logger/option.go
@@ -38,6 +38,7 @@ func (o *options) apply(opts ...Option) {
 	}
 }
 
+// Option set the logger options.
 type Option func(*options)
 
 // WithLevel 输出日志级别

diff --git a/mysql/option.go b/mysql/option.go
@@ -4,7 +4,7 @@ import (
 	"time"
 )
 
-// Option set fields
+// Option set the mysql options.
 type Option func(*options)
 
 type options struct {