chore: print error message when sending webhook failed (#770)

* chore: print error message when sending webhook failed

* add param into webhook

* render webhook param as template

* render the webhook param in order

* add syslog support in webhook mock

---------

Co-authored-by: rick <[email protected]>

Author: LinuxSuRen

docs/site/content/zh/latest/tasks/mock.md

@@ -196,4 +196,11 @@ proxies:
 
 当前代理支持 HTTP 和 TCP 协议，上面的例子中代理了 MySQL 的 `33060` 端口。
 
+## Webhook
+
+有些场景下，需要定时向服务器发送请求，这时可以使用 Webhook。当前支持的协议包括：
+
+* HTTP
+* Syslog
+
 > 更多 URL 中通配符的用法，请参考 https://github.com/gorilla/mux

docs/site/content/zh/latest/tasks/mock/webhook-syslog.yaml

@@ -0,0 +1,11 @@
+webhooks:
+  - timer: 3s
+    name: syslog
+    request:
+      protocol: syslog
+      path: 192.168.123.58:5140
+      body: |
+        {
+            "level": "{{ randEnum "FATAL" "ERROR" "WARNING" "INFO" }}",
+            "message": "{{ randAlphaNum 10 }}"
+        }

pkg/mock/in_memory.go

@@ -24,6 +24,7 @@ import (
 	"io"
 	"net"
 	"net/http"
+	"sort"
 	"strings"
 	"sync"
 	"time"
@@ -507,23 +508,57 @@ func (s *inMemoryServer) startWebhook(webhook *Webhook) (err error) {
 }
 
 func runWebhook(ctx context.Context, objCtx interface{}, wh *Webhook) (err error) {
-	client := http.DefaultClient
+	rawParams := make(map[string]string, len(wh.Param))
+	paramKeys := make([]string, 0, len(wh.Param))
+	for k, v := range wh.Param {
+		paramKeys = append(paramKeys, k)
+		rawParams[k] = v
+	}
+	sort.Strings(paramKeys)
+
+	for _, k := range paramKeys {
+		v, vErr := render.Render("mock webhook server param", wh.Param[k], wh)
+		if vErr == nil {
+			wh.Param[k] = v
+		}
+	}
 
 	var payload io.Reader
 	payload, err = render.RenderAsReader("mock webhook server payload", wh.Request.Body, wh)
 	if err != nil {
 		err = fmt.Errorf("error when render payload: %w", err)
 		return
 	}
+	wh.Param = rawParams
 
-	method := util.EmptyThenDefault(wh.Request.Method, http.MethodPost)
 	var api string
 	api, err = render.Render("webhook request api", wh.Request.Path, objCtx)
 	if err != nil {
 		err = fmt.Errorf("error when render api: %w, template: %s", err, wh.Request.Path)
 		return
 	}
 
+	switch wh.Request.Protocol {
+	case "syslog":
+		err = sendSyslogWebhookRequest(ctx, wh, api, payload)
+	default:
+		err = sendHTTPWebhookRequest(ctx, wh, api, payload)
+	}
+	return
+}
+
+func sendSyslogWebhookRequest(ctx context.Context, wh *Webhook, api string, payload io.Reader) (err error) {
+	var conn net.Conn
+	if conn, err = net.Dial("udp", api); err == nil {
+		_, err = io.Copy(conn, payload)
+	}
+	return
+}
+
+func sendHTTPWebhookRequest(ctx context.Context, wh *Webhook, api string, payload io.Reader) (err error) {
+	method := util.EmptyThenDefault(wh.Request.Method, http.MethodPost)
+	client := http.DefaultClient
+
 	var bearerToken string
 	bearerToken, err = getBearerToken(ctx, wh.Request)
 	if err != nil {
@@ -550,7 +585,7 @@ func runWebhook(ctx context.Context, objCtx interface{}, wh *Webhook) (err error
 	memLogger.Info("send webhook request", "api", api)
 	resp, err := client.Do(req)
 	if err != nil {
-		err = fmt.Errorf("error when sending webhook")
+		err = fmt.Errorf("error when sending webhook: %v", err)
 	} else {
 		if resp.StatusCode != http.StatusOK {
 			memLogger.Info("unexpected status", "code", resp.StatusCode)

pkg/mock/types.go

@@ -29,10 +29,11 @@ type Item struct {
 }
 
 type Request struct {
-	Path   string            `yaml:"path" json:"path"`
-	Method string            `yaml:"method" json:"method"`
-	Header map[string]string `yaml:"header" json:"header"`
-	Body   string            `yaml:"body" json:"body"`
+	Protocol string            `yaml:"protocol" json:"protocol"`
+	Path     string            `yaml:"path" json:"path"`
+	Method   string            `yaml:"method" json:"method"`
+	Header   map[string]string `yaml:"header" json:"header"`
+	Body     string            `yaml:"body" json:"body"`
 }
 
 type RequestWithAuth struct {
@@ -51,9 +52,10 @@ type Response struct {
 }
 
 type Webhook struct {
-	Name    string          `yaml:"name" json:"name"`
-	Timer   string          `yaml:"timer" json:"timer"`
-	Request RequestWithAuth `yaml:"request" json:"request"`
+	Name    string            `yaml:"name" json:"name"`
+	Timer   string            `yaml:"timer" json:"timer"`
+	Param   map[string]string `yaml:"param" json:"param"`
+	Request RequestWithAuth   `yaml:"request" json:"request"`
 }
 
 type Proxy struct {