Skip to main content
Redhat Developers  Logo
  • Products

    Featured

    • Red Hat Enterprise Linux
      Red Hat Enterprise Linux Icon
    • Red Hat OpenShift AI
      Red Hat OpenShift AI
    • Red Hat Enterprise Linux AI
      Linux icon inside of a brain
    • Image mode for Red Hat Enterprise Linux
      RHEL image mode
    • Red Hat OpenShift
      Openshift icon
    • Red Hat Ansible Automation Platform
      Ansible icon
    • Red Hat Developer Hub
      Developer Hub
    • View All Red Hat Products
    • Linux

      • Red Hat Enterprise Linux
      • Image mode for Red Hat Enterprise Linux
      • Red Hat Universal Base Images (UBI)
    • Java runtimes & frameworks

      • JBoss Enterprise Application Platform
      • Red Hat build of OpenJDK
    • Kubernetes

      • Red Hat OpenShift
      • Microsoft Azure Red Hat OpenShift
      • Red Hat OpenShift Virtualization
      • Red Hat OpenShift Lightspeed
    • Integration & App Connectivity

      • Red Hat Build of Apache Camel
      • Red Hat Service Interconnect
      • Red Hat Connectivity Link
    • AI/ML

      • Red Hat OpenShift AI
      • Red Hat Enterprise Linux AI
    • Automation

      • Red Hat Ansible Automation Platform
      • Red Hat Ansible Lightspeed
    • Developer tools

      • Red Hat Trusted Software Supply Chain
      • Podman Desktop
      • Red Hat OpenShift Dev Spaces
    • Developer Sandbox

      Developer Sandbox
      Try Red Hat products and technologies without setup or configuration fees for 30 days with this shared Openshift and Kubernetes cluster.
    • Try at no cost
  • Technologies

    Featured

    • AI/ML
      AI/ML Icon
    • Linux
      Linux Icon
    • Kubernetes
      Cloud icon
    • Automation
      Automation Icon showing arrows moving in a circle around a gear
    • View All Technologies
    • Programming Languages & Frameworks

      • Java
      • Python
      • JavaScript
    • System Design & Architecture

      • Red Hat architecture and design patterns
      • Microservices
      • Event-Driven Architecture
      • Databases
    • Developer Productivity

      • Developer productivity
      • Developer Tools
      • GitOps
    • Secure Development & Architectures

      • Security
      • Secure coding
    • Platform Engineering

      • DevOps
      • DevSecOps
      • Ansible automation for applications and services
    • Automated Data Processing

      • AI/ML
      • Data Science
      • Apache Kafka on Kubernetes
      • View All Technologies
    • Start exploring in the Developer Sandbox for free

      sandbox graphic
      Try Red Hat's products and technologies without setup or configuration.
    • Try at no cost
  • Learn

    Featured

    • Kubernetes & Cloud Native
      Openshift icon
    • Linux
      Rhel icon
    • Automation
      Ansible cloud icon
    • Java
      Java icon
    • AI/ML
      AI/ML Icon
    • View All Learning Resources

    E-Books

    • GitOps Cookbook
    • Podman in Action
    • Kubernetes Operators
    • The Path to GitOps
    • View All E-books

    Cheat Sheets

    • Linux Commands
    • Bash Commands
    • Git
    • systemd Commands
    • View All Cheat Sheets

    Documentation

    • API Catalog
    • Product Documentation
    • Legacy Documentation
    • Red Hat Learning

      Learning image
      Boost your technical skills to expert-level with the help of interactive lessons offered by various Red Hat Learning programs.
    • Explore Red Hat Learning
  • Developer Sandbox

    Developer Sandbox

    • Access Red Hat’s products and technologies without setup or configuration, and start developing quicker than ever before with our new, no-cost sandbox environments.
    • Explore Developer Sandbox

    Featured Developer Sandbox activities

    • Get started with your Developer Sandbox
    • OpenShift virtualization and application modernization using the Developer Sandbox
    • Explore all Developer Sandbox activities

    Ready to start developing apps?

    • Try at no cost
  • Blog
  • Events
  • Videos

Configuring the MongoDB WiredTiger memory cache for RHMAP

September 17, 2018
Camila Macedo
Related topics:
Kubernetes
Related products:
Red Hat build of Node.jsRed Hat OpenShift Container Platform

Share:

    This article describes how to configure MongoDB's WiredTiger memory cache in Red Hat Mobile Application Platform (RHMAP) to prevent high-usage memory issues and Nagios alerts. If the WiredTiger cache consumes all the memory available for a container, memory issues and Nagios alerts will occur.

    The WiredTiger storage engine is the default storage engine starting in MongoDB version 3.2. It uses MultiVersion Concurrency Control (MVCC) architecture for write operations in order to allow multiple different modifications to the same document at the same time.

    WiredTiger also caches data and creates checkpoints to give you the ability to recover anytime it’s necessary. For example, if a MongoDB image deployed in a container fails, it is useful to recover the data that was not persisted. Additionally, WiredTiger can recover un-checkpointed data with its journal files. See the journal documentation and snapshots and checkpoint documentation for more information.

    Configuring memory usage

    To prevent memory issues and Nagios alerts, the property storage.wiredTiger.engineConfig.cacheSizeGB should be set to a value less than the amount of RAM available in the container. Another option to achieve the same result is through the –wiredTigerCacheSizeGB parameter.

    In version 3.2 of MongoDB, the default configuration is to use 1GB of memory or 60% of the available amount of memory when the available amount is larger than one 1GB. This usage percentage was replaced by 50% in version 3.4 of MongoDB. For more details, see the storage.wiredTiger.engineConfig.cacheSizeGB API documentation.

    Due to a bug in MongoDB 3.2, a workaround is required to accept values lower than 1Gi. The property configString: cache_size=<cache-size> needs to be set in the MongoDB configuration. The following is an example of setting the property to 600MB:

    # storage options - How and where to store data
    storage:
        # Directory for datafiles (defaults to /data/db/)
        dbPath: ${MONGODB_DATADIR}
        wiredTiger:
           engineConfig:
               configString: cache_size=600M

    Note: The bug "WiredTiger cache size is only configurable in whole gigabytes" can be viewed here.

    Avoiding high-usage memory alerts and issues related to MongoDB in RHMAP

    In version 4.6.5 or above of RHMAP, the WiredTiger memory cache will be already configured to use 60%/600MB of the default amount of available memory, which is 1GB in the newer RHMAP MongoDB image released. To check this image, see its catalog here. However, in the previous image, memory issues and high-usage memory alerts may be triggered in Nagios because the cache size configuration was not set.

    It is recommended that the latest version of the product be used in order to achieve the best user experience and avoid technical debts. If this is not possible, then it is recommended to update all MongoDB instances' configuration to include a proper value for the WiredTiger cache size in both projects: Core and MBaaS.

    The following the steps are examples suggested by Shannon Poole, an RHMAP senior software engineer, to perform this configuration manually.

    1. Create a ConfigMap, as shown in the following example:

    kind: ConfigMap
    apiVersion: v1
    metadata:
      name: wired-tiger-config
      namespace: rhmap-3-node-mbaas
    data:
      mongod.conf: |
        ##
        ## For list of options visit:
        ## https://docs.mongodb.org/manual/reference/configuration-options/
        ##
    
        # systemLog options - How to do logging
        systemLog:
          # Runs the mongod in a quiet mode that attempts to limit the 
          # amount of output
          quiet: true
    
    
        # net options - Network interfaces settings
        net:
          # Specify port number (27017 by default)
          port: 27017
    
    
        # storage options - How and where to store data
        storage:
          # Directory for datafiles (defaults to /data/db/)
          dbPath: /var/lib/mongodb/data
          wiredTiger:
            engineConfig:
              configString: cache_size=400M
    
        # replication options - Configures replication
        replication:
          # Specifies a maximum size in megabytes for the replication 
          # operation log (i.e. the oplog,
          # 5% of disk space by default)
          oplogSizeMB: 64
    

    2. Add the ConfigMap to the deployment configuration (dc) of the MongoDB pod in order to mount it in the right place (/etc/mongod.conf). To edit the deployment configuration, use the following command or the Red hat OpenShift console.

    $ oc edit dc/<deployment_config>

    Note: See the Consuming in Volumes section of the Red Hat OpenShift documentation for further information.

    3. Update the MongoDB replica set container specification, as shown in the following example:

    containers:
    - volumeMounts:
      - name: wired-tiger-config
        mountPath: /etc/mongod.conf
        subPath: mongod.conf
    volumes:
    - name: wired-tiger-config
      configMap:
        name: wired-tiger-config

    4. Check the pod logs to verify the changes. See if the custom cache size will be there after MongoDB is redeployed. This customization will be described in the logs when MongoDB initializes, as shown in the following example:

    => [Mon Aug 20 13:42:22] wiredTiger cacheSizeGB set to 1
    => [Mon Aug 20 13:42:22] Waiting for local MongoDB to accept connections  …
    2018-08-20T13:42:22.837+0000 I STORAGE  [main] Engine custom option: cache_size=600M

    Conclusion

    If the memory amount allocated for the MongoDB instances will be changed, then it is recommended that you review the configuration and set an adequate value for the WiredTiger cache. There's no need to perform this configuration when the memory resource is bigger than 1GB, since the default set up is 60% of the total available in this situation. However, if a change is done in order to allocate 1GB or less, the recommendation is to customize this value, as explained in this post.

    Last updated: October 31, 2023

    Recent Posts

    • More Essential AI tutorials for Node.js Developers

    • How to run a fraud detection AI model on RHEL CVMs

    • How we use software provenance at Red Hat

    • Alternatives to creating bootc images from scratch

    • How to update OpenStack Services on OpenShift

    Red Hat Developers logo LinkedIn YouTube Twitter Facebook

    Products

    • Red Hat Enterprise Linux
    • Red Hat OpenShift
    • Red Hat Ansible Automation Platform

    Build

    • Developer Sandbox
    • Developer Tools
    • Interactive Tutorials
    • API Catalog

    Quicklinks

    • Learning Resources
    • E-books
    • Cheat Sheets
    • Blog
    • Events
    • Newsletter

    Communicate

    • About us
    • Contact sales
    • Find a partner
    • Report a website issue
    • Site Status Dashboard
    • Report a security problem

    RED HAT DEVELOPER

    Build here. Go anywhere.

    We serve the builders. The problem solvers who create careers with code.

    Join us if you’re a developer, software engineer, web designer, front-end designer, UX designer, computer scientist, architect, tester, product manager, project manager or team lead.

    Sign me up

    Red Hat legal and privacy links

    • About Red Hat
    • Jobs
    • Events
    • Locations
    • Contact Red Hat
    • Red Hat Blog
    • Inclusion at Red Hat
    • Cool Stuff Store
    • Red Hat Summit

    Red Hat legal and privacy links

    • Privacy statement
    • Terms of use
    • All policies and guidelines
    • Digital accessibility

    Report a website issue