System administrators can view statistics about Eclipse Amlen memory by using REST Monitoring APIs.
You can view statistical information about the Eclipse Amlen memory.
The memory statistics provide information about the Eclipse Amlen volatile
memory.
System administrators can view statistics about Eclipse Amlen memory by using a REST Monitoring API, by using the Amlen WebUI, or by using an external monitoring
application. For more information about using the Amlen WebUI to view statistics about Eclipse Amlen memory, see Viewing memory statistics by using the Amlen WebUI. For more information about using
an external application to view statistics about Eclipse Amlen memory, see Viewing memory statistics by using an external
application.
Memory-related monitoring statistics can be viewed by using a REST Monitoring API. To create
memory-related monitoring statistics, complete the following steps:
-
Use the Eclipse Amlen REST
API GET method with the following Eclipse Amlen monitoring URI:
http://<admin-endpoint-IP:Port>/ima/v1/monitor/Memory
-
Provide query parameters requesting the statistics that you want returned in the JSON
payload. The following example uses cURL to create memory-related statistics:
curl -X GET http://127.0.0.1:9089/ima/v1/monitor/Memory?SubType=SubType%26Duration=Duration%26StatType=StatType
Where:
-
- SubType
- Optional.
- Specifies the time period of data to report.
- This value can be one of the following values:
-
- Current®
- View the most recent statistics.
-
- History
- View older statistics.
The default value is Current.
-
- time
- Optional.
- Specifies the time span (in seconds) of the data to be collected.
Valid
value range is 1 - 86400.
The default value is
1800.
-
- StatType
- Optional.
- Specifies the types of data to return when
SubType is set
to History.
- You can specify multiple values in a comma delimited list. This value can be
one of the following values:
-
- MemoryTotalBytes
- This statistic shows the total amount of physical memory on Eclipse Amlen.
-
- MemoryFreeBytes
- This statistic shows the amount of physical memory that is
available.
-
- MemoryFreePercent
- This statistic shows the amount of free memory as a percentage of
total physical memory.
-
- ServerVirtualMemoryBytes
- This statistic shows the amount of virtual memory that is being
used by Eclipse Amlen.
-
- ServerResidentSetBytes
- This statistic shows the amount of physical memory that is being
used by Eclipse Amlen.
-
- MessagePayloads
- This statistic shows the amount of memory that is being consumed
by Eclipse Amlen
for message payloads.
-
- PublishSubscribe
- This statistic shows the amount of memory that is being consumed
by Eclipse Amlen
for publish/subscribe data structures. For example, topics and
subscriptions.
-
- Destinations
- This statistic shows the amount of memory that is being consumed
by Eclipse Amlen
for destinations on which messages can be buffered. For example,
queues.
-
- CurrentActivity
- This statistic shows the amount of memory that is being consumed
by Eclipse Amlen
for current activity. For example, transactions and message
acknowledgements.
-
- ClientStates
- This statistic shows the amount of memory that is being consumed
by Eclipse Amlen
for connected and disconnected clients.
The default value is MemoryTotalBytes.
If the SubType is set to History,
and monitoring data is not available for the requested statistic,
a value of -1 is returned.
For more information
about the fields that are returned, see Memory Monitoring.
The following example uses cURL to show how a GET method is used to view statistical
information about the Eclipse Amlen volatile
memory.
curl -X GET http://127.0.0.1:9089/ima/v1/monitor/Memory?SubType=Current
The following example shows a successful example response to the GET method that was used to
create statistical information about the Eclipse Amlen volatile memory:
{ "Version":"v1", "Memory": { "MemoryTotalBytes":7934193664, "MemoryFreeBytes":5428342784, "MemoryFreePercent":68,
"ServerVirtualMemoryBytes":2334150656, "ServerResidentSetBytes":795844608, "MessagePayloads":1048576, "PublishSubscribe":9961472,
"Destinations":6299616, "CurrentActivity":3149808 , "ClientStates":524288 } }