Make automation agent log level configurable (#1238)

Author: p-kimberley

api/v1/mongodbcommunity_types.go

@@ -98,6 +98,10 @@ type MongoDBCommunitySpec struct {
 	// +optional
 	StatefulSetConfiguration StatefulSetConfiguration `json:"statefulSet,omitempty"`
 
+	// AgentConfiguration sets options for the MongoDB automation agent
+	// +optional
+	AgentConfiguration AgentConfiguration `json:"agent,omitempty"`
+
 	// AdditionalMongodConfig is additional configuration that can be passed to
 	// each data-bearing mongod at runtime. Uses the same structure as the mongod
 	// configuration file: https://www.mongodb.com/docs/manual/reference/configuration-options/
@@ -268,6 +272,23 @@ type StatefulSetConfiguration struct {
 	SpecWrapper StatefulSetSpecWrapper `json:"spec"`
 }
 
+type LogLevel string
+
+const (
+	LogLevelDebug LogLevel = "DEBUG"
+	LogLevelInfo           = "INFO"
+	LogLevelWarn           = "WARN"
+	LogLevelError          = "ERROR"
+	LogLevelFatal          = "FATAL"
+)
+
+type AgentConfiguration struct {
+	// +optional
+	LogLevel LogLevel `json:"logLevel"`
+	// +optional
+	MaxLogFileDurationHours int `json:"maxLogFileDurationHours"`
+}
+
 // StatefulSetSpecWrapper is a wrapper around StatefulSetSpec with a custom implementation
 // of MarshalJSON and UnmarshalJSON which delegate to the underlying Spec to avoid CRD pollution.
 
@@ -920,6 +941,14 @@ func (m MongoDBCommunity) NeedsAutomationConfigVolume() bool {
 	return true
 }
 
+func (m MongoDBCommunity) GetAgentLogLevel() LogLevel {
+	return m.Spec.AgentConfiguration.LogLevel
+}
+
+func (m MongoDBCommunity) GetAgentMaxLogFileDurationHours() int {
+	return m.Spec.AgentConfiguration.MaxLogFileDurationHours
+}
+
 type automationConfigReplicasScaler struct {
 	current, desired       int
 	forceIndividualScaling bool

api/v1/zz_generated.deepcopy.go

@@ -60,6 +60,15 @@ spec:
                 nullable: true
                 type: object
                 x-kubernetes-preserve-unknown-fields: true
+              agent:
+                description: AgentConfiguration sets options for the MongoDB automation
+                  agent
+                properties:
+                  logLevel:
+                    type: string
+                  maxLogFileDurationHours:
+                    type: integer
+                type: object
               arbiters:
                 description: 'Arbiters is the number of arbiters to add to the Replica
                   Set. It is not recommended to have more than one arbiter per Replica

config/crd/bases/mongodbcommunity.mongodb.com_mongodbcommunity.yaml

@@ -102,7 +102,7 @@ func assertStatefulSetIsBuiltCorrectly(t *testing.T, mdb mdbv1.MongoDBCommunity,
 	assert.Equal(t, mdb.Name, sts.Name)
 	assert.Equal(t, mdb.Namespace, sts.Namespace)
 	assert.Equal(t, mongodbDatabaseServiceAccountName, sts.Spec.Template.Spec.ServiceAccountName)
-	assert.Len(t, sts.Spec.Template.Spec.Containers[0].Env, 4)
+	assert.Len(t, sts.Spec.Template.Spec.Containers[0].Env, 6)
 	assert.Len(t, sts.Spec.Template.Spec.Containers[1].Env, 1)
 
 	managedSecurityContext := envvar.ReadBool(podtemplatespec.ManagedSecurityContextEnv)

controllers/construct/build_statefulset_test.go

@@ -3,6 +3,7 @@ package construct
 import (
 	"fmt"
 	"os"
+	"strconv"
 	"strings"
 
 	"github.com/mongodb/mongodb-kubernetes-operator/pkg/automationconfig"
@@ -34,20 +35,21 @@ const (
 
 	MongodbRepoUrl = "MONGODB_REPO_URL"
 
-	headlessAgentEnv           = "HEADLESS_AGENT"
-	podNamespaceEnv            = "POD_NAMESPACE"
-	automationConfigEnv        = "AUTOMATION_CONFIG_MAP"
-	AgentImageEnv              = "AGENT_IMAGE"
-	MongodbImageEnv            = "MONGODB_IMAGE"
-	VersionUpgradeHookImageEnv = "VERSION_UPGRADE_HOOK_IMAGE"
-	ReadinessProbeImageEnv     = "READINESS_PROBE_IMAGE"
+	headlessAgentEnv                = "HEADLESS_AGENT"
+	podNamespaceEnv                 = "POD_NAMESPACE"
+	automationConfigEnv             = "AUTOMATION_CONFIG_MAP"
+	AgentImageEnv                   = "AGENT_IMAGE"
+	MongodbImageEnv                 = "MONGODB_IMAGE"
+	VersionUpgradeHookImageEnv      = "VERSION_UPGRADE_HOOK_IMAGE"
+	ReadinessProbeImageEnv          = "READINESS_PROBE_IMAGE"
+	agentLogLevelEnv                = "AGENT_LOG_LEVEL"
+	agentMaxLogFileDurationHoursEnv = "AGENT_MAX_LOG_FILE_DURATION_HOURS"
 
 	automationMongodConfFileName = "automation-mongod.conf"
 	keyfileFilePath              = "/var/lib/mongodb-mms-automation/authentication/keyfile"
 
-	automationAgentOptions = " -skipMongoStart -noDaemonize -useLocalMongoDbTools"
-
-	automationAgentLogOptions = " -logFile /var/log/mongodb-mms-automation/automation-agent.log -maxLogFileDurationHrs 24 -logLevel DEBUG"
+	automationAgentOptions    = " -skipMongoStart -noDaemonize -useLocalMongoDbTools"
+	automationAgentLogOptions = " -logFile /var/log/mongodb-mms-automation/automation-agent.log -maxLogFileDurationHrs ${AGENT_MAX_LOG_FILE_DURATION_HOURS} -logLevel ${AGENT_LOG_LEVEL}"
 
 	MongodbUserCommand = `current_uid=$(id -u)
 AGENT_API_KEY="$(cat /mongodb-automation/agent-api-key/agentApiKey)"
@@ -70,7 +72,7 @@ type MongoDBStatefulSetOwner interface {
 	GetName() string
 	// GetNamespace returns the namespace the resource is defined in.
 	GetNamespace() string
-	// GetMongoDBVersion returns the version of MongoDB to be used for this resource
+	// GetMongoDBVersion returns the version of MongoDB to be used for this resource.
 	GetMongoDBVersion() string
 	// AutomationConfigSecretName returns the name of the secret which will contain the automation config.
 	AutomationConfigSecretName() string
@@ -80,10 +82,14 @@ type MongoDBStatefulSetOwner interface {
 	HasSeparateDataAndLogsVolumes() bool
 	// GetAgentKeyfileSecretNamespacedName returns the NamespacedName of the secret which stores the keyfile for the agent.
 	GetAgentKeyfileSecretNamespacedName() types.NamespacedName
-	// DataVolumeName returns the name that the data volume should have
+	// DataVolumeName returns the name that the data volume should have.
 	DataVolumeName() string
-	// LogsVolumeName returns the name that the data volume should have
+	// LogsVolumeName returns the name that the data volume should have.
 	LogsVolumeName() string
+	// GetAgentLogLevel returns the log level for the MongoDB automation agent.
+	GetAgentLogLevel() mdbv1.LogLevel
+	// GetAgentMaxLogFileDurationHours returns the number of hours after which the log file should be rolled.
+	GetAgentMaxLogFileDurationHours() int
 
 	// GetMongodConfiguration returns the MongoDB configuration for each member.
 	GetMongodConfiguration() mdbv1.MongodConfiguration
@@ -156,6 +162,16 @@ func BuildMongoDBReplicaSetStatefulSetModificationFunction(mdb MongoDBStatefulSe
 
 	podSecurityContext, _ := podtemplatespec.WithDefaultSecurityContextsModifications()
 
+	agentLogLevel := mdbv1.LogLevelInfo
+	if mdb.GetAgentLogLevel() != "" {
+		agentLogLevel = string(mdb.GetAgentLogLevel())
+	}
+
+	agentMaxLogFileDurationHours := automationconfig.DefaultAgentMaxLogFileDurationHours
+	if mdb.GetAgentMaxLogFileDurationHours() != 0 {
+		agentMaxLogFileDurationHours = mdb.GetAgentMaxLogFileDurationHours()
+	}
+
 	return statefulset.Apply(
 		statefulset.WithName(mdb.GetName()),
 		statefulset.WithNamespace(mdb.GetNamespace()),
@@ -178,7 +194,7 @@ func BuildMongoDBReplicaSetStatefulSetModificationFunction(mdb MongoDBStatefulSe
 				podtemplatespec.WithVolume(tmpVolume),
 				podtemplatespec.WithVolume(keyFileVolume),
 				podtemplatespec.WithServiceAccount(mongodbDatabaseServiceAccountName),
-				podtemplatespec.WithContainer(AgentName, mongodbAgentContainer(mdb.AutomationConfigSecretName(), mongodbAgentVolumeMounts)),
+				podtemplatespec.WithContainer(AgentName, mongodbAgentContainer(mdb.AutomationConfigSecretName(), mongodbAgentVolumeMounts, agentLogLevel, agentMaxLogFileDurationHours)),
 				podtemplatespec.WithContainer(MongodbName, mongodbContainer(mdb.GetMongoDBVersion(), mongodVolumeMounts, mdb.GetMongodConfiguration())),
 				podtemplatespec.WithInitContainer(versionUpgradeHookName, versionUpgradeHookInit([]corev1.VolumeMount{hooksVolumeMount})),
 				podtemplatespec.WithInitContainer(ReadinessProbeContainerName, readinessProbeInit([]corev1.VolumeMount{scriptsVolumeMount})),
@@ -194,7 +210,7 @@ func AutomationAgentCommand() []string {
 	return []string{"/bin/bash", "-c", MongodbUserCommand + BaseAgentCommand() + " -cluster=" + clusterFilePath + automationAgentOptions + automationAgentLogOptions}
 }
 
-func mongodbAgentContainer(automationConfigSecretName string, volumeMounts []corev1.VolumeMount) container.Modification {
+func mongodbAgentContainer(automationConfigSecretName string, volumeMounts []corev1.VolumeMount, logLevel string, maxLogFileDurationHours int) container.Modification {
 	_, containerSecurityContext := podtemplatespec.WithDefaultSecurityContextsModifications()
 	return container.Apply(
 		container.WithName(AgentName),
@@ -227,6 +243,14 @@ func mongodbAgentContainer(automationConfigSecretName string, volumeMounts []cor
 				Name:  agentHealthStatusFilePathEnv,
 				Value: agentHealthStatusFilePathValue,
 			},
+			corev1.EnvVar{
+				Name:  agentLogLevelEnv,
+				Value: logLevel,
+			},
+			corev1.EnvVar{
+				Name:  agentMaxLogFileDurationHoursEnv,
+				Value: strconv.Itoa(maxLogFileDurationHours),
+			},
 		),
 	)
 }

controllers/construct/mongodbstatefulset.go

@@ -9,10 +9,11 @@ import (
 )
 
 const (
-	Mongod                ProcessType = "mongod"
-	DefaultMongoDBDataDir string      = "/data"
-	DefaultDBPort         int         = 27017
-	DefaultAgentLogPath   string      = "/var/log/mongodb-mms-automation"
+	Mongod                              ProcessType = "mongod"
+	DefaultMongoDBDataDir               string      = "/data"
+	DefaultDBPort                       int         = 27017
+	DefaultAgentLogPath                 string      = "/var/log/mongodb-mms-automation"
+	DefaultAgentMaxLogFileDurationHours int         = 24
 )
 
 type AutomationConfig struct {