IDOL 24.1

# Memory Report

The `MemoryReport` action provides an overview of the memory usage of the IDOL Server component and the system it is running on. The response can be broken down into three sections:

## SystemMemoryInfo

The `<systemmemoryinfo>` section reports on available memory statistics available from the underlying operating system and tells you about how much memory is in use or free on the system.

NOTE: This section alone does not tell you if IDOL is responsible for that memory usage. It might be another process running on the same system.

You can suppress this section by setting the `SystemMemory` action parameter to `False`.

## ProcessMemoryInfo

The `<processmemoryinfo>` section reports the operating system view of the IDOL Server component's memory usage. The information available is similar to the response from the `top` command on a Unix-based system or Task Manager on a Microsoft Windows system.

You can suppress this section by setting the `SystemMemory` action parameter to `False`.

## Memory

The `<memoryN>` sections give a breakdown of memory usage as reported by subcomponents of the IDOL index.

For the Content component, part of the output shows the amount of memory attributed to numeric type fields and the breakdown of that memory by field.

You can use this information to diagnose memory usage of the component and give some insight into how the system is being used. For example, if the system is low on memory, you can find the indexes consuming the most memory, and then plan to reduce their memory usage (by configuring limits, or deciding whether that field is actually being used).

Where the memory name indicates a field identifier, you can cross-reference it against the output of the `GetTagNames` action to determine what the field is.

## Example

The following example scenario demonstrates some of the steps you might take to identify and resolve a problem.

1. An IDOL system is performing slowly, and operating system measures, indicate that IDOL is using an unexpectedly large amount of memory.

2. The `MemoryReport` action response shows that there are an unexpectedly high number of numeric fields, each using a small amount of memory.

3. The administrator maps the field identifiers back to field names, by using the `GetTagNames` action. This process shows that a small amount of test data had been indexed into the system with incorrect field names. A wildcard value in the `PropertyFieldCSVs` configuration parameter identified these incorrect field names as numeric fields.

4. The administrator removes these documents, and adjusts the numeric field property to identify fields more specifically. This operation reduces the memory usage to acceptable levels and improves system performance.

TIP: As an alternative to using the `MemoryReport` and `GetTagNames` actions, you can view information on memory usage and monitor field names in the data index in IDOL Admin. The Field Types page and the Memory and Memory Map tabs on the Performance page in the Monitor section of IDOL Admin provide this information. You can also view overall real-time performance data on a single graph on the Real Time tab.

Copyright 2023 Open Text
Version 24.1 | Last updated December 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL 24.1

Topic Title: Memory Report