(DOCSP-41486) Adds updates for full log rotation support. (#1786)

* (DOCSP-41486) Adds updates for full log rotation support.

* Revises per first-round tech review.

* Revises per edits from tech and copy review.

* Fixes build errors.

* Revises per second-round copy review.

Author: erabil-mdb

source/includes/code-examples/yaml-files/example-mongodb-logging-config.yaml

@@ -22,6 +22,37 @@ spec:
   # https://docs.opsmanager.mongodb.com/current/reference/mongodb-agent-settings/
   agent:
     startupOptions:
-      maxLogFiles: "4"
-      maxLogFileDurationHrs: "1"
-      maxUncompressedLogFiles: "2"
+      maxLogFiles: 10
+      maxLogFileSize: 2
+    readinessProbe:
+      environmentVariables:
+        READINESS_PROBE_LOGGER_MAX_SIZE: 10
+        READINESS_PROBE_LOGGER_BACKUPS: 1
+        READINESS_PROBE_LOGGER_MAX_AGE: 3
+        READINESS_PROBE_LOGGER_COMPRESS: true
+        MDB_WITH_AGENT_FILE_LOGGING: false
+        LOG_FILE_PATH: /var/log/mongodb-mms-automation/readiness.log
+    backupAgent:
+      logRotate:
+        sizeThresholdMB: 10
+        timeThresholdHrs: 10
+    monitoringAgent:
+      logRotate:
+        sizeThresholdMB: 10
+        timeThresholdHrs: 10
+    # For Ops Manager 6, you can only configure mongod logs with this setting starting with version 6.0.2.
+    # For Ops Manager 7, you can only configure mongod logs with this setting starting with version 7.0.4.
+    # For previous Ops Manager versions, you must configure mongod logs using the Ops Manager UI.
+    mongod:
+      logRotate:
+        sizeThresholdMB: 10
+        timeThresholdHrs: 10
+        numUncompressed: 10
+        numTotal: 10
+        percentOfDiskspace: 10
+      auditLogRotate:
+        sizeThresholdMB: 10
+        timeThresholdHrs: 10
+        numUncompressed: 10
+        numTotal: 10
+        percentOfDiskspace: 10

source/includes/code-examples/yaml-files/example-ops-manager-logging-config.yaml

@@ -11,14 +11,42 @@ spec:
     version: "6.0.11-ent"
     members: 3
     agent:
-      #AppDB (mongod) log rotation
-      logRotate:
-        numTotal: 4
-        numUncompressed: 2
-        timeThresholdHrs: 1
-        sizeThresholdMB: "10"
-      #Automation Agent log rotation
-      startupOptions:
-        maxLogFiles: "4"
-        maxLogFileDurationHrs: "1"
-        maxUncompressedLogFiles: "2"
+     #agent.logRotate is deprecated and overwritten by agent.mongod.logRotate.
+     logRotate:
+     #Automation Agent log rotation
+     startupOptions:
+       maxLogFiles: 10
+       maxLogFileSize: 2
+     #Readiness probe log rotation
+     readinessProbe:
+       environmentVariables:
+         READINESS_PROBE_LOGGER_MAX_SIZE: 10
+         READINESS_PROBE_LOGGER_BACKUPS: 1
+         READINESS_PROBE_LOGGER_MAX_AGE: 3
+         READINESS_PROBE_LOGGER_COMPRESS: true
+         MDB_WITH_AGENT_FILE_LOGGING: false
+         LOG_FILE_PATH: /var/log/mongodb-mms-automation/readiness.log
+     #AppDB backup log rotation
+     backupAgent:
+       logRotate:
+         sizeThresholdMB: 10
+         timeThresholdHrs: 10
+     #AppDB Monitoring Agent log rotation
+     monitoringAgent:
+       logRotate:
+         sizeThresholdMB: 10
+         timeThresholdHrs: 10
+     #AppDB (mongod) log rotation
+     mongod:
+       logRotate:
+         sizeThresholdMB: 10
+         timeThresholdHrs: 10
+         numUncompressed: 10
+         numTotal: 10
+         percentOfDiskspace: 10
+       auditLogRotate:
+         sizeThresholdMB: 10
+         timeThresholdHrs: 10
+         numUncompressed: 10
+         numTotal: 10
+         percentOfDiskspace: 10

source/includes/list-tables/crd-logging-configuration.rst

@@ -1,48 +1,64 @@
 .. list-table::
-   :widths: 33 33 33
+   :widths: 25 25 25 25
    :header-rows: 1
 
    * - Component
-     - Log type
-     - Configuration location
+     - Log type   
+     - CRD manifest configuration
+     - Default configuration location
 
    * - MongoDB
      - Automation agent logs
+     - :setting:`MongoDB CRD <spec.agent.startupOptions>`
      - :setting:`spec.agent.startupOptions`
 
    * - MongoDB
      - {+monitoring-agent+} logs
+     - :setting:`MongoDB CRD <spec.agent.monitoringAgent.logRotate>`
      - Ops Manager API or UI
 
    * - MongoDB
      - Backup logs
+     - :setting:`MongoDB CRD <spec.agent.backupAgent.logRotate>`
      - Ops Manager API or UI
 
    * - MongoDB
      - MongoDB logs
+     - |onprem| 7.0.4, 6.0.24, or later: :setting:`MongoDB CRD <spec.agent.mongod.logRotate>`
      - Ops Manager UI
 
    * - MongoDB
      - Audit logs
+     - :setting:`MongoDB CRD <spec.agent.mongod.auditlogRotate>`
      - Ops Manager UI
 
    * - MongoDB
      - Readiness Probe
+     - :setting:`MongoDB CRD <spec.agent.readinessProbe.environmentVariables>`
      - `Container Environment Variables <https://www.mongodb.com/docs/kubernetes-operator/master/reference/kubectl-operator-settings/#readiness-probe-logger-max-size>`__
 
    * - {+appdb+}
      - MongoDB Logs
-     - :opsmgrkube:`spec.applicationDatabase.agent.logRotate`
+     - :opsmgrkube:`MongoDBOpsManager CRD <spec.applicationDatabase.agent.<component>.logRotate>`
+     - :opsmgrkube:`spec.applicationDatabase.agent.mongod.logRotate <spec.applicationDatabase.agent.<component>.logRotate>`
 
    * - {+appdb+}
      - Automation Agent Logs
+     - :opsmgrkube:`MongoDBOpsManager CRD <spec.applicationDatabase.agent.startupOptions>`
      - :opsmgrkube:`spec.applicationDatabase.agent.startupOptions`
 
    * - {+appdb+}
      - {+monitoring-agent+} logs
+     - :opsmgrkube:`MongoDBOpsManager CRD <spec.applicationDatabase.agent.<component>.logRotate>`
      - Forwarded to ``stdout`` only (kubectl logs). 
        Managed and stored in the |k8s| control plane.
 
    * - {+appdb+}
      - Audit logs
-     - :opsmgrkube:`spec.applicationDatabase.agent.logRotate.includeAuditLogsWithMongoDBLogs`
+     - :opsmgrkube:`MongoDBOpsManager CRD <spec.applicationDatabase.agent.mongod.auditlogRotate>`
+     - :opsmgrkube:`spec.applicationDatabase.agent.mongod.auditlogRotate`
+
+   * - |onprem|
+     - |onprem| logs
+     - :ref:`MongoDBOpsManager CRD <k8s-om-log-rotation-crd>`
+     - :ref:`logback.xml configuration file <onprem-own-logs>`

source/includes/meko-component-replacement.rst

@@ -0,0 +1,5 @@
+Replace  *component*  with one of the following values:
+
+-  ``mongod``
+-  ``backupAgent``
+-  ``monitoringAgent``