Troubleshooting
Problem
The purpose of this document is to highlight the tools available to help with understanding the memory usage of a Planning Analytics as a Service database
Cause
Common Causes for High Memory Usage:
- Cube data has increased (regular usage, or erroneous spreading on a consolidation)
- Model design / overfeeding in cube rules (feeding more cells than required)
- Large user queries
Additional Considerations:
- Memory will increase and can be held for the remainder of a user's session
- Log out of the application when done, don't rely only on idle timeout
- Ensure any cellsets created by API are deleted and sessions properly closed
- Memory is also required to perform backups
Be mindful of automatic backup schedule
Diagnosing The Problem
Determine expected memory usage
- Perform load testing and monitoring, recording results
- How much memory is in use compared to previous testing / previous peak times?
- How has the data, model, or load/usage changed?
- How much memory is in use compared to previous testing / previous peak times?
- Record and monitor running Jobs on the database for review: https://www.ibm.com/support/pages/how-retrieve-and-cancel-jobs-running-planning-analytics-service-database-using-rest-api
- Additional database metrics available at following endpoint: {{host}}/api/{{tenant}}/v0/tm1/{{tm1db}}/Metrics()
Database Memory Alerts
- Utilize database alerts to be notified when memory exceeds a specified threshold
- Navigate to Planning Analytics Workspace > Administration > Databases
- Select the database name, and click the Alerts tab
- Configure an appropriate Warning and Critical threshold (based on test results)
- Enable the alert and specify your email address
Database Detail Page
- Navigate to Planning Analytics Workspace > Administration > Databases
- Select the database name, and review the Details tab
- Memory usage for all Replicas is displayed
Database Server Logs
- Navigate to Planning Analytics Workspace > Workbench
- Right-click the database name, select Logs > Server log
- Review the server log for the TM1.Server.Memory logger lines
- Ideal for historical usage and mapping to potential actions
Database Object Size Understanding
- At this time, the ability to understand object usage in memory is not available in the UI
- Some cube metrics are available at following endpoint: {{host}}/api/{{tenant}}/v0/tm1/{{tm1db}}/Metrics()
- A backupset of the Planning Analytics Database can be used to identify large objects, in general
- However this does not tell us how large the object is in memory
- Navigate to Planning Analytics Workspace > Administration > Databases
- Click the Backup tab and download the latest backup
- Extract the downloaded backupset archive file, sort by size and review the contents
Resolving The Problem
Guard Rails:
Consider implementing query guardrails on the database:
- MaximumGlobalQueryMemorySizeMB: https://www.ibm.com/docs/en/planning-analytics/3.1.0?topic=parameters-maximumglobalquerymemorysizemb
- MaximumSingleQueryMemorySizeMB: https://www.ibm.com/docs/en/planning-analytics/3.1.0?topic=parameters-maximumsinglequerymemorysizemb
- Tip: You can enable additional logging for troubleshooting purposes by enabling the TM1.Mdx logger at the DEBUG level. DEBUG level logging initiates extra counters and enables more detailed logging about the status of memory measures when running queries, but degrades the performance of queries. Do not enable DEBUG level logging unless you are troubleshooting the system.
Document Location
Worldwide
[{"Type":"MASTER","Line of Business":{"code":"LOB76","label":"Data Platform"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSEAI8G","label":"Planning Analytics as a Service"},"ARM Category":[{"code":"a8m3p000000GoaGAAS","label":"Planning Analytics-\u003EPlanning Analytics as a Service Specific"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":""}]
Was this topic helpful?
Document Information
Modified date:
24 March 2026
UID
ibm17233607