You are here


insights overview


NuoDB Insights is a graphical dashboard that provides users a detailed view into their NuoDB database. The visual dashboard allows users to understand the performance and overall health of their NuoDB database environment.

Enable NuoDB Insights to gain a graphical view into aggregate system-level data that will help you better understand your overall application workload demands, and how to optimize and troubleshoot your NuoDB database and processes.

Specifically, you’ll gain access to real-time and historical TRENDING data, including:

  • Lifecycle events - start / stop, transactions per second (TPS) timing
  • System configuration data - CPU usage, memory, disk, and networking resource usage and constraints
  • NuoDB performance data - response times, load averages, number of application connections, and so much more...

Disabled by default, you must enable NuoDB Insights before it will capture and display any data.* 

Once enabled, the NuoDB Insights dashboard can be accessed through a dedicated and secure NuoDB web portal. If interested in running NuoDB Insights on-prem, please contact our NuoDB Customer Success team.

NuoDB Insights is open source, and we welcome contributors to improve this monitoring software! If you’d like to participate in development, you can find the source code on GitHub.

* Usage Information does not include any personally identifiable information ("PII"), but may include some aggregated and anonymized information derived from data that may be considered PII in some contexts (e.g., user locations or IP addresses). NuoDB Insights is only available to NuoDB databases running on Linux, and requires Java 7 or 8, and Python 2.7 to operate.



How to Set up NuoDB Insights for Red Hat OpenShift Deployments

Step 1: Deploy the NuoDB Operator


  • Note: By default, TLS Security is enabled with a default TLS key suitable for your evaluation purposes. If you need to create a custom key to comply with your corporate security policies, see Enabling TLS in Containerized Environments documentation.
  • Under the Deploy the NuoDB Database section on the NuoDB Operator GitHub, find the sub-section "Sample cr.yaml deployment files". Using these instructions create a cr.yaml file to configure your NUoDB database to your specifications. In your cr.yaml file, set the following variable to enable NuoDB Insights:
    • Insightsenabled: True

STEP 3: Start your database by following the remaining steps in Deploy the NuoDB Database

NuoDB Insights will now begin capturing and presenting database and system metrics that you can access using your unique Subscriber ID and Dashboard URL. 

How to get subscriber ID and Dashboard URL:

Inside OpenShift 4:

  1. Click "Workloads" on the left navigational panel
  2. Select "Pods"
  3. Locate and select the pod named "nuodb-insights"
  4. Click the tab named "Logs"
  5. Scroll to the top of the log window and locate your 10-digit Subscriber ID
  6. Paste your Subscriber ID into the Insights URL to display your NuoDB Insights Dashboard:{subscriberID}


HOW TO SET UP NUODB INSIGHTS for Bare-metal/VM Deployments*

Step 1: Start the NuoDB Database

Follow the instructions in the NuoDB documentation to start your NuoDB database. You can either refer to the Getting Started section or refer to the Domain Administration and Database Operations sections if you are customizing your deployment. For example, you may want to configure TLS security or customize database memory configuration.

STEP 2: Start NuoDB Insights

  1. On any host NuoDB Admin is installed, run: 
  2. Read through terms & conditions message and enter "Y" to agree to install Insights
    • Once you agree to the terms, your 10-digit Subscriber ID will be displayed
  3. If you chose to configure your database using TLS security, to enable NuoDB Insights to use TLS security, copy your existing client authorization .pem file to nuodb_insights.pem and place it in your /etc/nuodb/keys directory. For example:
    cp nuocmd.pem /etc/nuodb/keys/nuodb_insights.pem
  4. Paste your Subscriber ID into the Insights URL to display your NuoDB Insights Dashboard:{subscriberID}

*For Legacy NuoAgent domain and database management that was available in NuoDB 3.X, see Deprecated Documentation for instructions on how to start NuoDB Insights.

That's it! you're well on your way to optimizing your nuodb Database environment. 


Have questions?

Visit the NuoDB Community Forum to look for help and post your question!

NuoDB Community Forum