Compare commits

...

7 Commits

Author Message Date
bryanqiu
98eac47127 add AlreadyHaveResult function 2024-02-04 15:34:07 +08:00
bryanqiu
69b0fb05aa add AlreadyHaveResult function 2024-02-04 15:29:11 +08:00
bryanqiu
ba9357e166 add GET 2023-11-24 11:41:57 +08:00
bryanqiu
9df516247c export metricRegistry 2023-05-30 10:46:56 +08:00
bryanqiu
93bdc425e5 add grouping 2023-03-06 11:55:47 +08:00
bryanqiu
426a77f4cf options method buf fixed(record metrics update) 2022-12-22 09:53:14 +08:00
bryanqiu
a098d141c2 add pre middleware 2022-12-21 19:14:14 +08:00
4 changed files with 82 additions and 25 deletions

38
api.go
View File

@ -1,6 +1,7 @@
package api package api
import ( import (
"fmt"
"reflect" "reflect"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
@ -12,7 +13,7 @@ import (
var ( var (
validate = validator.New() validate = validator.New()
requestLogidGetter = defaultLogidGetter requestLogidGetter = defaultLogidGetter
requestHandlerMapper = map[string]Handler{} requestHandlerMapper = map[string]gin.HandlerFunc{}
errCodeUnknownError = -10000 errCodeUnknownError = -10000
errCodeParameterError = -20000 errCodeParameterError = -20000
errCodeUnimplementApi = -20401 errCodeUnimplementApi = -20401
@ -37,9 +38,12 @@ type BaseWithErrCodeOutput struct {
ErrMsg string `json:"errMsg"` ErrMsg string `json:"errMsg"`
} }
func NewEngine() *Engine { func NewEngine(pre ...gin.HandlerFunc) *Engine {
gin.SetMode(gin.ReleaseMode) gin.SetMode(gin.ReleaseMode)
e := gin.New() e := gin.New()
for _, m := range pre {
e.Use(m)
}
e.Use(middlewareMyApiEngine()) e.Use(middlewareMyApiEngine())
return &Engine{e} return &Engine{e}
} }
@ -50,10 +54,16 @@ func (e *Engine) POST(uri string, handler Handler) {
e.Engine.POST(uri, h) e.Engine.POST(uri, h)
} }
func (e *Engine) GET(uri string, handler Handler) {
h := handlerWrapper(handler)
log.Infof("api handler [%v] registor success", handler)
e.Engine.GET(uri, h)
}
// handlerWrapper // handlerWrapper
func handlerWrapper(handler Handler) gin.HandlerFunc { func handlerWrapper(handler Handler) gin.HandlerFunc {
handlerFunc := handler.HandlerFunc() handlerFunc := handler.HandlerFunc()
return func(c *gin.Context) { wrappedHandlerFunc := func(c *gin.Context) {
// Case 1. get request handler // Case 1. get request handler
if c.Request == nil && c.Keys != nil { if c.Request == nil && c.Keys != nil {
c.Keys["handler"] = handler c.Keys["handler"] = handler
@ -75,6 +85,9 @@ func handlerWrapper(handler Handler) gin.HandlerFunc {
return return
} }
} }
hkey := fmt.Sprintf("%v", wrappedHandlerFunc)
requestHandlerMapper[hkey] = wrappedHandlerFunc
return wrappedHandlerFunc
} }
// handlerWrapper // handlerWrapper
@ -112,8 +125,8 @@ func middlewareMyApiEngine() gin.HandlerFunc {
// Step 3. do request // Step 3. do request
c.Next() c.Next()
// Step 4. metrics record // Step 4. recorde metrics
cc.recordMetric() cc.recordMetrics()
} }
} }
@ -141,8 +154,17 @@ func CC(c *gin.Context) *Context {
} }
func ApiHandler(c *gin.Context) Handler { func ApiHandler(c *gin.Context) Handler {
newc := &gin.Context{Request: nil, Keys: map[string]any{}} h := c.Handler()
c.Handler()(newc) hkey := fmt.Sprintf("%v", h)
if _, ok := requestHandlerMapper[hkey]; !ok {
return nil
}
newc := &gin.Context{
Request: nil,
Keys: map[string]any{},
}
h(newc)
return newc.Keys["handler"].(Handler) return newc.Keys["handler"].(Handler)
} }
@ -157,7 +179,7 @@ func RecordMetrics(api, errcode, appid string, costms float64) {
summary.Observe(costms) summary.Observe(costms)
} }
func DumpHandler(c *Context) error { func DumpHandlerFunc(c *Context) error {
errmsg := "api not implemented" errmsg := "api not implemented"
errcode := errCodeUnimplementApi errcode := errCodeUnimplementApi
return c.RESULT_ERROR(errcode, errmsg) return c.RESULT_ERROR(errcode, errmsg)

View File

@ -120,7 +120,14 @@ func (c *Context) SetCookie(cookie *http.Cookie) {
http.SetCookie(c.Writer, cookie) http.SetCookie(c.Writer, cookie)
} }
func (c *Context) AlreadyHaveResult() (done bool, entry string) {
return c.resultentry != "", c.resultentry
}
func (c *Context) RESULT(output interface{}) error { func (c *Context) RESULT(output interface{}) error {
if c.resultentry == "" {
c.resultentry = "RESULT"
}
var t = reflect.TypeOf(output) var t = reflect.TypeOf(output)
defer func(o *interface{}) { defer func(o *interface{}) {
b, err := json.Marshal(o) b, err := json.Marshal(o)
@ -212,13 +219,16 @@ func (c *Context) shapeOutput(o interface{}) {
return return
} }
func (c *Context) recordMetric() { func (c *Context) recordMetrics() {
if metricApiCounter == nil || if metricApiCounter == nil ||
metricApiSummary == nil { metricApiSummary == nil {
return return
} }
var h = c.ApiHandler()
if h == nil {
h = unimplementHandler{c.Context}
}
var ( var (
h = c.ApiHandler()
api = h.ApiName() api = h.ApiName()
appid = c.AppId appid = c.AppId
costus = time.Now().Sub(c.starttime).Microseconds() costus = time.Now().Sub(c.starttime).Microseconds()

View File

@ -15,9 +15,10 @@ import (
var ( var (
MetricExporterPusher = func() error { return nil } MetricExporterPusher = func() error { return nil }
MetricExporterHandler Handler = nil MetricExporterHandler Handler = nil
metricRegistry *prometheus.Registry = nil MetricRegistry *prometheus.Registry = nil
metricApiCounter *prometheus.CounterVec = nil metricApiCounter *prometheus.CounterVec = nil
metricApiSummary *prometheus.SummaryVec = nil metricApiSummary *prometheus.SummaryVec = nil
instance string = "--unknown--"
) )
type metricExporterHandler struct { type metricExporterHandler struct {
@ -41,7 +42,6 @@ func dumpMetricExporterPusher() error {
} }
func InitMetrics(instanceValue string) { func InitMetrics(instanceValue string) {
var instance = instanceValue
if instanceValue == "" { if instanceValue == "" {
instance = getInstanceIpAddress() instance = getInstanceIpAddress()
} else if ap := strings.Split(instanceValue, ":"); len(ap) == 2 && } else if ap := strings.Split(instanceValue, ":"); len(ap) == 2 &&
@ -52,25 +52,25 @@ func InitMetrics(instanceValue string) {
metricApiCounter = prometheus.NewCounterVec( metricApiCounter = prometheus.NewCounterVec(
prometheus.CounterOpts{ prometheus.CounterOpts{
Name: "api_requests_total", Name: "api_requests_total",
Help: "How many HTTP requests processed", Help: "How many HTTP requests processed",
ConstLabels: prometheus.Labels{"instance": instance}, //ConstLabels: prometheus.Labels{"instance": instance},
}, },
[]string{"api", "errcode", "appid"}, []string{"api", "errcode", "appid"},
) )
metricApiSummary = prometheus.NewSummaryVec( metricApiSummary = prometheus.NewSummaryVec(
prometheus.SummaryOpts{ prometheus.SummaryOpts{
Name: "api_requests_summary", Name: "api_requests_summary",
Help: "The api request summary of cost.", Help: "The api request summary of cost.",
Objectives: map[float64]float64{0.5: 0.05, 0.9: 0.01, 0.99: 0.001}, Objectives: map[float64]float64{0.5: 0.05, 0.9: 0.01, 0.99: 0.001},
ConstLabels: prometheus.Labels{"instance": instance}, //ConstLabels: prometheus.Labels{"instance": instance},
}, },
[]string{"api", "errcode", "appid"}, []string{"api", "errcode", "appid"},
) )
metricRegistry = prometheus.NewRegistry() MetricRegistry = prometheus.NewRegistry()
metricRegistry.MustRegister(metricApiCounter) MetricRegistry.MustRegister(metricApiCounter)
metricRegistry.MustRegister(metricApiSummary) MetricRegistry.MustRegister(metricApiSummary)
} }
func SetupMetricsExporterHandler(apiname string) { func SetupMetricsExporterHandler(apiname string) {
@ -78,10 +78,10 @@ func SetupMetricsExporterHandler(apiname string) {
apiname = "premetheus_metrics_exporter" apiname = "premetheus_metrics_exporter"
} }
opt := promhttp.HandlerOpts{Registry: metricRegistry} opt := promhttp.HandlerOpts{Registry: MetricRegistry}
MetricExporterHandler = &metricExporterHandler{ MetricExporterHandler = &metricExporterHandler{
name: apiname, name: apiname,
promhttpHandler: promhttp.HandlerFor(metricRegistry, opt), promhttpHandler: promhttp.HandlerFor(MetricRegistry, opt),
} }
} }
@ -90,7 +90,11 @@ func SetupMetricsExporterPusher(pushgateway string, jobname string) {
jobname = fmt.Sprintf("api-metrics-job-%s", getExeFilename()) jobname = fmt.Sprintf("api-metrics-job-%s", getExeFilename())
} }
var pusher = push.New(pushgateway, jobname).Gatherer(metricRegistry) var pusher = push.
New(pushgateway, jobname).
Grouping("instance", instance).
Gatherer(MetricRegistry)
MetricExporterPusher = func() error { MetricExporterPusher = func() error {
RecordMetrics("push_metrics_to_prometheus", "0", "selfmonitoring", 1.0) RecordMetrics("push_metrics_to_prometheus", "0", "selfmonitoring", 1.0)
return pusher.Push() return pusher.Push()

View File

@ -1,5 +1,12 @@
package api package api
import (
"fmt"
"strings"
"github.com/gin-gonic/gin"
)
// /////////////////////////////////////////////////////////////////// // ///////////////////////////////////////////////////////////////////
// IRouter & IRoutes in gin, we redefine it simple // IRouter & IRoutes in gin, we redefine it simple
// /////////////////////////////////////////////////////////////////// // ///////////////////////////////////////////////////////////////////
@ -40,5 +47,19 @@ type Handler interface {
type HandlerFunc func(*Context) error type HandlerFunc func(*Context) error
type IRoutes interface { type IRoutes interface {
GET(uri string, handler Handler)
POST(uri string, handler Handler) POST(uri string, handler Handler)
} }
type unimplementHandler struct {
c *gin.Context
}
func (u unimplementHandler) ApiName() string {
req := u.c.Request
return strings.ToLower(fmt.Sprintf("[%s]%s", req.Method, req.RequestURI))
}
func (u unimplementHandler) HandlerFunc() HandlerFunc {
return DumpHandlerFunc
}