support expose metrics for plugins

Author: wonderflow

api/pkg/filtermanager/config.go

@@ -216,6 +216,12 @@ func (p *FilterManagerConfigParser) Parse(any *anypb.Any, callbacks capi.ConfigC
 
 	for _, proto := range plugins {
 		name := proto.Name
+
+		if registerMetrics := pkgPlugins.LoadMetricsCallback(name); registerMetrics != nil {
+			registerMetrics(callbacks)
+			api.LogInfof("loaded metrics definition for plugin %s", name)
+		}
+
 		if plugin := pkgPlugins.LoadHTTPFilterFactoryAndParser(name); plugin != nil {
 			config, err := plugin.ConfigParser.Parse(proto.Config)
 			if err != nil {

api/pkg/plugins/plugins.go

@@ -20,6 +20,8 @@ import (
 	"errors"
 	"runtime/debug"
 
+	capi "github.com/envoyproxy/envoy/contrib/golang/common/go/api"
+
 	"mosn.io/htnn/api/internal/proto"
 	"mosn.io/htnn/api/pkg/filtermanager/api"
 	"mosn.io/htnn/api/pkg/log"
@@ -31,6 +33,7 @@ var (
 	pluginTypes                = map[string]Plugin{}
 	plugins                    = map[string]Plugin{}
 	httpFilterFactoryAndParser = map[string]*FilterFactoryAndParser{}
+	metricsRegister            = map[string]func(capi.ConfigCallbacks){}
 )
 
 // Here we introduce extra struct to avoid cyclic import between pkg/filtermanager and pkg/plugins
@@ -188,6 +191,24 @@ func (cp *PluginConfigParser) Parse(any interface{}) (res interface{}, err error
 	return conf, nil
 }
 
+func RegisterMetricsCallback(pluginName string, registerMetricFunc func(capi.ConfigCallbacks)) {
+	if registerMetricFunc == nil {
+		panic("registerMetricFunc should not be nil")
+	}
+	if pluginName == "" {
+		panic("pluginName should not be empty")
+	}
+	if _, ok := metricsRegister[pluginName]; ok {
+		logger.Error(errors.New("metrics for plugin already registered, overriding"), "name", pluginName)
+	}
+	metricsRegister[pluginName] = registerMetricFunc
+	logger.Info("registered metrics for plugin", "name", pluginName)
+}
+
+func LoadMetricsCallback(pluginName string) func(capi.ConfigCallbacks) {
+	return metricsRegister[pluginName]
+}
+
 // PluginMethodDefaultImpl provides reasonable implementation for optional methods
 type PluginMethodDefaultImpl struct{}
 

api/pkg/plugins/plugins_test.go

@@ -20,6 +20,7 @@ import (
 	"testing"
 
 	"github.com/agiledragon/gomonkey/v2"
+	capi "github.com/envoyproxy/envoy/contrib/golang/common/go/api"
 	"github.com/stretchr/testify/assert"
 	"google.golang.org/protobuf/types/known/anypb"
 
@@ -285,3 +286,8 @@ func TestRegisterPluginWithType(t *testing.T) {
 	assert.NotNil(t, LoadPlugin("mock"))
 	assert.NotNil(t, LoadPluginType("mock"))
 }
+
+func TestRegisterPluginMetrics(t *testing.T) {
+	RegisterMetricsCallback("mock", func(cc capi.ConfigCallbacks) {})
+	assert.NotNil(t, LoadMetricsCallback("mock"))
+}

api/tests/integration/test_plugins.go

@@ -21,6 +21,8 @@ import (
 	"strconv"
 	"strings"
 
+	capi "github.com/envoyproxy/envoy/contrib/golang/common/go/api"
+
 	"mosn.io/htnn/api/pkg/filtermanager/api"
 	"mosn.io/htnn/api/pkg/plugins"
 )
@@ -200,6 +202,7 @@ func (p *bufferPlugin) Factory() api.FilterFactory {
 type localReplyPlugin struct {
 	plugins.PluginMethodDefaultImpl
 	basePlugin
+	usageCounter capi.CounterMetric
 }
 
 func localReplyFactory(c interface{}, callbacks api.FilterCallbackHandler) api.Filter {
@@ -242,6 +245,9 @@ func (f *localReplyFilter) DecodeRequest(headers api.RequestHeaderMap, buf api.B
 	f.reqHdr = headers
 	f.runFilters = headers.Values("run")
 	if f.config.Decode {
+		if lrp.usageCounter != nil {
+			lrp.usageCounter.Increment(1)
+		}
 		return f.NewLocalResponse("reply", true)
 	}
 	return api.Continue
@@ -309,6 +315,11 @@ func (p *localReplyPlugin) Factory() api.FilterFactory {
 	return localReplyFactory
 }
 
+func (p *localReplyPlugin) MetricsDefinition(c capi.ConfigCallbacks) {
+	p.usageCounter = c.DefineCounterMetric("localreply.usage.counter")
+	// Define more metrics here
+}
+
 type badPlugin struct {
 	plugins.PluginMethodDefaultImpl
 }
@@ -619,10 +630,15 @@ func (f *onLogFilter) OnLog(reqHeaders api.RequestHeaderMap, reqTrailers api.Req
 	api.LogWarnf("receive request trailers: %+v", trailers)
 }
 
+var lrp = &localReplyPlugin{}
+
 func init() {
 	plugins.RegisterPlugin("stream", &streamPlugin{})
 	plugins.RegisterPlugin("buffer", &bufferPlugin{})
-	plugins.RegisterPlugin("localReply", &localReplyPlugin{})
+
+	plugins.RegisterPlugin("localReply", lrp)
+	plugins.RegisterMetricsCallback("localReply", lrp.MetricsDefinition)
+
 	plugins.RegisterPlugin("bad", &badPlugin{})
 	plugins.RegisterPlugin("consumer", &consumerPlugin{})
 	plugins.RegisterPlugin("init", &initPlugin{})