Compare commits

..

No commits in common. "master" and "v1.0.4" have entirely different histories.

5 changed files with 29 additions and 166 deletions

48
api.go
View File

@ -1,7 +1,6 @@
package api
import (
"fmt"
"reflect"
"github.com/gin-gonic/gin"
@ -13,7 +12,7 @@ import (
var (
validate = validator.New()
requestLogidGetter = defaultLogidGetter
requestHandlerMapper = map[string]gin.HandlerFunc{}
requestHandlerMapper = map[string]Handler{}
errCodeUnknownError = -10000
errCodeParameterError = -20000
errCodeUnimplementApi = -20401
@ -38,12 +37,9 @@ type BaseWithErrCodeOutput struct {
ErrMsg string `json:"errMsg"`
}
func NewEngine(pre ...gin.HandlerFunc) *Engine {
func NewEngine() *Engine {
gin.SetMode(gin.ReleaseMode)
e := gin.New()
for _, m := range pre {
e.Use(m)
}
e.Use(middlewareMyApiEngine())
return &Engine{e}
}
@ -54,16 +50,10 @@ func (e *Engine) POST(uri string, handler Handler) {
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
func handlerWrapper(handler Handler) gin.HandlerFunc {
handlerFunc := handler.HandlerFunc()
wrappedHandlerFunc := func(c *gin.Context) {
return func(c *gin.Context) {
// Case 1. get request handler
if c.Request == nil && c.Keys != nil {
c.Keys["handler"] = handler
@ -85,9 +75,6 @@ func handlerWrapper(handler Handler) gin.HandlerFunc {
return
}
}
hkey := fmt.Sprintf("%v", wrappedHandlerFunc)
requestHandlerMapper[hkey] = wrappedHandlerFunc
return wrappedHandlerFunc
}
// handlerWrapper
@ -124,9 +111,6 @@ func middlewareMyApiEngine() gin.HandlerFunc {
// Step 3. do request
c.Next()
// Step 4. recorde metrics
cc.recordMetrics()
}
}
@ -154,32 +138,12 @@ func CC(c *gin.Context) *Context {
}
func ApiHandler(c *gin.Context) Handler {
h := c.Handler()
hkey := fmt.Sprintf("%v", h)
if _, ok := requestHandlerMapper[hkey]; !ok {
return nil
}
newc := &gin.Context{
Request: nil,
Keys: map[string]any{},
}
h(newc)
newc := &gin.Context{Request: nil, Keys: map[string]any{}}
c.Handler()(newc)
return newc.Keys["handler"].(Handler)
}
func RecordMetrics(api, errcode, appid string, costms float64) {
var (
counter = metricApiCounter.WithLabelValues(api, errcode, appid)
summary = metricApiSummary.WithLabelValues(api, errcode, appid)
)
// Metric 1. api request counter
counter.Inc()
// Metric 2. api request cost/latency
summary.Observe(costms)
}
func DumpHandlerFunc(c *Context) error {
func DumpHandler(c *Context) error {
errmsg := "api not implemented"
errcode := errCodeUnimplementApi
return c.RESULT_ERROR(errcode, errmsg)

View File

@ -120,14 +120,7 @@ func (c *Context) SetCookie(cookie *http.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 {
if c.resultentry == "" {
c.resultentry = "RESULT"
}
var t = reflect.TypeOf(output)
defer func(o *interface{}) {
b, err := json.Marshal(o)
@ -156,6 +149,9 @@ func (c *Context) RESULT(output interface{}) error {
cost := time.Now().Sub(c.starttime).Milliseconds()
noticeStr := fmt.Sprintf("cost: %dms, output: '%s'", cost, string(b))
log.NoticefWithDepth(calldepth, noticeStr)
//// metric ////////////////////////////////////////
c.recordMetric()
}(&output)
if _, ok := t.FieldByName("ErrCode"); !ok {
@ -219,21 +215,24 @@ func (c *Context) shapeOutput(o interface{}) {
return
}
func (c *Context) recordMetrics() {
func (c *Context) recordMetric() {
if metricApiCounter == nil ||
metricApiSummary == nil {
return
}
var h = c.ApiHandler()
if h == nil {
h = unimplementHandler{c.Context}
}
var (
h = c.ApiHandler()
api = h.ApiName()
appid = c.AppId
costus = time.Now().Sub(c.starttime).Microseconds()
costms = float64(costus) / 1000.0
errcode = strconv.Itoa(c.errcode)
counter = metricApiCounter.WithLabelValues(api, errcode, appid)
summary = metricApiSummary.WithLabelValues(api, errcode, appid)
)
RecordMetrics(api, errcode, appid, costms)
// Metric 1. api request counter
counter.Inc()
// Metric 2. api request cost/latency
summary.Observe(costms)
}

View File

@ -1,24 +1,20 @@
package api
import (
"errors"
"fmt"
"net/http"
"strings"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/prometheus/client_golang/prometheus/push"
"qoobing.com/gomod/log"
)
var (
MetricExporterPusher = func() error { return nil }
MetricExporterPusher = func() {}
MetricExporterHandler Handler = nil
MetricRegistry *prometheus.Registry = nil
metricRegistry *prometheus.Registry = nil
metricApiCounter *prometheus.CounterVec = nil
metricApiSummary *prometheus.SummaryVec = nil
instance string = "--unknown--"
)
type metricExporterHandler struct {
@ -37,24 +33,11 @@ func (m *metricExporterHandler) HandlerFunc() HandlerFunc {
}
}
func dumpMetricExporterPusher() error {
return errors.New("not initilized, forgot call 'SetupMetricsExporterPusher'?")
}
func InitMetrics(instanceValue string) {
if instanceValue == "" {
instance = getInstanceIpAddress()
} else if ap := strings.Split(instanceValue, ":"); len(ap) == 2 &&
ap[0] == "0.0.0.0" || ap[0] == "" {
instance = getInstanceIpAddress() + ":" + ap[1]
}
log.Infof("self instance: [%s]", instance)
func InitMetrics() {
metricApiCounter = prometheus.NewCounterVec(
prometheus.CounterOpts{
Name: "api_requests_total",
Help: "How many HTTP requests processed",
//ConstLabels: prometheus.Labels{"instance": instance},
},
[]string{"api", "errcode", "appid"},
)
@ -63,14 +46,12 @@ func InitMetrics(instanceValue string) {
Name: "api_requests_summary",
Help: "The api request summary of cost.",
Objectives: map[float64]float64{0.5: 0.05, 0.9: 0.01, 0.99: 0.001},
//ConstLabels: prometheus.Labels{"instance": instance},
},
[]string{"api", "errcode", "appid"},
)
MetricRegistry = prometheus.NewRegistry()
MetricRegistry.MustRegister(metricApiCounter)
MetricRegistry.MustRegister(metricApiSummary)
metricRegistry = prometheus.NewRegistry()
metricRegistry.MustRegister(metricApiCounter)
metricRegistry.MustRegister(metricApiSummary)
}
func SetupMetricsExporterHandler(apiname string) {
@ -78,10 +59,10 @@ func SetupMetricsExporterHandler(apiname string) {
apiname = "premetheus_metrics_exporter"
}
opt := promhttp.HandlerOpts{Registry: MetricRegistry}
opt := promhttp.HandlerOpts{Registry: metricRegistry}
MetricExporterHandler = &metricExporterHandler{
name: apiname,
promhttpHandler: promhttp.HandlerFor(MetricRegistry, opt),
promhttpHandler: promhttp.HandlerFor(metricRegistry, opt),
}
}
@ -90,13 +71,8 @@ func SetupMetricsExporterPusher(pushgateway string, jobname string) {
jobname = fmt.Sprintf("api-metrics-job-%s", getExeFilename())
}
var pusher = push.
New(pushgateway, jobname).
Grouping("instance", instance).
Gatherer(MetricRegistry)
MetricExporterPusher = func() error {
RecordMetrics("push_metrics_to_prometheus", "0", "selfmonitoring", 1.0)
return pusher.Push()
var pusher = push.New(pushgateway, jobname).Gatherer(metricRegistry)
MetricExporterPusher = func() {
pusher.Push()
}
}

View File

@ -1,12 +1,5 @@
package api
import (
"fmt"
"strings"
"github.com/gin-gonic/gin"
)
// ///////////////////////////////////////////////////////////////////
// IRouter & IRoutes in gin, we redefine it simple
// ///////////////////////////////////////////////////////////////////
@ -47,19 +40,5 @@ type Handler interface {
type HandlerFunc func(*Context) error
type IRoutes interface {
GET(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
}

55
util.go
View File

@ -1,11 +1,8 @@
package api
import (
"fmt"
"net"
"os"
"path/filepath"
"regexp"
)
// getExeFilename
@ -16,55 +13,3 @@ func getExeFilename() string {
}
return logfilename
}
// preferencesMatch
func preferencesMatch(s string, preferences ...string) bool {
for _, pstr := range preferences {
reg := regexp.MustCompile(pstr)
if reg.Match([]byte(s)) {
return true
}
}
return false
}
// getInstanceIpAddress
func getInstanceIpAddress(preferences ...string) string {
addrs, err := net.InterfaceAddrs()
if err != nil {
panic(fmt.Sprintf("getInstanceIpAddress failed: [%s]", err))
}
prefer := func() func(string) bool {
if len(preferences) <= 0 {
return nil
}
return func(ip string) bool {
return preferencesMatch(ip, preferences...)
}
}()
var ipnets = []*net.IPNet{}
for _, address := range addrs {
if ipnet, ok := address.(*net.IPNet); !ok {
continue
} else if ipnet.IP.IsLoopback() {
continue
} else if ipv4 := ipnet.IP.To4(); ipv4 == nil {
continue
} else if prefer == nil {
var n = *ipnet
ipnets = append(ipnets, &n)
continue
} else if prefer != nil && prefer(ipv4.String()) {
return ipv4.String()
}
}
// TODO: sort & return first
if len(ipnets) > 0 {
return ipnets[0].IP.To4().String()
}
panic(fmt.Sprintf("getInstanceIpAddreass failed,"+
"preferences=[%v], ipnets=[%v]", preferences, ipnets))
}