Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add plugin start log in sdk #1831

Merged
merged 3 commits into from
Mar 3, 2025
Merged

add plugin start log in sdk #1831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb00978
add plugin start log in sdk
rinfx Feb 27, 2025
2ccb678
add plugin name
rinfx Feb 27, 2025
300c8d1
opt
rinfx Feb 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions plugins/wasm-go/pkg/wrapper/log_wrapper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,12 @@ type Log interface {
Errorf(format string, args ...interface{})
Critical(msg string)
Criticalf(format string, args ...interface{})
resetID(pluginID string)
}

type DefaultLog struct {
pluginName string
pluginID string
}

func (l *DefaultLog) log(level LogLevel, msg string) {
Expand All @@ -56,7 +58,7 @@ func (l *DefaultLog) log(level LogLevel, msg string) {
if requestID == "" {
requestID = "nil"
}
msg = fmt.Sprintf("[%s] [%s] %s", l.pluginName, requestID, msg)
msg = fmt.Sprintf("[%s] [%s] [%s] %s", l.pluginName, l.pluginID, requestID, msg)
switch level {
case LogLevelTrace:
proxywasm.LogTrace(msg)
Expand All @@ -79,7 +81,7 @@ func (l *DefaultLog) logFormat(level LogLevel, format string, args ...interface{
if requestID == "" {
requestID = "nil"
}
format = fmt.Sprintf("[%s] [%s] %s", l.pluginName, requestID, format)
format = fmt.Sprintf("[%s] [%s] [%s] %s", l.pluginName, l.pluginID, requestID, format)
switch level {
case LogLevelTrace:
proxywasm.LogTracef(format, args...)
Expand Down Expand Up @@ -143,3 +145,7 @@ func (l *DefaultLog) Critical(msg string) {
func (l *DefaultLog) Criticalf(format string, args ...interface{}) {
l.logFormat(LogLevelCritical, format, args...)
}

func (l *DefaultLog) resetID(pluginID string) {
l.pluginID = pluginID
}
11 changes: 9 additions & 2 deletions plugins/wasm-go/pkg/wrapper/plugin_wrapper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ const (
CustomLogKey = "custom_log"
AILogKey = "ai_log"
TraceSpanTagPrefix = "trace_span_tag."
PluginIDKey = "_plugin_id_"
)

type HttpContext interface {
Expand Down Expand Up @@ -255,7 +256,7 @@ func parseEmptyPluginConfig[PluginConfig any](gjson.Result, *PluginConfig, Log)
}

func NewCommonVmCtx[PluginConfig any](pluginName string, options ...CtxOption[PluginConfig]) *CommonVmCtx[PluginConfig] {
logger := &DefaultLog{pluginName}
logger := &DefaultLog{pluginName, "nil"}
opts := append([]CtxOption[PluginConfig]{WithLogger[PluginConfig](logger)}, options...)
return NewCommonVmCtxWithOptions(pluginName, opts...)
}
Expand Down Expand Up @@ -314,7 +315,10 @@ func (ctx *CommonPluginCtx[PluginConfig]) OnPluginStart(int) types.OnPluginStart
}
jsonData = gjson.ParseBytes(data)
}

pluginID := jsonData.Get(PluginIDKey).String()
if pluginID != "" {
ctx.vm.log.resetID(pluginID)
}
var parseOverrideConfig func(gjson.Result, PluginConfig, *PluginConfig) error
if ctx.vm.parseRuleConfig != nil {
parseOverrideConfig = func(js gjson.Result, global PluginConfig, cfg *PluginConfig) error {
Expand All @@ -329,15 +333,18 @@ func (ctx *CommonPluginCtx[PluginConfig]) OnPluginStart(int) types.OnPluginStart
)
if err != nil {
ctx.vm.log.Warnf("parse rule config failed: %v", err)
ctx.vm.log.Error("plugin start failed")
return types.OnPluginStartStatusFailed
}
if globalOnTickFuncs != nil {
ctx.onTickFuncs = globalOnTickFuncs
if err := proxywasm.SetTickPeriodMilliSeconds(100); err != nil {
ctx.vm.log.Error("SetTickPeriodMilliSeconds failed, onTick functions will not take effect.")
ctx.vm.log.Error("plugin start failed")
return types.OnPluginStartStatusFailed
}
}
ctx.vm.log.Error("plugin start successfully")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里应该是 info 级别的日志哈

return types.OnPluginStartStatusOK
}

Expand Down
Loading