To ensure efficient management and high availability of the Adeptia Suite for various business requirements, you may need to monitor the status and performance of Adeptia Suite. For this, you need to understand the usage of various resources such as memory, log database, and repository database etc.
Adeptia Suite enables you to monitor the performance of the Adeptia server with the help of various parameters. To monitor various parameters of Adeptia Suite, you need to give your request in the form of a HTTP request. The current values of these parameters are retuned in the XML data.
This chapter enables you to understand that how can you monitor the performance of the Adeptia server and which parameters are displayed. In addition, it also explains how this information is presented to the user.
In the Adeptia Suite, this feature is available in:
Enterprise | Premier | Professional | Express |
|---|---|---|---|
√ | √ | √ | √ |
Prerequisites
You must start the Kernel and the WebRunner before monitoring the Adeptia server.Creating a User Group
Adeptia Suite enables you to monitor the performance of the Kernel and WebRunner separately. In addition, you can also monitor the performance of the complete cluster as well.
To monitor the Adeptia Suite, you need to send a request as a HTTP URL. The format for the HTTP URL is:
http://<hostname>:<port>/adeptia/control/monitorMatrix?monitorFlag=<monitorflag>&matrixFlag=<matrixflag>
Here,
<hostname> in the address is the name of the Server on which Adeptia Suite is running.
<port> is the Web server HTTP port number i.e. on which HTTP Adeptia Suite WebRunner is running. By default, Adeptia Suite WebRunner runs at 8080 port.
<monitorflag> is used to define the JVM for which you want to monitor the performance. <monitorflag> can have any of the following three values:- kernel
- webrunner
- cluster
- When you set kernel as the monitorflag, then parameters of kernel JVM are displayed.
- When you set webrunner as the monitorflag, the parameters of webrunner JVM are displayed.
- When you set cluster as the monitorflag, status of all nodes of the cluster are displayed.
- When you set <monitorflag> to cluster then you need not provide any value for the <matrixflag>. Then the format for the HTTP URL is:
http://<hostname>:<port>/adeptia/control/monitorMatrix?monitorFlag=<cluster>
<matrixflag> is used to define the category of parameters for which you want to monitor. Each category of parameters has a set of properties. The <matrixflag> can have any of the following values:
- memory
- gc
- thread
- repositoryDB
- logDB
- all
- default
Table 5 lists these categories and the parameters displayed in each category.
Table 5
Category | Parameter | Description |
|
|---|---|---|---|
memory | UP-TIME OF JVM | Up-time of the JVM shows how long the JVM has been running. |
|
| HEAP MEMORY | Heap Memory is the storage for Java objects. Heap memory is the run-time data area from which the JVM allocates memory for all class instances and arrays. |
|
| MAX MEMORY | MAX Memory is the maximum amount of memory to which heap can grow. |
|
| USED MEMORY | USED Memory is the amount of heap memory in use. |
|
| COMMITTED MEMORY | Committed Memory is the amount of memory allocated to heap. |
|
| INIT MEMORY | Init Memory is the amount of memory, which JVM initially requests from Operating System for memory management. |
|
| NON-HEAP MEMORY | Non-heap memory includes a method area shared among all threads and memory required for the internal processing or optimization for the JVM. Non-heap Memory is used by Java to store loaded classes and other meta-data. |
|
| MAX MEMORY | MAX Memory is the maximum amount of memory that can be used for memory management. |
|
| USED MEMORY | USED Memory is the amount of memory currently used. Memory used includes the memory occupied by all objects. |
|
| COMMITTED MEMORY | Committed Memory is the amount of memory guaranteed to be available for use by the JVM. |
|
| INIT MEMORY | Init Memory is the amount of memory, which JVM initially requests from Operating System for memory management. |
|
gc | GARBAGE COLLECTION | Garbage Collection (GC) is how the JVM frees memory occupied by objects that are no longer referenced. It is the process of releasing memory used by the dead objects. |
|
| GARBAGE COLLECTOR NAME | Garbage Collector Name is the name of the memory manager. |
|
| GARBAGE COLLECTIONS | Garbage Collections are the total number of collections that have occurred. |
|
| TOTAL TIME SPENT | Total Time Spent is the approximate accumulated collection elapsed time. |
|
thread | PEAK THREAD | Highest number of live threads since JVM started. |
|
| PEAK THREAD COUNT | Counts the peak live thread since the JVM started or peak was reset. |
|
| LIVE THREAD | Current number of live daemon threads plus non-daemon threads |
|
| LIVE THREAD COUNT | Counts the current number of live threads including both daemon and non-daemon threads. |
|
| DAEMON THREAD | Threads that work in the background to support the runtime environment are called daemon threads. |
|
| THREAD DEADLOCK COUNT | Counts the number of threads that are in deadlock waiting to acquire object monitors or synchronizers that can be owned. |
|
logDB/ repositoryDB | DATABASE MATRIX TYPE | It shows the type of database. The database can be log database and repository database. |
|
| STATUS | It shows whether the connection to database is active or not. Its values are UP/DOWN. |
|
| ACTIVE CONNECTION COUNT | Counts the current number of active connections that have been allocated from the data source. |
|
| IDLE CONNECTION COUNT | Counts the current number of idle connections that are waiting to be allocated from the data source. |
|
| QUERY RESPONSE TIME | It describes the response time of SQL statement issued to database. By default, Query Response Time is not displayed. To know how to view Query Response Time, refer to section Monitoring Query Response Time. |
|
cluster | CLUSTER NODE MATRIX | A cluster is a group of independent Adeptia Suites working collectively as a single system. |
|
| NODE NAME | It shows the IP address of the nodes that are a part of cluster. |
|
| TYPE | It specifies the type of node that is PRIMAY (SERVER) or SECONDARY (MEMBER). |
|
| STATUS | It specifies if a node is up (running) or not. |
|
| NETWORK LINK | It specifies if network link to this node is UP/DOWN. |
|
all | It displays every parameter of all categories. | ||
default | It displays set of default parameter. To know how to define default parameters, refer to Configuring Default Monitoring Parameters. | ||
The performance of Adeptia Server is presented in the XML format. In response to the request sent to Adeptia Suite in the form of URL, an XML page is displayed. This XML page displays the information with respect to the flags passed in the URL.
For example, if Adeptia Suite is running on your local machine and if you hit the following URL:
http://localhost:8080/adeptia/monitorMatrix?monitorFlag=kernel&matrixFlag=memory
The following XML response is returned. This page displays values of different memory parameters of kernel (see Figure 1).
Figure 1: The Performance Matrix XML page
Values for parameters are displayed in the default units. For example, value of memory is displayed in MB. To change this unit, open the monitoring-matrix.properties file and change the required properties.