4.1.16 Information to be set for using Administration Agent
This subsection describes the information to be set for using the Administration Agent.
- Organization of this subsection
(1) Setting the Administration Agent property
You can specify the information such as the port number used by the Administration Agent in the Administration Agent Property file (adminagent.properties).
-
adminagent.adapter.port
Specify the port number used by the Administration Agent for communicating with the Management Server.
In addition to this, you can also set the collection destination for a snapshot log. For details on the settings of the collection destination of a snapshot log, see the following subsections in the uCosminexus Application Server Maintenance and Migration Guide:
-
3.3.3 Setting Snapshot Log Collection (Systems executing J2EE applications)
-
3.3.4 Setting Snapshot Log Collection (Systems executing Batch applications)
(2) Settings for the monitoring of logical servers by Administration Agent
When operating the system, you can use the management command (mngsvrutil) of the Management Server to check the status of logical servers, and learn about the start/stop status of the logical server. When using the Management Server to manage the logical servers, the Administration Agent periodically monitors the process and checks the operations for the logical server, and notifies the logical sever status to the Management Server. The Administration Agent can change the level and interval settings when checking the operations of the logical servers. Set the items related to the operation check of the logical servers in the adminagent.properties, as and when required. For details on the auto-restart of the logical server in the event of failure, see 2.4.3 Automatic restart of logical server in the uCosminexus Application Server Operation, Monitoring, and Linkage Guide.
- Reference note
-
When using the Management Server for operation check of Web Servers, a separate log for operation check can be output, along with the normal logs (error log, access log, and request log). For details on how to set, see 3.3.8 Settings for Acquiring the Web Server Log in the uCosminexus Application Server Maintenance and Migration Guide.
-
Setting the level of operation check for logical servers
In the Administration Agent, you can determine whether the logical server is operating normally, by checking the process existence or by accessing the logical server. Specify the level of operation check for logical servers in the adminagent.type-of-logical-server.watch.level key. Change the level of operation check for the logical servers, as and when required. You can specify only 1 or 2. If you specify 1, the operations of the logical server are checked only by confirming the process existence, whereas if you specify 2, the operations are checked by confirming the process existence and by actually accessing the logical server. The value that can be specified differs depending on the type of the logical server. Note that if only SSL communication is enabled on the Web Server, change the level of operation check for logical Web Server (Set adminagent.hws.watch.level=1) to only confirming the process existence.
-
Setting the interval for operation check of logical servers
Specify the interval (seconds) for operation check of logical servers in the adminagent.type-of-logical-server.watch.interval key. The default value is 10 seconds. You can change the operation check interval of the logical server as needed.
When changing the operation check interval of the logical server, make sure that the operation check interval of the logical server (in seconds) is shorter than the stop monitoring time (in minutes) or forced stop monitoring time (in minutes). If the operation check interval is longer than the monitoring time of the logical server, attempts to stop or forcibly stop the logical server might be unsuccessful.
-
Setting timeout for the operation check of logical servers
Specify the timeout period (seconds) for operation check of logical servers in the adminagent.type-of-logical-server.watch.timeout key. The default value is 60 seconds. Change the timeout period for the operation check of logical servers, as and when required.
-
Setting retry count for the operation check of logical servers
Specify the number of retries for operation check of logical servers in the adminagent.type-of-logical-server.watch.retry_count key. The default value is one.
You can also specify whether to retry the timeout, in the adminagent.watch.retry_timeout.enabled key. The default value is false (do not retry). Note that during new installations, true (retry) is specified.
Change the retry settings for the operation check of logical servers, as and when required.
-
Setting start time for the operation check of logical servers
Specify the time (seconds) from the start of the logical server up to starting the operation check (operation check level 2) in the adminagent.type-of-logical-server.watch.start_time key. The default value differs depending on the type of the logical server. Change the start time for the operation check of the logical servers, as and when required.
When changing the start time for operation check of the logical server, make sure that the "Start time for operation check of the logical server (seconds) < Time to monitor the start of the logical server (minutes)" is set. You can set the time to monitor the start of the logical server by using the Start/Stop Settings window of the Start/ Stop Logical Server in Management portal. The logical server fails to start if the startup monitoring time is smaller than the start time of the operation check.
(3) Setting the operation check for Cosminexus HTTP Server
In the Management Server, you can manage the Cosminexus HTTP Server as a Web Server. Verification of HTTP Server operation is achieved by sending a request via HTTP to the port whose port number is specified by the last Listen directive in the web server definition file (httpsd.conf).
Therefore, if the last Listen directive is set to enable SSL, HTTP Server operation cannot be verified.
Make sure that the last Listen directive is set to disable SSL.
If all Listen directives in the web server definition file (httpsd.conf) are set to enable SSL, a client that accesses the HTTP Server only checks for the existence of the process and skips verification of HTTP Server operation.
This section describes the settings of HTTP method for operation check, and the URL settings for Cosminexus HTTP Server operation check. However, you can set the URL for Cosminexus HTTP Server operation check, only if HEAD is specified in the HTTP method settings for operation check.
-
Setting HTTP method for the operation check
Specify the HTTP method for Cosminexus HTTP Server operation check when 2 (to check the operations by confirming the process existence and by actually accessing the logical server) is specified in the level of operation check for the logical servers (adminagent.type-of-logical-server.watch.level key). You can specify HEAD or OPTIONS only. If you specify HEAD, system checks whether the response is sent by accessing the URL set in the URL for Cosminexus HTTP Server operation check (adminagent.hws.watch.url key). Also, if you specify OPTIONS, system checks whether the Web Server is in a condition to receive the HTTP method.
If you specify OPTIONS, and the access to the root directory from all hosts is prohibited in the Cosminexus HTTP Server settings, then the access that is required for the operation check from the Administration Agent is also denied. As a result, you cannot judge operations correctly, and Cosminexus HTTP Server fails to start. In such cases, the permission to access from the loop back address (fixed IP address if the hosts are fixed) needs to be given. Note that the you cannot judge operations correctly even if the access is restricted such as when basic authentication settings are done.
-
URL settings for Cosminexus HTTP Server operation check
The Administration Agent determines whether the Cosminexus HTTP Server is operating normally, by periodically performing dummy access to the set URL. In situations where the response to dummy access is not received (not responding condition), the Administrator Agent judges the Cosminexus HTTP Server as abnormal, and detects the failure. Therefore, when using a Web Server set a URL that can actually be accessed as the URL for operation check. Specify the URL for Cosminexus HTTP Server operation check in the adminagent.hws.watch.url key.
Specify an absolute path starting with "http", or a relative path from the root context as the URL. The default value is the root context (http://localhost:port-number/). Specify the relative path for setting up multiple Web Servers on the same host.
Example:
-
The following is an example of specifying http://HostA:80/index.html as the URL for operation check:
adminagent.hws.watch.url=http://HostA:80/index.html
-
The following is an example of specifying http://localhost:port-number/index.html as the URL for operation check (for multiple Web Servers):
adminagent.hws.watch.url=index.html
-