Using the MongoDB Support Feature

Learn how to redirect the collection of metrics and audit data from the designated Policy Manager database to the MongoDB database.

Using Admin Console Managing Containers

Table of Contents


This plug-in redirects the collection of metrics and audit data from the designated Policy Manager Database (RDBMS) to the MongoDB Database.

Use of this plug-in requires installation of MongoDB.

Redirecting the capture of metrics and auditing data can help to optimize performance by reducing the toll on your designated RDBMS. This is because metrics and roll-up data processes will now occur in MongoDB which will increase performance in the container by reducing query times and CPU/memory overhead.

  • This plug-in can be used exclusively with the Policy Manager product or in combination with Community Manager and/or Akana Envision.
  • Data stored includes Policy Manager Alerts, and all metrics and auditing log data that has a write operation.
  • Metrics and audit data collected from Network Director will be stored directly in MongoDB and will not be stored in the designated Policy Manager database (RDBMS). This includes data relating to how an API is performing (response times, error rates, and so forth)
  • Alert and audit trail data would be information such as when a specific service changed, who changed it, and the result of the change.
  • Audit data can be used both in Community Manager, Policy Manager, and Envision for various charts by configuring a Business Metrics Policy that allows you to configure what focus of data to extract from the payload.
  • In Policy Manager, logging data for historical charts and logs that can be viewed via the Monitoring tab in Services, Containers, and Contracts will now be fetched from MongoDB.
  • The logging data stored in MongoDB can also be used in your own third-party reporting tools.

back to top

Step 1: Download and Install MongoDB

Use of this plug-in requires installation of MongoDB. If you have already installed and started MongoDB skip to Step 4.

  1. Go to and download the MongoDB Version 3.2 file for your platform. Windows 64-bit (MSI), Linux 64-bit (TGZ), and Solaris 64-bit (TGZ) are supported. If you are on a Mac, you can install MongoDB with homebrew using brew install mongo. We highly recommend that you use MongoDB Enterprise Advanced, especially if you're running the API Gateway to support production or mission-critical applications. MongoDB Enterprise Advanced offers enterprise-grade security, operational automation, proactive support, and disaster recovery to run API Gateway in a secure, reliable and hassle-free way.
  2. Install MongoDB on your platform.

Note: These instructions provide a basic MongoDB installation approach. Refer to the MongoDB documentation for information on installation instructions and shutdown procedures for your specific deployment:

back to top

Step 2: Create MongoDB Data Folder

  1. Create a MongoDB data folder. The default is /data/db. If you prefer to use a different location use --dbpath.

back to top

Step 3: Start MongoDB

  1. Navigate to the MongoDB installation directory:/MongoDB/Server/3.2/bin
  2. Enter mongod.
  3. If MongoDB successfully starts, your command window will display the message waiting for connections followed by the port number.

back to top

Step 4: Configure MongoDB Support Plug-in

  1. Log in to the Akana Administration Console of the target installation container instance using your default credentials.
  2. On the Available Features screen, from the Filter menu, select Plug-ins.
  3. Select the MongoDB Support plug-in and click Install Feature.
  4. After the installation is complete, click Configure and then click Continue.
  5. On the Configure MongoDB Database screen, specify the host name and port where the MongoDB database is installed in the MongoClientURI field. The default MongoDB port is 27017.
  6. Click Finish, and then click OK to restart the container. The URI is assigned and the system automatically configures seed data and adds schemas.
  7. After the installation is complete, you can manage (install / uninstall) data sets: On the Configuration tab, select Configure MongoDB Database.

Back to top