From a669070ffb2fef07818263a86fa88e8fa1595def Mon Sep 17 00:00:00 2001 From: Bo-Yi Wu Date: Thu, 19 Jan 2017 16:56:30 +0800 Subject: [PATCH] feat: support prometheus metric url. (#168) --- config/config.go | 2 + config/config.yml | 1 + config/config_test.go | 7 +++- glide.lock | 90 ++++++++++++++++++++++++------------------- glide.yaml | 4 ++ gorush/metrics.go | 87 +++++++++++++++++++++++++++++++++++++++++ gorush/server.go | 18 ++++++++- gorush/server_test.go | 11 ++++++ gorush/status_test.go | 4 ++ 9 files changed, 180 insertions(+), 44 deletions(-) create mode 100644 gorush/metrics.go diff --git a/config/config.go b/config/config.go index 49557ee..423762b 100644 --- a/config/config.go +++ b/config/config.go @@ -38,6 +38,7 @@ type SectionAPI struct { StatAppURI string `yaml:"stat_app_uri"` ConfigURI string `yaml:"config_uri"` SysStatURI string `yaml:"sys_stat_uri"` + MetricURI string `yaml:"metric_uri"` } // SectionAndroid is sub section of config. @@ -129,6 +130,7 @@ func BuildDefaultPushConf() ConfYaml { conf.API.StatAppURI = "/api/stat/app" conf.API.ConfigURI = "/api/config" conf.API.SysStatURI = "/sys/stats" + conf.API.MetricURI = "/metrics" // Android conf.Android.Enabled = false diff --git a/config/config.yml b/config/config.yml index 6628bd8..aa8eef0 100644 --- a/config/config.yml +++ b/config/config.yml @@ -19,6 +19,7 @@ api: stat_app_uri: "/api/stat/app" config_uri: "/api/config" sys_stat_uri: "/sys/stats" + metric_uri: "/metrics" android: enabled: true diff --git a/config/config_test.go b/config/config_test.go index 5010657..1d51211 100644 --- a/config/config_test.go +++ b/config/config_test.go @@ -1,13 +1,14 @@ package config import ( - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/suite" "io/ioutil" "log" "os" "runtime" "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/suite" ) // Test file is missing @@ -74,6 +75,7 @@ func (suite *ConfigTestSuite) TestValidateConfDefault() { assert.Equal(suite.T(), "/api/stat/app", suite.ConfGorushDefault.API.StatAppURI) assert.Equal(suite.T(), "/api/config", suite.ConfGorushDefault.API.ConfigURI) assert.Equal(suite.T(), "/sys/stats", suite.ConfGorushDefault.API.SysStatURI) + assert.Equal(suite.T(), "/metrics", suite.ConfGorushDefault.API.MetricURI) // Android assert.Equal(suite.T(), false, suite.ConfGorushDefault.Android.Enabled) @@ -129,6 +131,7 @@ func (suite *ConfigTestSuite) TestValidateConf() { assert.Equal(suite.T(), "/api/stat/app", suite.ConfGorush.API.StatAppURI) assert.Equal(suite.T(), "/api/config", suite.ConfGorush.API.ConfigURI) assert.Equal(suite.T(), "/sys/stats", suite.ConfGorush.API.SysStatURI) + assert.Equal(suite.T(), "/metrics", suite.ConfGorush.API.MetricURI) // Android assert.Equal(suite.T(), true, suite.ConfGorush.Android.Enabled) diff --git a/glide.lock b/glide.lock index 821fae6..ece0350 100644 --- a/glide.lock +++ b/glide.lock @@ -1,16 +1,20 @@ -hash: 452014b9f7098fdb075926a6b335fceb1d3673f7b77d85ade9b02bc4b992f879 -updated: 2017-01-01T13:46:07.572629753+08:00 +hash: c60a490412b9aa452b4adf49ae6b15499e8b41256c664b3ad586ae1a3ee0d453 +updated: 2017-01-19T12:06:41.763509116+08:00 imports: - name: github.com/asdine/storm - version: d068dc26a6cc4f53186cf51c298c863444148242 + version: faf2c5d33aa0f572fa56e03de17c87b278b976c6 subpackages: - codec - codec/json - index - internal - q +- name: github.com/beorn7/perks + version: 4c0e84591b9aa9e6dcfdf3e020114cd81f89d5f9 + subpackages: + - quantile - name: github.com/boltdb/bolt - version: acc803f0ced151102ed51bf824f8709ebd6602bc + version: a705895fdad108f053eae7ee011ed94a0541ee13 - name: github.com/emirpasic/gods version: ec46b0116df083cba218abbf72522c6d0c065e4e subpackages: @@ -39,28 +43,49 @@ imports: subpackages: - proto - name: github.com/golang/snappy - version: d9eb7a3d35ec988b8585d4a0068e462c27d28380 + version: 7db9049039a047d955fe8c19b83c8ff5abd765c7 - name: github.com/google/go-gcm version: 190e93b4cedb43562b5bd558eb1a1bbd38695bcd - name: github.com/jpillora/backoff - version: 0496a6c14df020789376f4d4a261273d5ddb36ec + version: f24585d1c70490c0920ab34924f54f726e1416c7 - name: github.com/manucorporat/sse version: ee05b128a739a0fb76c7ebd3ae4810c1de808d6d - name: github.com/mattn/go-isatty version: 3a115632dcd687f9c8cd01679c83a06a0e21c1f3 - name: github.com/mattn/go-xmpp - version: e44d1877bb457f5c3991903e9934a31e55c3a2ad + version: f4550b5399387339df5ce4c3f88c1ef85333bdd5 +- name: github.com/matttproud/golang_protobuf_extensions + version: c12348ce28de40eed0136aa2b644d0ee0650e56c + subpackages: + - pbutil - name: github.com/pborman/uuid - version: c55201b036063326c5b1b89ccfe45a184973d073 + version: 1b00554d822231195d1babd97ff4a781231955c9 +- name: github.com/prometheus/client_golang + version: c5b7fccd204277076155f10851dad72b76a49317 + subpackages: + - prometheus + - prometheus/promhttp +- name: github.com/prometheus/client_model + version: fa8ad6fec33561be4280a8f0514318c79d7f6cb6 + subpackages: + - go +- name: github.com/prometheus/common + version: dd2f054febf4a6c00f2343686efb775948a8bff4 + subpackages: + - expfmt + - internal/bitbucket.org/ww/goautoneg + - model +- name: github.com/prometheus/procfs + version: fcdb11ccb4389efb1b210b7ffb623ab71c5fdd60 - name: github.com/sideshow/apns2 - version: 873d6f531482befe8177997be72eacf61c72d5a2 + version: c23f4b07d9e47aa490ff76001001decc688243f8 subpackages: - certificate - payload - name: github.com/Sirupsen/logrus version: d26492970760ca5d33129d2d799e34be5c4782eb - name: github.com/syndtr/goleveldb - version: 6ae1797c0b42b9323fc27ff7dcf568df88f2f33d + version: 23851d93a2292dcc56e71a18ec9e0624d84a0f65 subpackages: - leveldb - leveldb/cache @@ -75,36 +100,21 @@ imports: - leveldb/table - leveldb/util - name: github.com/thoas/stats - version: 69e3c072eec2df2df41afe6214f62eb940e4cd80 + version: 152b5d051953fdb6e45f14b6826962aadc032324 - name: github.com/tidwall/btree - version: 7ebb98011b36ffcdcf7a5d8062d6e6c651a49560 + version: 9876f1454cf0993a53d74c27196993e345f50dd1 - name: github.com/tidwall/buntdb - version: 912f340175491888fdd33687d7a309921b6c1e49 + version: 74dc10171b7549022c818bd212a9ddea151db02e +- name: github.com/tidwall/gjson + version: e3f249f4fdf33c278edeb770426a6f83c954ae64 +- name: github.com/tidwall/grect + version: ba9a043346eba55344e40d66a5e74cfda3a9d293 +- name: github.com/tidwall/match + version: 173748da739a410c5b0b813b956f89ff94730b4c - name: github.com/tidwall/rtree - version: 1737a7bdeb7e5f8303905c5b385f1eeb0f7272ab - subpackages: - - dims/d1 - - dims/d10 - - dims/d11 - - dims/d12 - - dims/d13 - - dims/d14 - - dims/d15 - - dims/d16 - - dims/d17 - - dims/d18 - - dims/d19 - - dims/d2 - - dims/d20 - - dims/d3 - - dims/d4 - - dims/d5 - - dims/d6 - - dims/d7 - - dims/d8 - - dims/d9 + version: d4a8a3d30d5729f85edfba1745241f3a621d0359 - name: golang.org/x/crypto - version: c2f4947f41766b144bb09066e919466da5eddeae + version: c3b1d0d6d8690eaebe3064711b026770cc37efa3 subpackages: - pkcs12 - pkcs12/internal/rc2 @@ -115,7 +125,7 @@ imports: - http2 - http2/hpack - name: golang.org/x/sys - version: a408501be4d17ee978c04a618e7a1b22af058c0e + version: 8f0908ab3b2457e2e15403d3697c9ef5cb4b57a9 subpackages: - unix - name: gopkg.in/appleboy/gin-status-api.v1 @@ -127,7 +137,7 @@ imports: - name: gopkg.in/go-playground/validator.v8 version: c193cecd124b5cc722d7ee5538e945bdb3348435 - name: gopkg.in/redis.v5 - version: 8fcba2ea878201b70c5a63dd416141d4ddbc601a + version: 8829ddcd8bdb333e477cc845946c4b9b2ef66280 subpackages: - internal - internal/consistenthash @@ -135,10 +145,10 @@ imports: - internal/pool - internal/proto - name: gopkg.in/yaml.v2 - version: a83829b6f1293c91addabc89d0571c246397bbf4 + version: 31c299268d302dd0aa9a0dcf765a3d58971ac83f testImports: - name: github.com/buger/jsonparser - version: 183ade1ac7705adf72585f92410fc0912783217a + version: 8ffcad59d1149936a8d17ba2a9c0f714b47b7069 - name: github.com/davecgh/go-spew version: 5215b55f46b2b919f50a1df0eaa5886afe4e3b3d subpackages: diff --git a/glide.yaml b/glide.yaml index 8e720ee..cd4bc7b 100644 --- a/glide.yaml +++ b/glide.yaml @@ -29,6 +29,10 @@ import: - package: gopkg.in/yaml.v2 - package: gopkg.in/appleboy/gofight.v2 version: ^2.0.0 +- package: github.com/prometheus/client_golang + version: ^0.8.0 + subpackages: + - prometheus testImport: - package: github.com/buger/jsonparser - package: github.com/stretchr/testify diff --git a/gorush/metrics.go b/gorush/metrics.go new file mode 100644 index 0000000..5006500 --- /dev/null +++ b/gorush/metrics.go @@ -0,0 +1,87 @@ +package gorush + +import ( + "github.com/prometheus/client_golang/prometheus" +) + +const namespace = "gorush_" + +// Metrics implements the prometheus.Metrics interface and +// exposes gitea metrics for prometheus +type Metrics struct { + TotalPushCount *prometheus.Desc + IosSuccess *prometheus.Desc + IosError *prometheus.Desc + AndroidSuccess *prometheus.Desc + AndroidError *prometheus.Desc +} + +// NewMetrics returns a new Metrics with all prometheus.Desc initialized +func NewMetrics() Metrics { + + return Metrics{ + TotalPushCount: prometheus.NewDesc( + namespace+"total_push_count", + "Number of push count", + nil, nil, + ), + IosSuccess: prometheus.NewDesc( + namespace+"ios_success", + "Number of iOS success count", + nil, nil, + ), + IosError: prometheus.NewDesc( + namespace+"ios_error", + "Number of iOS fail count", + nil, nil, + ), + AndroidSuccess: prometheus.NewDesc( + namespace+"android_success", + "Number of android success count", + nil, nil, + ), + AndroidError: prometheus.NewDesc( + namespace+"android_fail", + "Number of android fail count", + nil, nil, + ), + } +} + +// Describe returns all possible prometheus.Desc +func (c Metrics) Describe(ch chan<- *prometheus.Desc) { + ch <- c.TotalPushCount + ch <- c.IosSuccess + ch <- c.IosError + ch <- c.AndroidSuccess + ch <- c.AndroidError +} + +// Collect returns the metrics with values +func (c Metrics) Collect(ch chan<- prometheus.Metric) { + ch <- prometheus.MustNewConstMetric( + c.TotalPushCount, + prometheus.GaugeValue, + float64(StatStorage.GetTotalCount()), + ) + ch <- prometheus.MustNewConstMetric( + c.IosSuccess, + prometheus.GaugeValue, + float64(StatStorage.GetIosSuccess()), + ) + ch <- prometheus.MustNewConstMetric( + c.IosError, + prometheus.GaugeValue, + float64(StatStorage.GetIosError()), + ) + ch <- prometheus.MustNewConstMetric( + c.AndroidSuccess, + prometheus.GaugeValue, + float64(StatStorage.GetAndroidSuccess()), + ) + ch <- prometheus.MustNewConstMetric( + c.AndroidError, + prometheus.GaugeValue, + float64(StatStorage.GetAndroidError()), + ) +} diff --git a/gorush/server.go b/gorush/server.go index eccee8f..cb4e218 100644 --- a/gorush/server.go +++ b/gorush/server.go @@ -2,11 +2,20 @@ package gorush import ( "fmt" - "github.com/gin-gonic/gin" - api "gopkg.in/appleboy/gin-status-api.v1" "net/http" + + "github.com/gin-gonic/gin" + "github.com/prometheus/client_golang/prometheus" + "github.com/prometheus/client_golang/prometheus/promhttp" + api "gopkg.in/appleboy/gin-status-api.v1" ) +func init() { + // Support metrics + m := NewMetrics() + prometheus.MustRegister(m) +} + func abortWithError(c *gin.Context, code int, message string) { c.JSON(code, gin.H{ "code": code, @@ -58,6 +67,10 @@ func configHandler(c *gin.Context) { c.YAML(http.StatusCreated, PushConf) } +func metricsHandler(c *gin.Context) { + promhttp.Handler().ServeHTTP(c.Writer, c.Request) +} + func routerEngine() *gin.Engine { // set server mode gin.SetMode(PushConf.Core.Mode) @@ -76,6 +89,7 @@ func routerEngine() *gin.Engine { r.GET(PushConf.API.ConfigURI, configHandler) r.GET(PushConf.API.SysStatURI, sysStatsHandler) r.POST(PushConf.API.PushURI, pushHandler) + r.GET(PushConf.API.MetricURI, metricsHandler) r.GET("/", rootHandler) return r diff --git a/gorush/server_test.go b/gorush/server_test.go index 8a52908..3b24957 100644 --- a/gorush/server_test.go +++ b/gorush/server_test.go @@ -233,3 +233,14 @@ func TestSysStatsHandler(t *testing.T) { assert.Equal(t, http.StatusOK, r.Code) }) } + +func TestMetricsHandler(t *testing.T) { + initTest() + + r := gofight.New() + + r.GET("/metrics"). + Run(routerEngine(), func(r gofight.HTTPResponse, rq gofight.HTTPRequest) { + assert.Equal(t, http.StatusOK, r.Code) + }) +} diff --git a/gorush/status_test.go b/gorush/status_test.go index 1bd560a..ba9f5c8 100644 --- a/gorush/status_test.go +++ b/gorush/status_test.go @@ -2,6 +2,7 @@ package gorush import ( "testing" + "time" "github.com/stretchr/testify/assert" ) @@ -13,6 +14,9 @@ func TestStorageDriverExist(t *testing.T) { } func TestStatForMemoryEngine(t *testing.T) { + // wait android push notification response. + time.Sleep(5 * time.Second) + var val int64 PushConf.Stat.Engine = "memory" InitAppStatus()