2.4.2 Updating an instance environment
To update an instance environment, check the name of the instance that you want to update, and change the instance information. Update an instance environment on a PFM - Agent host.
Before you change an information item, check the following table. For details about Microsoft SQL Server instance information, see your Microsoft SQL Server documentation.
|
Item |
Description |
Specifiable value |
Default value |
|---|---|---|---|
|
Microsoft SQL Server instance name |
This item is not updatable. The current setting is displayed only. |
-- |
-- |
|
SQL_HOST |
This item is updatable. Microsoft SQL Server host name for a monitoring target. If the Microsoft SQL Server host is a logical host, specify the logical host. |
-- |
Previous value |
|
SQL_USER |
This item is updatable. Specifies the user name for Microsoft SQL Server authentication. (A character string of 128 or fewer bytes.) |
-- |
Previous value |
|
SQL_PASSWORD |
This item is updatable. Specifies the password of the Microsoft SQL Server user used for Microsoft SQL Server authentication. |
-- |
Previous value |
|
DRIVER_NAME |
Specifies the driver name used for communication with Microsoft SQL Server. Change the name when monitoring Microsoft SQL Server version 2016 or later and encrypting communication using the monitored Microsoft SQL Server settings. Specifies the default SQL Server (Windows standard driver) when monitoring Microsoft SQL Server 2014 or earlier, or when monitoring Microsoft SQL Server 2016 or later and communicating in plaintext. |
{SQL Server | SQL Server Native Client 11.0 | ODBC Driver 17 for SQL Server} |
Previous value |
|
SQL_ERRORLOG |
This item is updatable. Specify the absolute path of the error log file for the monitored Microsoft SQL Server instance, by using single-byte characters. Even when the file name or path includes single-byte space characters, do not surround it with quotation marks ("). |
A character string of 512 or fewer bytes that does not include the following characters:
|
Previous value |
|
STARTUP_PENDING |
This item is updatable. Specify the pending time from when PFM - Agent for Microsoft SQL Server starts until it transfers to normal processing. |
0 to 3,600 (seconds) Pending is not performed when 0 is specified. |
Previous value |
|
LOG_PATH |
This item is updatable. Specifies the full path name of the folder for storing agent log information. If you specify a path containing space characters, do not enclose the path in quotation marks ("). |
A character string of 245 or fewer bytes that does not include the following characters:
|
Previous value |
|
LOG_SIZE |
This item is updatable. Specifies the maximum size of one agent log file. |
1 to 32 (megabytes). The minimum recommended value is 16. |
Previous value |
|
TIMEOUT |
This item is updatable. Specifies the query timeout value for database access. |
1 to 3,600 (seconds) |
Previous value |
|
LOGIN_TIMEOUT |
This item is updatable. Specifies the access timeout value for database access. The value is in seconds. |
1 to 3,600 (seconds) |
Previous value |
|
DB_FREE_PERC_OPTION |
This item is updatable. Specify how to display the values of the fields related to the percentage of free space in the PD_DS record (the Free % field and the Data Unallocate % field) when the value is negative. |
{Y | N} If Y is specified, the value specified for DB_FREE_PERC_NUMBER is displayed. If N is specified, the value of the Free % field and the Data Unallocate % field is displayed as it is when its value is negative. |
Previous value |
|
DB_FREE_PERC_NUMBER |
This item is updatable. Specify the values of the fields related to the percentage of free space in the PD_DS record(the Free % and the Data Unallocate % field) when its value is negative. The replacement is enabled only when the value of DB_FREE_PERC_OPTION is Y. |
-1 to 999 |
Previous value |
|
LIMIT_PD_LD_NUMBER |
This item is updatable. Specify the maximum number of collection records for the PD_LD record. |
0 to 900,000 If you specify 0, no upper limit is set, and all data is collected. |
Previous value |
|
LIMIT_PD_EE_NUMBER |
This item is updatable. Specify the maximum number of collection records for the PD_EE record. This item takes effect when log data is collected and when monitoring is performed by using alarms. Specify the maximum number of occurrences that can be collected during the collection interval set for Collection Interval. For detail about PD_EE record, see Errorlog Error Detail (PD_EE) of 5. Records. Note: For real-time reports, this item does not take effect, and all error records output to the Microsoft SQL Server error log are collected. |
100 to 100,000 |
Previous value |
- Legend:
-
--: No limit
Use the jpcconf inst list command to check the instance name. To update an instance environment, use the jpcconf inst setup command. For details about the command, see the chapter on the commands in the manual JP1/Performance Management Reference.
This example shows execution in the interactive mode, but you can also execute the jpcconf inst setup command in the non-interactive mode. For details about this command, see the chapter that describes commands in the manual JP1/Performance Management Reference.
Updating an instance environment involves the steps described below. To update multiple instance environments, repeat the procedure for each instance environment.
-
Check the instance name.
Execute the jpcconf inst list command specified with the service key that indicates PFM - Agent for Microsoft SQL Server.
For example, when you check the instance name of the PFM - Agent for Microsoft SQL Server, execute the following command:
jpcconf inst list -key SQL
For example, if the instance name is SQL1, the command displays SQL1.
-
Stop all the PFM - Agent for Microsoft SQL services.
If the service is still active in the instance environment that is to be updated when you execute the jpcconf inst setup command, a confirmation message is displayed to enable you to stop the service. If you stop the service, update processing resumes; if you do not stop the service, update processing is canceled.
-
Execute the jpcconf inst setup command specified with the service key that indicates PFM - Agent for Microsoft SQL Server and the instance name.
For example, if you are updating the instance environment for the PFM - Agent for Microsoft SQL Server with instance name SQL1, execute the following command:
jpcconf inst setup -key SQL -inst SQL1
-
Update the instance information for Microsoft SQL Server.
Enter the information shown in Table 2-14 in accordance with the command's instructions. The current settings are displayed. To use the displayed value, press the Enter key. When you have finished entering information, the instance environment is updated.
-
Restart the services in the updated instance environment.
For details about starting services, see the chapter on starting and stopping Performance Management in the JP1/Performance Management User's Guide.
- Note:
-
If you want to change an item that cannot be updated, delete the instance environment and then re-create it.
For details about commands, see the chapter on commands in the manual JP1/Performance Management Reference.