From 6c4d683ae6f1137037d4eb2032bc453c33b904dc Mon Sep 17 00:00:00 2001 From: Neng Wan Date: Thu, 21 Oct 2021 15:03:04 +0800 Subject: [PATCH 1/4] add metric counters --- extensions/cachext/cached.go | 10 ++++++++++ extensions/cachext/ext.go | 37 ++++++++++++++++++++++++++++++++++++ go.mod | 1 + go.sum | 37 ++++++++++++++++++++++++++++++++++-- 4 files changed, 83 insertions(+), 2 deletions(-) diff --git a/extensions/cachext/cached.go b/extensions/cachext/cached.go index cad592e4..0fa5ab6f 100644 --- a/extensions/cachext/cached.go +++ b/extensions/cachext/cached.go @@ -10,6 +10,7 @@ import ( "time" "github.com/RichardKnop/machinery/v1/log" + "github.com/prometheus/client_golang/prometheus" ) const Nil = cacheNil("cache result is nil") @@ -61,7 +62,16 @@ func (c *CachedConfig) GetResult(ctx context.Context, out interface{}, strArgs [ if err != nil { return err } + labels := prometheus.Labels{prefixName: c.cache.prefix, funcName: c.funcName} + if c.cache.requestCounter != nil { + // Increment request counter. + c.cache.requestCounter.With(labels).Inc() + } if data != nil { + if c.cache.hitCounter != nil { + // Increment hit counter. + c.cache.hitCounter.With(labels).Inc() + } if c.cacheNil && decodeIsNil(data) { // 无法直接把out设置为nil，这里通过返回特殊的错误来表示nil。调用方需要判断 return Nil diff --git a/extensions/cachext/ext.go b/extensions/cachext/ext.go index 610a95b3..89f1a213 100644 --- a/extensions/cachext/ext.go +++ b/extensions/cachext/ext.go @@ -12,6 +12,8 @@ import ( "github.com/shanbay/gobay" "github.com/spf13/viper" "github.com/vmihailenco/msgpack" + "github.com/prometheus/client_golang/prometheus" + "github.com/prometheus/client_golang/prometheus/promauto" ) type void struct{} @@ -24,6 +26,8 @@ type CacheExt struct { prefix string initialized bool cachedFuncName map[string]void + requestCounter *prometheus.CounterVec + hitCounter *prometheus.CounterVec } var ( @@ -32,6 +36,35 @@ var ( mu sync.Mutex ) +const ( + prefixName = "prefix_name" + funcName = "func_name" +) + +var cacheLabels = []string{prefixName, funcName} + +// Create a collector for total cache request counter +func initCacheRequestCounter() *prometheus.CounterVec { + return promauto.NewCounterVec( + prometheus.CounterOpts{ + Name: "cache_request_counter", + Help: "Number of cache requests", + }, + cacheLabels, + ) +} + +// Create a collector for cache hit counter +func initCacheHitCounter() *prometheus.CounterVec { + return promauto.NewCounterVec( + prometheus.CounterOpts{ + Name: "cache_hit_counter", + Help: "Number of cache hits", + }, + cacheLabels, + ) +} + // CacheBackend type CacheBackend interface { Init(*viper.Viper) error @@ -73,6 +106,10 @@ func (c *CacheExt) Init(app *gobay.Application) error { } else { return errors.New("No backend found for cache_backend:" + backendConfig) } + if config.GetBool("monitor_enable") { + c.requestCounter = initCacheRequestCounter() + c.hitCounter = initCacheHitCounter() + } c.initialized = true return nil diff --git a/go.mod b/go.mod index c22deae8..6d91debe 100644 --- a/go.mod +++ b/go.mod @@ -22,6 +22,7 @@ require ( github.com/mattn/go-sqlite3 v1.14.6 github.com/mitchellh/mapstructure v1.4.1 github.com/pkg/errors v0.9.1 + github.com/prometheus/client_golang v1.11.0 github.com/prometheus/procfs v0.7.1 // indirect github.com/satori/go.uuid v1.2.0 github.com/spf13/cobra v1.1.1 diff --git a/go.sum b/go.sum index 0b04cce7..b3e3cfa8 100644 --- a/go.sum +++ b/go.sum @@ -61,7 +61,10 @@ github.com/RichardKnop/logging v0.0.0-20190827224416-1a693bdd4fae/go.mod h1:rJJ8 github.com/Shopify/goreferrer v0.0.0-20181106222321-ec9c9a553398/go.mod h1:a1uqRtAwp2Xwc6WNPJEufxJ7fx3npB4UV/JOLmbu5I0= github.com/ajg/form v1.5.1/go.mod h1:uL1WgH+h2mgNtvBq0339dVnzXdBETtL2LeUXaIv25UY= github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= +github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= +github.com/alecthomas/units v0.0.0-20190717042225-c3de453c63f4/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= +github.com/alecthomas/units v0.0.0-20190924025748-f65c72e2690d/go.mod h1:rBZYJk541a8SKzHPHnH3zbiI+7dagKZ0cgpgrD7Fyho= github.com/andybalholm/cascadia v1.1.0/go.mod h1:GsXiBklL0woXo1j/WYWtSYYC4ouU9PqHO0sqidkEA4Y= github.com/armon/circbuf v0.0.0-20150827004946-bbbad097214e/go.mod h1:3U/XgcO3hCbHZ8TKRvWD2dDTCfh9M9ya+I9JpbB7O8o= github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8= @@ -80,6 +83,8 @@ github.com/aws/aws-sdk-go v1.37.16/go.mod h1:hcU610XS61/+aQV88ixoOzUoG7v3b31pl2z github.com/aymerick/raymond v2.0.3-0.20180322193309-b565731e1464+incompatible/go.mod h1:osfaiScAUVup+UC9Nfq76eWqDhXlp+4UYaA8uhTBO6g= github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q= github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8= +github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM= +github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw= github.com/bgentry/speakeasy v0.1.0/go.mod h1:+zsyZBPWlz7T6j88CTgSN5bM796AkVf0kBD4zp0CCIs= github.com/bketelsen/crypt v0.0.3-0.20200106085610-5cbc8cc4026c/go.mod h1:MKsuJmJgSg28kpZDP6UIiPt0e0Oz0kqKNGyRaWEPv84= github.com/bradfitz/gomemcache v0.0.0-20190913173617-a41fca850d0b h1:L/QXpzIa3pOvUGt1D1lA5KjYhPBAN/3iWdP7xeFS9F0= @@ -164,8 +169,10 @@ github.com/go-gl/glfw/v3.3/glfw v0.0.0-20191125211704-12ad95a8df72/go.mod h1:tQ2 github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8= github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as= github.com/go-kit/kit v0.9.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as= +github.com/go-kit/log v0.1.0/go.mod h1:zbhenjAZHb184qTLMA9ZjW7ThYL0H2mk7Q6pNt4vbaY= github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE= github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk= +github.com/go-logfmt/logfmt v0.5.0/go.mod h1:wCYkCAKZfumFQihp8CzCvQ3paCTfi41vtzG1KdI/P7A= github.com/go-martini/martini v0.0.0-20170121215854-22fa46961aab/go.mod h1:/P9AEU963A2AYjv4d1V5eVL1CQbEJq6aCNHDDjibzu8= github.com/go-openapi/analysis v0.0.0-20180825180245-b006789cd277/go.mod h1:k70tL6pCuVxPJOHXQ+wIac1FUrvNkHolPie/cLEU6hI= github.com/go-openapi/analysis v0.17.0/go.mod h1:IowGgpVeD0vNm45So8nr+IcQ3pxVtpRoBWb8PVZO0ik= @@ -325,8 +332,9 @@ github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/ github.com/google/go-cmp v0.5.1/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.3/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= -github.com/google/go-cmp v0.5.4 h1:L8R9j+yAqZuZjsqh/z+F1NCffTKKLShY6zXTItVIZ8M= github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU= +github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck= github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= github.com/google/martian v2.1.0+incompatible/go.mod h1:9I4somxYTbIHy5NJKHRl3wXiIaQGbYVAs8BPL6v8lEs= @@ -453,15 +461,18 @@ github.com/joeshaw/multierror v0.0.0-20140124173710-69b34d4ec901 h1:rp+c0RAYOWj8 github.com/joeshaw/multierror v0.0.0-20140124173710-69b34d4ec901/go.mod h1:Z86h9688Y0wesXCyonoVr47MasHilkuLMqGhRZ4Hpak= github.com/joho/godotenv v1.3.0/go.mod h1:7hK45KPybAkOC6peb+G5yklZfMxEjkZhHbwpqxOKXbg= github.com/jonboulle/clockwork v0.1.0/go.mod h1:Ii8DK3G1RaLaWxj9trq07+26W01tbo22gdxWY5EU2bo= +github.com/jpillora/backoff v1.0.0/go.mod h1:J/6gKK9jxlEcS3zixgDgUAsiuZ7yrSoa/FX5e0EB2j4= github.com/json-iterator/go v1.1.6/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU= github.com/json-iterator/go v1.1.9/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4= github.com/json-iterator/go v1.1.10/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4= +github.com/json-iterator/go v1.1.11/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4= github.com/jstemmer/go-junit-report v0.0.0-20190106144839-af01ea7f8024/go.mod h1:6v2b51hI/fHJwM22ozAgKL4VKDeJcHhJFhtBdhmNjmU= github.com/jstemmer/go-junit-report v0.9.1 h1:6QPYqodiu3GuPL+7mfx+NwDdp2eTkp9IfEUpgAwUN0o= github.com/jstemmer/go-junit-report v0.9.1/go.mod h1:Brl9GWCQeLvo8nXZwPNNblvFj/XSXhF0NWZEnDohbsk= github.com/jtolds/gls v4.20.0+incompatible h1:xdiiI2gbIgH/gLH7ADydsJ1uDOEzR8yvV7C0MuV77Wo= github.com/jtolds/gls v4.20.0+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU= github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7VTCxuUUipMqKk8s4w= +github.com/julienschmidt/httprouter v1.3.0/go.mod h1:JR6WtHb+2LUe8TCKY3cZOxFyyO8IZAc4RVcycCCAKdM= github.com/k0kubun/colorstring v0.0.0-20150214042306-9440f1994b88/go.mod h1:3w7q1U84EfirKl04SVQ/s7nPm1ZPhiXd34z40TNz36k= github.com/karrick/godirwalk v1.8.0/go.mod h1:H5KPZjojv4lE+QYImBI8xVtrBRgYrIVsaRPx4tDPEn4= github.com/karrick/godirwalk v1.10.3/go.mod h1:RoGL9dQei4vP9ilrpETWE8CLOZ1kiN0LhBygSwrAsHA= @@ -483,6 +494,7 @@ github.com/klauspost/compress v1.11.7/go.mod h1:aoV0uJVorq1K+umq18yTdKaF57EivdYs github.com/klauspost/cpuid v1.2.1/go.mod h1:Pj4uuM528wm8OyEC2QMXAi2YiTZ96dNQPGgoMS4s3ek= github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= github.com/konsorten/go-windows-terminal-sequences v1.0.2/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= +github.com/konsorten/go-windows-terminal-sequences v1.0.3/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc= github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= @@ -532,6 +544,7 @@ github.com/mattn/go-sqlite3 v1.14.1/go.mod h1:JIl7NbARA7phWnGvh0LKTyg7S9BA+6gx71 github.com/mattn/go-sqlite3 v1.14.6 h1:dNPt6NO46WmLVt2DLNpwczCmdV5boIZ6g/tlDrlRUbg= github.com/mattn/go-sqlite3 v1.14.6/go.mod h1:NyWgC/yNuGj7Q9rpYnZvas74GogHl5/Z4A/KQRfk6bU= github.com/mattn/goveralls v0.0.2/go.mod h1:8d1ZMHsd7fW6IRPKQh46F2WRpyib5/X4FOpevwGNQEw= +github.com/matttproud/golang_protobuf_extensions v1.0.1 h1:4hp9jkHxhMHkqkrB3Ix0jegS5sx/RkqARlsWZ6pIwiU= github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0= github.com/mediocregopher/radix/v3 v3.4.2/go.mod h1:8FL3F6UQRXHXIBSPUs5h0RybMF8i4n7wVopoX3x7Bv8= github.com/microcosm-cc/bluemonday v1.0.2/go.mod h1:iVP4YcDBq+n/5fb23BhYFvIMq/leAFZyRl6bYmGDlGc= @@ -555,6 +568,7 @@ github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3Rllmb github.com/montanaflynn/stats v0.0.0-20171201202039-1bf9dbcd8cbe/go.mod h1:wL8QJuTMNUDYhXwkmfOly8iTdp5TEcJFWZD2D7SIkUc= github.com/moul/http2curl v1.0.0/go.mod h1:8UbvGypXm98wA/IqH45anm5Y2Z6ep6O31QGOAZ3H0fQ= github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= +github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= github.com/nats-io/jwt v0.3.0/go.mod h1:fRYCDE99xlTsqUzISS1Bi75UBJ6ljOJQOAAu5VglpSg= github.com/nats-io/nats.go v1.9.1/go.mod h1:ZjDU1L/7fJ09jvUSRVBR2e7+RnLiiIQyqyzEE/Zbp4w= github.com/nats-io/nkeys v0.1.0/go.mod h1:xpnFELMwJABBLVhffcfd1MZx6VsNRFpEugbxziKVo7w= @@ -600,15 +614,28 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN github.com/posener/complete v1.1.1/go.mod h1:em0nMJCgc9GFtwrmVmEMR/ZL6WyhyjMBndrE9hABlRI= github.com/prometheus/client_golang v0.9.1/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw= github.com/prometheus/client_golang v0.9.3/go.mod h1:/TN21ttK/J9q6uSwhBd54HahCDft0ttaMvbicHlPoso= +github.com/prometheus/client_golang v1.0.0/go.mod h1:db9x61etRT2tGnBNRi70OPL5FsnadC4Ky3P0J6CfImo= +github.com/prometheus/client_golang v1.7.1/go.mod h1:PY5Wy2awLA44sXw4AOSfFBetzPP4j5+D6mVACh+pe2M= +github.com/prometheus/client_golang v1.11.0 h1:HNkLOAEQMIDv/K+04rukrLx6ch7msSRwf3/SASFAGtQ= +github.com/prometheus/client_golang v1.11.0/go.mod h1:Z6t4BnS23TR94PD6BsDNk8yVqroYurpAkEiz0P2BEV0= github.com/prometheus/client_model v0.0.0-20180712105110-5c3871d89910/go.mod h1:MbSGuTsp3dbXC40dX6PRTWyKYBIrTGTE9sqQNg2J8bo= github.com/prometheus/client_model v0.0.0-20190129233127-fd36f4220a90/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= +github.com/prometheus/client_model v0.2.0 h1:uq5h0d+GuxiXLJLNABMgp2qUWDPiLvgCzz2dUR+/W/M= +github.com/prometheus/client_model v0.2.0/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= github.com/prometheus/common v0.0.0-20181113130724-41aa239b4cce/go.mod h1:daVV7qP5qjZbuso7PdcryaAu0sAZbrN9i7WWcTMWvro= github.com/prometheus/common v0.4.0/go.mod h1:TNfzLD0ON7rHzMJeJkieUDPYmFC7Snx/y86RQel1bk4= +github.com/prometheus/common v0.4.1/go.mod h1:TNfzLD0ON7rHzMJeJkieUDPYmFC7Snx/y86RQel1bk4= +github.com/prometheus/common v0.10.0/go.mod h1:Tlit/dnDKsSWFlCLTWaA1cyBgKHSMdTB80sz/V91rCo= +github.com/prometheus/common v0.26.0 h1:iMAkS2TDoNWnKM+Kopnx/8tnEStIfpYA0ur0xQzzhMQ= +github.com/prometheus/common v0.26.0/go.mod h1:M7rCNAaPfAosfx8veZJCuw84e35h3Cfd9VFqTh1DIvc= github.com/prometheus/procfs v0.0.0-20181005140218-185b4288413d/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk= github.com/prometheus/procfs v0.0.0-20190425082905-87a4384529e0/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA= github.com/prometheus/procfs v0.0.0-20190507164030-5867b95ac084/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA= +github.com/prometheus/procfs v0.0.2/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA= github.com/prometheus/procfs v0.0.3/go.mod h1:4A/X28fw3Fc593LaREMrKMqOKvUAntwMDaekg4FpcdQ= +github.com/prometheus/procfs v0.1.3/go.mod h1:lV6e/gmhEcM9IjHGsFOCxxuZ+z1YqCvr4OA4YeYWdaU= +github.com/prometheus/procfs v0.6.0/go.mod h1:cz+aTbrPOrUb4q7XlbU9ygM+/jj0fzG6c1xBZuNvfVA= github.com/prometheus/procfs v0.7.1 h1:TlEtJq5GvGqMykEwWzbZWjjztF86swFhsPix1i0bkgA= github.com/prometheus/procfs v0.7.1/go.mod h1:cz+aTbrPOrUb4q7XlbU9ygM+/jj0fzG6c1xBZuNvfVA= github.com/prometheus/tsdb v0.7.1/go.mod h1:qhTCs0VvXwvX/y3TZrWD7rabWM+ijKTux40TwIPHuXU= @@ -646,6 +673,7 @@ github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPx github.com/sirupsen/logrus v1.4.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo= github.com/sirupsen/logrus v1.4.1/go.mod h1:ni0Sbl8bgC9z8RoU9G6nDWqqs/fq4eDPysMBDgk/93Q= github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE= +github.com/sirupsen/logrus v1.6.0/go.mod h1:7uNnSEd1DgxDLC74fIahvMZmmYsHGZGEOFrfsX/uA88= github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d h1:zE9ykElWQ6/NYmHa3jpm/yHnI4xSofP+UP6SpjHcSeM= github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc= github.com/smartystreets/goconvey v1.6.4 h1:fv0U8FUIMPNf1L9lnHLvLhgicrIVChEkdzIKYqbNC9s= @@ -939,6 +967,7 @@ golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20191120155948-bd437916bb0e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191204072324-ce4227a45e2e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191228213918-04cbcbbfeed8/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200106162015-b016eb3dc98e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200113162924-86b910548bc1/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200122134326-e047566fdf82/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= @@ -955,6 +984,7 @@ golang.org/x/sys v0.0.0-20200515095857-1151b9dac4a9/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20200519105757-fe76b779f299/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200523222454-059865788121/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200615200032-f1bc736245b1/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200625212154-ddb9806d33ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200803210538-64077c9b5642/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200905004654-be1d3432aa8f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= @@ -966,6 +996,7 @@ golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210603081109-ebe580a85c40/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK8p3i2/krTr0H1rg74I= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw= @@ -1158,8 +1189,9 @@ google.golang.org/protobuf v1.22.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2 google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= google.golang.org/protobuf v1.23.1-0.20200526195155-81db48ad09cc/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= google.golang.org/protobuf v1.24.0/go.mod h1:r/3tXBNzIEhYS9I1OUVjXDlt8tc493IdKGjtUeSXeh4= -google.golang.org/protobuf v1.25.0 h1:Ejskq+SyPohKW+1uil0JJMtmHCgJPJ/qWTxr8qp+R4c= google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlbajtzgsN7c= +google.golang.org/protobuf v1.26.0-rc.1 h1:7QnIQpGRHE5RnLKnESfDoxm2dTapTZua5a0kS0A+VXQ= +google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= @@ -1182,6 +1214,7 @@ gopkg.in/yaml.v2 v2.0.0-20170812160011-eb3733d160e7/go.mod h1:JAlM8MvJe8wmxCU4Bl gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.5/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.2.7/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= From 863be2ba4a84ef7a60d0f7b25b7282490f514967 Mon Sep 17 00:00:00 2001 From: Neng Wan Date: Thu, 21 Oct 2021 15:39:20 +0800 Subject: [PATCH 2/4] trigger changes --- extensions/cachext/ext.go | 1 + 1 file changed, 1 insertion(+) diff --git a/extensions/cachext/ext.go b/extensions/cachext/ext.go index 89f1a213..7bc25c2a 100644 --- a/extensions/cachext/ext.go +++ b/extensions/cachext/ext.go @@ -12,6 +12,7 @@ import ( "github.com/shanbay/gobay" "github.com/spf13/viper" "github.com/vmihailenco/msgpack" + "github.com/prometheus/client_golang/prometheus" "github.com/prometheus/client_golang/prometheus/promauto" ) From 782d49d33539ef60ffc5b08e6c9d52c5109f9292 Mon Sep 17 00:00:00 2001 From: Neng Wan Date: Thu, 21 Oct 2021 18:58:56 +0800 Subject: [PATCH 3/4] hit when not nil --- extensions/cachext/cached.go | 8 +++---- extensions/cachext/ext.go | 45 ++++++++++++++++++------------------ 2 files changed, 26 insertions(+), 27 deletions(-) diff --git a/extensions/cachext/cached.go b/extensions/cachext/cached.go index 0fa5ab6f..0eda4df5 100644 --- a/extensions/cachext/cached.go +++ b/extensions/cachext/cached.go @@ -68,14 +68,14 @@ func (c *CachedConfig) GetResult(ctx context.Context, out interface{}, strArgs [ c.cache.requestCounter.With(labels).Inc() } if data != nil { - if c.cache.hitCounter != nil { - // Increment hit counter. - c.cache.hitCounter.With(labels).Inc() - } if c.cacheNil && decodeIsNil(data) { // 无法直接把out设置为nil，这里通过返回特殊的错误来表示nil。调用方需要判断 return Nil } + if c.cache.hitCounter != nil { + // Increment hit counter. + c.cache.hitCounter.With(labels).Inc() + } return decode(data, out) } res, err := c.getResult(ctx, strArgs, intArgs) diff --git a/extensions/cachext/ext.go b/extensions/cachext/ext.go index 7bc25c2a..c2152983 100644 --- a/extensions/cachext/ext.go +++ b/extensions/cachext/ext.go @@ -12,7 +12,6 @@ import ( "github.com/shanbay/gobay" "github.com/spf13/viper" "github.com/vmihailenco/msgpack" - "github.com/prometheus/client_golang/prometheus" "github.com/prometheus/client_golang/prometheus/promauto" ) @@ -44,28 +43,6 @@ const ( var cacheLabels = []string{prefixName, funcName} -// Create a collector for total cache request counter -func initCacheRequestCounter() *prometheus.CounterVec { - return promauto.NewCounterVec( - prometheus.CounterOpts{ - Name: "cache_request_counter", - Help: "Number of cache requests", - }, - cacheLabels, - ) -} - -// Create a collector for cache hit counter -func initCacheHitCounter() *prometheus.CounterVec { - return promauto.NewCounterVec( - prometheus.CounterOpts{ - Name: "cache_hit_counter", - Help: "Number of cache hits", - }, - cacheLabels, - ) -} - // CacheBackend type CacheBackend interface { Init(*viper.Viper) error @@ -278,3 +255,25 @@ func decodeIsNil(data interface{}) bool { } return false } + +// Create a collector for total cache request counter +func initCacheRequestCounter() *prometheus.CounterVec { + return promauto.NewCounterVec( + prometheus.CounterOpts{ + Name: "cache_request_counter", + Help: "Number of cache requests", + }, + cacheLabels, + ) +} + +// Create a collector for cache hit counter +func initCacheHitCounter() *prometheus.CounterVec { + return promauto.NewCounterVec( + prometheus.CounterOpts{ + Name: "cache_hit_counter", + Help: "Number of cache hits", + }, + cacheLabels, + ) +} From b240aea9aff394d7b396ddca95c0980772224ea7 Mon Sep 17 00:00:00 2001 From: Neng Wan Date: Mon, 25 Oct 2021 16:42:16 +0800 Subject: [PATCH 4/4] add test cases --- extensions/cachext/cached.go | 8 ++--- extensions/cachext/ext.go | 8 ++--- extensions/cachext/ext_test.go | 55 ++++++++++++++++++++++++++++++++++ testdata/config.yaml | 3 ++ 4 files changed, 66 insertions(+), 8 deletions(-) diff --git a/extensions/cachext/cached.go b/extensions/cachext/cached.go index 0eda4df5..0fa5ab6f 100644 --- a/extensions/cachext/cached.go +++ b/extensions/cachext/cached.go @@ -68,14 +68,14 @@ func (c *CachedConfig) GetResult(ctx context.Context, out interface{}, strArgs [ c.cache.requestCounter.With(labels).Inc() } if data != nil { - if c.cacheNil && decodeIsNil(data) { - // 无法直接把out设置为nil，这里通过返回特殊的错误来表示nil。调用方需要判断 - return Nil - } if c.cache.hitCounter != nil { // Increment hit counter. c.cache.hitCounter.With(labels).Inc() } + if c.cacheNil && decodeIsNil(data) { + // 无法直接把out设置为nil，这里通过返回特殊的错误来表示nil。调用方需要判断 + return Nil + } return decode(data, out) } res, err := c.getResult(ctx, strArgs, intArgs) diff --git a/extensions/cachext/ext.go b/extensions/cachext/ext.go index c2152983..7a374abe 100644 --- a/extensions/cachext/ext.go +++ b/extensions/cachext/ext.go @@ -85,8 +85,8 @@ func (c *CacheExt) Init(app *gobay.Application) error { return errors.New("No backend found for cache_backend:" + backendConfig) } if config.GetBool("monitor_enable") { - c.requestCounter = initCacheRequestCounter() - c.hitCounter = initCacheHitCounter() + c.requestCounter = newCacheRequestCounter() + c.hitCounter = newCacheHitCounter() } c.initialized = true @@ -257,7 +257,7 @@ func decodeIsNil(data interface{}) bool { } // Create a collector for total cache request counter -func initCacheRequestCounter() *prometheus.CounterVec { +func newCacheRequestCounter() *prometheus.CounterVec { return promauto.NewCounterVec( prometheus.CounterOpts{ Name: "cache_request_counter", @@ -268,7 +268,7 @@ func initCacheRequestCounter() *prometheus.CounterVec { } // Create a collector for cache hit counter -func initCacheHitCounter() *prometheus.CounterVec { +func newCacheHitCounter() *prometheus.CounterVec { return promauto.NewCounterVec( prometheus.CounterOpts{ Name: "cache_hit_counter", diff --git a/extensions/cachext/ext_test.go b/extensions/cachext/ext_test.go index 1ca396bd..5eaf265a 100644 --- a/extensions/cachext/ext_test.go +++ b/extensions/cachext/ext_test.go @@ -3,13 +3,19 @@ package cachext_test import ( "context" "fmt" + "io/ioutil" + "log" "strings" "testing" "time" + "net/http" + + "github.com/prometheus/client_golang/prometheus/promhttp" "github.com/shanbay/gobay" "github.com/shanbay/gobay/extensions/cachext" _ "github.com/shanbay/gobay/extensions/cachext/backend/memory" + "github.com/stretchr/testify/assert" ) func ExampleCacheExt_Set() { @@ -577,3 +583,52 @@ func Benchmark_Cached(b *testing.B) { } } } + +func TestCacheExt_Cached_Monitor(t *testing.T) { + // 准备数据 + cache := &cachext.CacheExt{NS: "cache_"} + exts := map[gobay.Key]gobay.Extension{ + "cache": cache, + } + _, err := gobay.CreateApp("../../testdata/", "cachemonitored", exts) + assert.Nil(t, err) + + fetchMetricData := func() string { + resp, err := http.Get("http://localhost:2112/metrics") + if err != nil { + t.Error(err) + } + defer resp.Body.Close() + rawData, err := ioutil.ReadAll(resp.Body) + if err != nil { + t.Error(err) + } + return string(rawData) + } + + go func() { + http.Handle("/metrics", promhttp.Handler()) + if err := http.ListenAndServe(":2112", nil); err != nil { + log.Fatalf("error when start prometheus server: %v\n", err) + } + }() + + // Cache method + f_str := func(_ context.Context, keys []string, args []int64) (interface{}, error) { + return keys[0], nil + } + c_f_str := cache.Cached("f_str", f_str, cachext.WithTTL(10*time.Second)) + str := "" + + // Get result from function + c_f_str.GetResult(context.Background(), &str, []string{"hello"}, []int64{}) + data := fetchMetricData() + assert.Contains(t, data, `cache_request_counter{func_name="f_str",prefix_name="github"} 1`) + assert.NotContains(t, data, `cache_hit_counter`) + + // Get result from cache + c_f_str.GetResult(context.Background(), &str, []string{"hello"}, []int64{}) + data = fetchMetricData() + assert.Contains(t, data, `cache_request_counter{func_name="f_str",prefix_name="github"} 2`) + assert.Contains(t, data, `cache_hit_counter{func_name="f_str",prefix_name="github"} 1`) +} diff --git a/testdata/config.yaml b/testdata/config.yaml index c877f4c9..56752b4b 100644 --- a/testdata/config.yaml +++ b/testdata/config.yaml @@ -76,6 +76,9 @@ grpcnoretry: grpcmocked: <<: *defaults stub_health_mocked: true +cachemonitored: + <<: *defaults + cache_monitor_enable: true development: <<: *defaults production: