Enable/Disable Features (#1051)

Author: aphralG

internal/collector/otel_collector_plugin.go

@@ -418,6 +418,8 @@ func (oc *Collector) checkForNewReceivers(nginxConfigContext *model.NginxConfigC
 		if tcplogReceiversFound {
 			reloadCollector = true
 		}
+	} else {
+		slog.Debug("NAP logs feature disabled", "enabled_features", oc.config.Features)
 	}
 
 	return reloadCollector

internal/command/command_plugin.go

@@ -104,7 +104,7 @@ func (cp *CommandPlugin) Process(ctx context.Context, msg *bus.Message) {
 
 func (cp *CommandPlugin) processResourceUpdate(ctx context.Context, msg *bus.Message) {
 	if resource, ok := msg.Data.(*mpi.Resource); ok {
-		if !cp.commandService.IsConnected() && cp.config.IsFeatureEnabled(pkgConfig.FeatureConnection) {
+		if !cp.commandService.IsConnected() {
 			cp.createConnection(ctx, resource)
 		} else {
 			statusErr := cp.commandService.UpdateDataPlaneStatus(ctx, resource)
@@ -237,8 +237,8 @@ func (cp *CommandPlugin) handleAPIActionRequest(ctx context.Context, message *mp
 	} else {
 		slog.WarnContext(
 			ctx,
-			"API Action Request feature disabled. Unable to process API action request",
-			"request", message,
+			"API action feature disabled. Unable to process API action request",
+			"request", message, "enabled_features", cp.config.Features,
 		)
 
 		err := cp.commandService.SendDataPlaneResponse(ctx, &mpi.DataPlaneResponse{
@@ -263,7 +263,7 @@ func (cp *CommandPlugin) handleConfigApplyRequest(newCtx context.Context, messag
 		slog.WarnContext(
 			newCtx,
 			"Configuration feature disabled. Unable to process config apply request",
-			"request", message,
+			"request", message, "enabled_features", cp.config.Features,
 		)
 
 		err := cp.commandService.SendDataPlaneResponse(newCtx, &mpi.DataPlaneResponse{
@@ -288,7 +288,7 @@ func (cp *CommandPlugin) handleConfigUploadRequest(newCtx context.Context, messa
 		slog.WarnContext(
 			newCtx,
 			"Configuration feature disabled. Unable to process config upload request",
-			"request", message,
+			"request", message, "enabled_features", cp.config.Features,
 		)
 
 		err := cp.commandService.SendDataPlaneResponse(newCtx, &mpi.DataPlaneResponse{

internal/command/command_plugin_test.go

@@ -204,7 +204,6 @@ func TestCommandPlugin_monitorSubscribeChannel(t *testing.T) {
 			request:       "APIActionRequest",
 			configFeatures: []string{
 				pkg.FeatureConfiguration,
-				pkg.FeatureConnection,
 				pkg.FeatureMetrics,
 				pkg.FeatureFileWatcher,
 				pkg.FeatureAPIAction,
@@ -278,7 +277,6 @@ func TestCommandPlugin_FeatureDisabled(t *testing.T) {
 			expectedLog: "Configuration feature disabled. Unable to process config upload request",
 			request:     "UploadRequest",
 			configFeatures: []string{
-				pkg.FeatureConnection,
 				pkg.FeatureMetrics,
 				pkg.FeatureFileWatcher,
 			},
@@ -293,7 +291,6 @@ func TestCommandPlugin_FeatureDisabled(t *testing.T) {
 			expectedLog: "Configuration feature disabled. Unable to process config apply request",
 			request:     "ApplyRequest",
 			configFeatures: []string{
-				pkg.FeatureConnection,
 				pkg.FeatureMetrics,
 				pkg.FeatureFileWatcher,
 			},

internal/config/config.go

@@ -123,7 +123,6 @@ func ResolveConfig() (*Config, error) {
 	checkCollectorConfiguration(collector, config)
 
 	slog.Debug("Agent config", "config", config)
-	slog.Info("Enabled features", "features", config.Features)
 	slog.Info("Excluded files from being watched for file changes", "exclude_files",
 		config.Watchers.FileWatcher.ExcludeFiles)
 

internal/config/defaults.go

@@ -78,7 +78,7 @@ const (
 func DefaultFeatures() []string {
 	return []string{
 		pkg.FeatureConfiguration,
-		pkg.FeatureConnection,
+		pkg.FeatureCertificates,
 		pkg.FeatureMetrics,
 		pkg.FeatureFileWatcher,
 	}

internal/plugin/plugin_manager.go

@@ -9,6 +9,8 @@ import (
 	"context"
 	"log/slog"
 
+	pkg "github.com/nginx/agent/v3/pkg/config"
+
 	"github.com/nginx/agent/v3/internal/collector"
 	"github.com/nginx/agent/v3/internal/command"
 	"github.com/nginx/agent/v3/internal/file"
@@ -58,6 +60,12 @@ func addCommandAndFilePlugins(ctx context.Context, plugins []bus.Plugin, agentCo
 }
 
 func addCollectorPlugin(ctx context.Context, agentConfig *config.Config, plugins []bus.Plugin) []bus.Plugin {
+	if !agentConfig.IsFeatureEnabled(pkg.FeatureMetrics) {
+		slog.WarnContext(ctx, "Metrics feature disabled, no metrics will be collected",
+			"enabled_features", agentConfig.Features)
+
+		return plugins
+	}
 	if agentConfig.IsACollectorExporterConfigured() {
 		oTelCollector, err := collector.New(agentConfig)
 		if err == nil {

internal/plugin/plugin_manager_test.go

@@ -9,6 +9,8 @@ import (
 	"context"
 	"testing"
 
+	pkg "github.com/nginx/agent/v3/pkg/config"
+
 	"github.com/nginx/agent/v3/internal/collector"
 	"github.com/nginx/agent/v3/internal/command"
 	"github.com/nginx/agent/v3/internal/file"
@@ -35,7 +37,8 @@ func TestLoadPlugins(t *testing.T) {
 				&resource.Resource{},
 				&watcher.Watcher{},
 			},
-		}, {
+		},
+		{
 			name: "Test 2: Load file and command plugins",
 			input: &config.Config{
 				Command: &config.Command{
@@ -53,21 +56,82 @@ func TestLoadPlugins(t *testing.T) {
 				&file.FilePlugin{},
 				&watcher.Watcher{},
 			},
-		}, {
+		},
+		{
 			name: "Test 3: Load metrics collector plugin",
 			input: &config.Config{
 				Collector: &config.Collector{
 					Exporters: config.Exporters{
 						Debug: &config.DebugExporter{},
 					},
 				},
+				Features: config.DefaultFeatures(),
 			},
 			expected: []bus.Plugin{
 				&resource.Resource{},
 				&collector.Collector{},
 				&watcher.Watcher{},
 			},
 		},
+		{
+			name: "Test 4: Metrics collector plugin, feature disabled",
+			input: &config.Config{
+				Command: &config.Command{
+					Server: &config.ServerConfig{
+						Host: "127.0.0.1",
+						Port: 443,
+						Type: config.Grpc,
+					},
+				},
+				Collector: &config.Collector{
+					Exporters: config.Exporters{
+						Debug: &config.DebugExporter{},
+					},
+				},
+				Features: []string{
+					pkg.FeatureConfiguration,
+					pkg.FeatureFileWatcher,
+				},
+			},
+			expected: []bus.Plugin{
+				&resource.Resource{},
+				&command.CommandPlugin{},
+				&file.FilePlugin{},
+				&watcher.Watcher{},
+			},
+		},
+		{
+			name: "Test 5: All features enabled",
+			input: &config.Config{
+				Command: &config.Command{
+					Server: &config.ServerConfig{
+						Host: "127.0.0.1",
+						Port: 443,
+						Type: config.Grpc,
+					},
+				},
+				Collector: &config.Collector{
+					Exporters: config.Exporters{
+						Debug: &config.DebugExporter{},
+					},
+				},
+				Features: []string{
+					pkg.FeatureConfiguration,
+					pkg.FeatureMetrics,
+					pkg.FeatureFileWatcher,
+					pkg.FeatureCertificates,
+					pkg.FeatureAPIAction,
+					pkg.FeatureLogsNap,
+				},
+			},
+			expected: []bus.Plugin{
+				&resource.Resource{},
+				&command.CommandPlugin{},
+				&file.FilePlugin{},
+				&collector.Collector{},
+				&watcher.Watcher{},
+			},
+		},
 	}
 
 	for _, test := range tests {

internal/watcher/instance/nginx_config_parser.go

@@ -20,6 +20,8 @@ import (
 	"strconv"
 	"strings"
 
+	pkg "github.com/nginx/agent/v3/pkg/config"
+
 	mpi "github.com/nginx/agent/v3/api/grpc/mpi/v1"
 	"github.com/nginx/agent/v3/internal/config"
 	"github.com/nginx/agent/v3/internal/model"
@@ -148,14 +150,16 @@ func (ncp *NginxConfigParser) createNginxConfigContext(
 					}
 				case "ssl_certificate", "proxy_ssl_certificate", "ssl_client_certificate",
 					"ssl_trusted_certificate":
-					sslCertFile := ncp.sslCert(ctx, directive.Args[0], rootDir)
-					if sslCertFile != nil {
-						if !ncp.isDuplicateFile(nginxConfigContext.Files, sslCertFile) {
+					if ncp.agentConfig.IsFeatureEnabled(pkg.FeatureCertificates) {
+						sslCertFile := ncp.sslCert(ctx, directive.Args[0], rootDir)
+						if sslCertFile != nil && !ncp.isDuplicateFile(nginxConfigContext.Files, sslCertFile) {
 							slog.DebugContext(ctx, "Adding SSL certificate file", "ssl_cert", sslCertFile)
 							nginxConfigContext.Files = append(nginxConfigContext.Files, sslCertFile)
 						}
+					} else {
+						slog.DebugContext(ctx, "Certificate feature is disabled, skipping cert",
+							"enabled_features", ncp.agentConfig.Features)
 					}
-
 				case "app_protect_security_log":
 					if len(directive.Args) > 1 {
 						syslogArg := directive.Args[1]

internal/watcher/watcher_plugin.go

@@ -102,6 +102,9 @@ func (w *Watcher) Init(ctx context.Context, messagePipe bus.MessagePipeInterface
 
 	if w.agentConfig.IsFeatureEnabled(pkgConfig.FeatureFileWatcher) {
 		go w.fileWatcherService.Watch(watcherContext, w.fileUpdatesChannel)
+	} else {
+		slog.DebugContext(watcherContext, "File watcher feature is disabled",
+			"enabled_features", w.agentConfig.Features)
 	}
 
 	go w.monitorWatchers(watcherContext)

pkg/config/features.go

@@ -6,15 +6,11 @@
 package config
 
 const (
-	FeatureCertificates     = "certificates"
-	FeatureConfiguration    = "configuration"
-	FeatureConnection       = "connection"
-	FeatureMetrics          = "metrics"
-	FeatureMetricsContainer = "metrics-container"
-	FeatureMetricsHost      = "metrics-host"
-	FeatureMetricsInstance  = "metrics-instance"
-	FeatureFileWatcher      = "file-watcher"
-	FeatureAgentAPI         = "agent-api"
-	FeatureAPIAction        = "api-action"
-	FeatureLogsNap          = "logs-nap"
+	FeatureCertificates  = "certificates"
+	FeatureConfiguration = "configuration"
+	FeatureMetrics       = "metrics"
+	FeatureFileWatcher   = "file-watcher"
+	FeatureAPIAction     = "api-action"
+	// FeatureLogsNap experimental feature
+	FeatureLogsNap = "logs-nap"
 )