[skip ci] adding Log configuration option to MPI

Author: sean-breen

api/grpc/mpi/v1/command.pb.go

@@ -113,6 +113,18 @@ message UpdateDataPlaneStatusRequest {
 // Respond to a UpdateDataPlaneStatusRequest - intentionally empty
 message UpdateDataPlaneStatusResponse {}
 
+message UpdateNginxAgentConfigurationRequest {
+    // Meta-information associated with a message
+    mpi.v1.MessageMeta message_meta = 1;
+    // the NGINX Agent configuration to update
+    AgentConfig agent_config = 2;
+}
+
+message UpdateNginxAgentConfigurationResponse {
+    // The success or failure of the UpdateNginxAgentConfigurationRequest
+    mpi.v1.CommandResponse response = 1;
+}
+
 message InstanceHealth {
     // Health status enum
     enum InstanceHealthStatus {
@@ -171,6 +183,8 @@ message ManagementPlaneRequest {
         APIActionRequest action_request = 7;
         // triggers a DataPlaneResponse with a command_response for a particular correlation_id
         CommandStatusRequest command_status_request = 8;
+        // triggers an UpdateNginxAgentConfiguration rpc, returning an UpdateNginxAgentConfigurationResponse
+        UpdateNginxAgentConfigurationRequest update_nginx_agent_configuration_request = 9;
     }
 }
 
@@ -387,6 +401,26 @@ message AgentConfig {
     string message_buffer_size = 6;
     // Auxiliary Command server settings
     AuxiliaryCommandServer auxiliary_command = 7;
+    // Log settings
+    Log log = 8;
+}
+
+// The log settings associated with NGINX Agent
+message Log {
+    LogLevel log_level = 1;
+    enum LogLevel {
+        // Unspecified log level
+        LOG_LEVEL_UNSPECIFIED = 0;
+        // Error log level
+        LOG_LEVEL_ERROR = 1;
+        // Warning log level
+        LOG_LEVEL_WARN = 2;
+        // Info log level
+        LOG_LEVEL_INFO = 3;
+        // Debug log level
+        LOG_LEVEL_DEBUG = 4;
+    }
+    string log_path = 2;
 }
 
 // The command server settings, associated with messaging from an external source

api/grpc/mpi/v1/command.pb.validate.go

@@ -67,6 +67,7 @@
     - [InstanceHealth](#mpi-v1-InstanceHealth)
     - [InstanceMeta](#mpi-v1-InstanceMeta)
     - [InstanceRuntime](#mpi-v1-InstanceRuntime)
+    - [Log](#mpi-v1-Log)
     - [ManagementPlaneRequest](#mpi-v1-ManagementPlaneRequest)
     - [MetricsServer](#mpi-v1-MetricsServer)
     - [NGINXAppProtectRuntimeInfo](#mpi-v1-NGINXAppProtectRuntimeInfo)
@@ -81,10 +82,13 @@
     - [UpdateDataPlaneStatusRequest](#mpi-v1-UpdateDataPlaneStatusRequest)
     - [UpdateDataPlaneStatusResponse](#mpi-v1-UpdateDataPlaneStatusResponse)
     - [UpdateHTTPUpstreamServers](#mpi-v1-UpdateHTTPUpstreamServers)
+    - [UpdateNginxAgentConfigurationRequest](#mpi-v1-UpdateNginxAgentConfigurationRequest)
+    - [UpdateNginxAgentConfigurationResponse](#mpi-v1-UpdateNginxAgentConfigurationResponse)
     - [UpdateStreamServers](#mpi-v1-UpdateStreamServers)
 
     - [InstanceHealth.InstanceHealthStatus](#mpi-v1-InstanceHealth-InstanceHealthStatus)
     - [InstanceMeta.InstanceType](#mpi-v1-InstanceMeta-InstanceType)
+    - [Log.LogLevel](#mpi-v1-Log-LogLevel)
 
     - [CommandService](#mpi-v1-CommandService)
 
@@ -718,6 +722,7 @@ This contains a series of NGINX Agent configurations
 | features | [string](#string) | repeated | A list of features that the NGINX Agent has |
 | message_buffer_size | [string](#string) |  | Message buffer size, maximum not acknowledged messages from the subscribe perspective |
 | auxiliary_command | [AuxiliaryCommandServer](#mpi-v1-AuxiliaryCommandServer) |  | Auxiliary Command server settings |
+| log | [Log](#mpi-v1-Log) |  | Log settings |
 
 
 
@@ -1049,6 +1054,22 @@ Meta-information relating to the reported instance
 
 
 
+<a name="mpi-v1-Log"></a>
+
+### Log
+The log settings associated with NGINX Agent
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| log_level | [Log.LogLevel](#mpi-v1-Log-LogLevel) |  |  |
+| log_path | [string](#string) |  |  |
+
+
+
+
+
+
 <a name="mpi-v1-ManagementPlaneRequest"></a>
 
 ### ManagementPlaneRequest
@@ -1064,6 +1085,7 @@ A Management Plane request for information, triggers an associated rpc on the Da
 | config_upload_request | [ConfigUploadRequest](#mpi-v1-ConfigUploadRequest) |  | triggers a series of rpc UpdateFile(File) for that instances |
 | action_request | [APIActionRequest](#mpi-v1-APIActionRequest) |  | triggers a DataPlaneResponse with a command_response for a particular action |
 | command_status_request | [CommandStatusRequest](#mpi-v1-CommandStatusRequest) |  | triggers a DataPlaneResponse with a command_response for a particular correlation_id |
+| update_nginx_agent_configuration_request | [UpdateNginxAgentConfigurationRequest](#mpi-v1-UpdateNginxAgentConfigurationRequest) |  | triggers an UpdateNginxAgentConfiguration rpc, returning an UpdateNginxAgentConfigurationResponse |
 
 
 
@@ -1271,6 +1293,37 @@ Update HTTP Upstream Servers for an instance
 
 
 
+<a name="mpi-v1-UpdateNginxAgentConfigurationRequest"></a>
+
+### UpdateNginxAgentConfigurationRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| message_meta | [MessageMeta](#mpi-v1-MessageMeta) |  | Meta-information associated with a message |
+| agent_config | [AgentConfig](#mpi-v1-AgentConfig) |  | the NGINX Agent configuration to update |
+
+
+
+
+
+
+<a name="mpi-v1-UpdateNginxAgentConfigurationResponse"></a>
+
+### UpdateNginxAgentConfigurationResponse
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| response | [CommandResponse](#mpi-v1-CommandResponse) |  | The success or failure of the UpdateNginxAgentConfigurationRequest |
+
+
+
+
+
+
 <a name="mpi-v1-UpdateStreamServers"></a>
 
 ### UpdateStreamServers
@@ -1318,6 +1371,21 @@ the types of instances possible
 | INSTANCE_TYPE_NGINX_APP_PROTECT | 5 | NGINX App Protect |
 
 
+
+<a name="mpi-v1-Log-LogLevel"></a>
+
+### Log.LogLevel
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| LOG_LEVEL_UNSPECIFIED | 0 | Unspecified log level |
+| LOG_LEVEL_ERROR | 1 | Error log level |
+| LOG_LEVEL_WARN | 2 | Warning log level |
+| LOG_LEVEL_INFO | 3 | Info log level |
+| LOG_LEVEL_DEBUG | 4 | Debug log level |
+
+
 
 
 

api/grpc/mpi/v1/command.proto

@@ -27,4 +27,5 @@ const (
 	DataPlaneHealthRequestTopic  = "data-plane-health-request"
 	DataPlaneHealthResponseTopic = "data-plane-health-response"
 	APIActionRequestTopic        = "api-action-request"
+	AgentConfigUpdateTopic       = "agent-config-update"
 )

docs/proto/protos.md

@@ -37,6 +37,7 @@ type (
 		Subscribe(ctx context.Context)
 		IsConnected() bool
 		CreateConnection(ctx context.Context, resource *mpi.Resource) (*mpi.CreateConnectionResponse, error)
+		UpdateAgentConfiguration(ctx context.Context, request *mpi.AgentConfig) error
 	}
 
 	CommandPlugin struct {
@@ -127,6 +128,8 @@ func (cp *CommandPlugin) Process(ctx context.Context, msg *bus.Message) {
 			cp.processDataPlaneHealth(ctxWithMetadata, msg)
 		case bus.DataPlaneResponseTopic:
 			cp.processDataPlaneResponse(ctxWithMetadata, msg)
+		case bus.AgentConfigUpdateTopic:
+			cp.processAgentConfigUpdate(ctxWithMetadata, msg)
 		default:
 			slog.DebugContext(ctxWithMetadata, "Command plugin received unknown topic", "topic", msg.Topic)
 		}
@@ -140,6 +143,7 @@ func (cp *CommandPlugin) Subscriptions() []string {
 		bus.InstanceHealthTopic,
 		bus.DataPlaneHealthResponseTopic,
 		bus.DataPlaneResponseTopic,
+		bus.AgentConfigUpdateTopic,
 	}
 }
 
@@ -180,6 +184,13 @@ func (cp *CommandPlugin) createConnection(ctx context.Context, resource *mpi.Res
 			Topic: bus.ConnectionCreatedTopic,
 			Data:  createConnectionResponse,
 		})
+
+		// update agent configuration after connection is created, and notify other plugins
+		_ = cp.commandService.UpdateAgentConfiguration(ctx, createConnectionResponse.AgentConfig)
+		cp.messagePipe.Process(ctx, &bus.Message{
+			Topic: bus.AgentConfigUpdateTopic,
+			Data:  createConnectionResponse.AgentConfig,
+		})
 	}
 }
 
@@ -262,6 +273,19 @@ func (cp *CommandPlugin) processConnectionReset(ctx context.Context, msg *bus.Me
 	}
 }
 
+func (cp *CommandPlugin) processAgentConfigUpdate(ctx context.Context, msg *bus.Message) {
+	slog.DebugContext(ctx, "Command plugin received agent config update message", "data", msg.Data)
+	//
+	if mpiConf, ok := msg.Data.(*mpi.AgentConfig); ok {
+		err := cp.commandService.UpdateAgentConfiguration(ctx, mpiConf)
+		if err != nil {
+			slog.ErrorContext(ctx, "Unable to update agent configuration", "error", err)
+		}
+	} else {
+		slog.ErrorContext(ctx, "Invalid data for agent config update message", "data", msg.Data)
+	}
+}
+
 //nolint:revive // cognitive complexity is 14
 func (cp *CommandPlugin) monitorSubscribeChannel(ctx context.Context) {
 	for {
@@ -305,6 +329,9 @@ func (cp *CommandPlugin) monitorSubscribeChannel(ctx context.Context) {
 				}
 				slog.InfoContext(ctx, "Received management plane action request")
 				cp.handleAPIActionRequest(newCtx, message)
+			case *mpi.ManagementPlaneRequest_UpdateNginxAgentConfigurationRequest:
+				slog.InfoContext(ctx, "Received management plane request - update agent configuration")
+				cp.handleAgentConfigUpdateRequest(newCtx, message)
 			default:
 				slog.DebugContext(newCtx, "Management plane request not implemented yet")
 			}
@@ -408,6 +435,11 @@ func (cp *CommandPlugin) handleInvalidRequest(ctx context.Context,
 	}
 }
 
+func (cp *CommandPlugin) handleAgentConfigUpdateRequest(ctx context.Context, request *mpi.ManagementPlaneRequest) {
+	// notify plugins about the agent config update request
+	cp.Process(ctx, &bus.Message{Topic: bus.AgentConfigUpdateTopic, Data: request})
+}
+
 func (cp *CommandPlugin) createDataPlaneResponse(correlationID string, status mpi.CommandResponse_CommandStatus,
 	message, err string,
 ) *mpi.DataPlaneResponse {

internal/bus/topics.go

@@ -151,6 +151,17 @@ func TestCommandPlugin_Process(t *testing.T) {
 		Data:  commandPlugin.conn,
 	})
 	require.Equal(t, 1, fakeCommandService.UpdateClientCallCount())
+
+	commandPlugin.Process(ctx, &bus.Message{
+		Topic: bus.AgentConfigUpdateTopic,
+		Data: mpi.AgentConfig{
+			Log: &mpi.Log{
+				LogLevel: mpi.Log_LOG_LEVEL_DEBUG,
+				LogPath:  "somewhere",
+			},
+		},
+	})
+	require.Equal(t, 1, fakeCommandService.UpdateAgentConfigurationCallCount())
 }
 
 func TestCommandPlugin_monitorSubscribeChannel(t *testing.T) {

internal/command/command_plugin.go

@@ -182,6 +182,32 @@ func (cs *CommandService) SendDataPlaneResponse(ctx context.Context, response *m
 	)
 }
 
+func (cs *CommandService) UpdateAgentConfiguration(ctx context.Context, mpiConfig *mpi.AgentConfig) error {
+	if !cs.isConnected.Load() {
+		return errors.New("command service client not connected yet")
+	}
+	slog.DebugContext(ctx, "Updating agent configuration", "config", mpiConfig)
+
+	if mpiConfig.Log != nil {
+		slog.DebugContext(ctx, "Updating log configuration", "log", mpiConfig.Log)
+		logConf := config.Log{
+			Level: config.MapConfigLogLevelToSlogLevel(mpiConfig.Log.LogLevel),
+			Path:  mpiConfig.Log.LogPath,
+		}
+		cs.agentConfig.Log = &logConf
+
+		// Reinitialize logger with new configuration
+		slogger := logger.New(
+			cs.agentConfig.Log.Path,
+			cs.agentConfig.Log.Level,
+		)
+		slog.SetDefault(slogger)
+	}
+
+	return nil
+}
+
+// Subscribe to the Management Plane for incoming commands.
 func (cs *CommandService) Subscribe(ctx context.Context) {
 	commonSettings := &config.BackOff{
 		InitialInterval:     cs.agentConfig.Client.Backoff.InitialInterval,

internal/command/command_plugin_test.go

@@ -377,6 +377,39 @@ func TestCommandService_SendDataPlaneResponse_configApplyRequest(t *testing.T) {
 	wg.Wait()
 }
 
+func TestCommandService_UpdateAgentConfiguration(t *testing.T) {
+	ctx := context.Background()
+	commandServiceClient := &v1fakes.FakeCommandServiceClient{}
+
+	initialConfig := types.AgentConfig()
+	initialConfig.Log.Level = "INFO"
+	initialConfig.Log.Path = ""
+
+	commandService := NewCommandService(
+		commandServiceClient,
+		initialConfig,
+		make(chan *mpi.ManagementPlaneRequest),
+	)
+	commandService.isConnected.Store(true)
+
+	originalLogger := slog.Default()
+
+	updatedConfig := &mpi.AgentConfig{
+		Log: &mpi.Log{
+			LogLevel: mpi.Log_LOG_LEVEL_DEBUG,
+			LogPath:  "/etc/nginx-agent",
+		},
+	}
+	
+	err := commandService.UpdateAgentConfiguration(ctx, updatedConfig)
+	require.NoError(t, err)
+	require.Equal(t, "DEBUG", commandService.agentConfig.Log.Level)
+	require.Equal(t, "/etc/nginx-agent", commandService.agentConfig.Log.Path)
+
+	updatedLogger := slog.Default()
+	require.NotEqual(t, originalLogger, updatedLogger)
+}
+
 func TestCommandService_isValidRequest(t *testing.T) {
 	ctx := context.Background()
 	commandServiceClient := &v1fakes.FakeCommandServiceClient{}