perf: 优化日志组件

Author: CodFrm

configs/config.yaml.example

@@ -49,10 +49,12 @@ http:
 # 日志组件配置
 logger:
     level: info
-    logfile:
+    disableConsole: false # 是否禁用控制台输出
+    logFile:
         enable: true
-        errorfilename: ./runtime/logs/cago.err.log
+        errorFilename: ./runtime/logs/cago.err.log
         filename: ./runtime/logs/cago.log
+    # 不推荐该方式, 推荐使用`promtail`来抓取日志
     loki:
         level: info
         url: http://127.0.0.1:3100/loki/api/v1/push

deploy/helm/templates/deployment.yaml

@@ -4,6 +4,8 @@ metadata:
   name: {{ include "cago.fullname" . }}
   labels:
     {{- include "cago.labels" . | nindent 4 }}
+    cago.io/version: {{ .Chart.AppVersion | quote }}
+    cago.io/environment: {{ .Values.appConfig.env | quote }}
 spec:
   {{- if not .Values.autoscaling.enabled }}
   replicas: {{ .Values.replicaCount }}

examples/simple/configs/config.yaml

@@ -23,10 +23,12 @@ http:
         - :8080
 logger:
     level: info
-    logfile:
+    disableConsole: false # 是否禁用控制台输出
+    logFile:
         enable: true
-        errorfilename: ./runtime/logs/cago.err.log
+        errorFilename: ./runtime/logs/cago.err.log
         filename: ./runtime/logs/cago.log
+    # 不推荐该方式, 推荐使用`promtail`来抓取日志
     loki:
         level: info
         url: http://127.0.0.1:3100/loki/api/v1/push

middleware/permission/README.md

@@ -1,5 +1,5 @@
 # 权限控制组件
 
-> 后来并未用上改组件, 未完成
+> 后来并未用上该组件, 未完成
 
 参考了ABAC、Casbin、ladon等，实现了一个简单的权限控制组件。

pkg/logger/global.go

@@ -48,6 +48,14 @@ func Logger(ctx context.Context, config *configs.Config) error {
 			zapcore.Lock(os.Stdout),
 			zapcore.DebugLevel,
 		)))
+	} else {
+		if !cfg.DisableConsole {
+			opts = append(opts, AppendCore(zapcore.NewCore(
+				zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig()),
+				zapcore.Lock(os.Stdout),
+				ToLevel(cfg.Level),
+			)))
+		}
 	}
 	for _, f := range initLogger {
 		o, err := f(ctx, config, cfg)

pkg/logger/logger.go

@@ -9,14 +9,15 @@ import (
 )
 
 type Config struct {
-	Level   string
-	LogFile LogFileConfig
+	Level          string
+	DisableConsole bool          `yaml:"disableConsole"`
+	LogFile        LogFileConfig `yaml:"logFile"`
 }
 
 type LogFileConfig struct {
 	Enable        bool
 	Filename      string
-	ErrorFilename string
+	ErrorFilename string `yaml:"errorFilename"`
 }
 
 func New(opt ...Option) (*zap.Logger, error) {

pkg/logger/loki/README.md

@@ -0,0 +1,45 @@
+# loki
+
+通过API将日志提交到loki, 不推荐该方式, 推荐使用`promtail`来抓取日志
+
+```yaml
+# 日志组件配置
+logger:
+  level: info
+  logfile:
+    enable: true
+    errorfilename: ./runtime/logs/cago.err.log
+    filename: ./runtime/logs/cago.log
+  # 不推荐该方式, 推荐使用`promtail`来抓取日志
+  loki:
+    level: info
+    url: http://127.0.0.1:3100/loki/api/v1/push
+    username: ""
+    password: ""
+```
+
+## k8s helm promtail配置
+
+拉取promtail的helm chart, `scrapeConfigs`添加job
+
+```yaml
+- job_name: cago
+  kubernetes_sd_configs:
+    - role: pod
+  relabel_configs:
+    - source_labels:
+        - __meta_kubernetes_pod_label_app_kubernetes_io_name
+      action: keep
+      regex: cago
+    - source_labels:
+        - __meta_kubernetes_pod_label_app_kubernetes_io_instance
+      regex: ^;*([^;]+)(;.*)?$
+      action: replace
+      target_label: instance
+    - source_labels:
+        - __meta_kubernetes_pod_label_app_kubernetes_io_instance
+      regex: -([^-]+)$
+      action: replace
+      replacement: $1
+      target_label: env
+```

server/mux/router.go

@@ -52,6 +52,16 @@ func (r *Routes) RequestHandle(request interface{}, handlers ...gin.HandlerFunc)
 	return r.requestHandle(requestEl, handlers...)
 }
 
+func Metadata(request interface{}) (string, string) {
+	requestEl := reflect.TypeOf(request)
+	route, ok := requestEl.FieldByName("Meta")
+	// 必须有Route字段
+	if !ok || route.Type != reflect.TypeOf(Meta{}) {
+		panic("invalid method, second parameter must have Meta field")
+	}
+	return route.Tag.Get("path"), route.Tag.Get("method")
+}
+
 func (r *Routes) requestHandle(requestEl reflect.Type, handlers ...gin.HandlerFunc) *Routes {
 	route, ok := requestEl.FieldByName("Meta")
 	// 必须有Route字段