7.1.9 Object monitoring definition window
In the Object monitoring definition window, you can view and edit object monitoring definitions in detail.
|
The following shows the display items and input restrictions for the Object monitoring definition window:
- Definition name
-
Enter the definition name of the monitoring definition information. It is saved in the format of /definition-name. It cannot be changed when editing.
- Comment
-
Enter a description of monitoring definition information.
- JP1 resource group
-
Enter the JP1 resource group of the monitoring definition information.
- Outline tab
-
This tab shows the outline of the items in the right-hand definition area in a tree format. Clicking an item in the outline jumps to its corresponding item in the right-hand definition area.
- Cautionary note
-
With an item hidden in the right-hand definition area, clicking the corresponding
item in the outline does not jump to the item. Open the hidden item in the right-hand definition area in advance.
- Variable information tab
-
Displays the variable information defined by each item in the definition area on the right side and the variable information that is reserved by the system and available by default.
- Export button
-
Clicking this button outputs the monitoring information being displayed as the service linkage objects monitoring definition file (slobjmondefExport.txt). This file will be output to the download folder set by the Web browser.
For details about the service linkage objects monitoring definition file, see G.1 Service linkage objects monitoring definition file.
- Note
-
Even during input of monitoring definitions, a service linkage objects monitoring definition file can be exported.
- Import button
-
Click this button to display the Open dialog allowing you to select a service linkage objects monitoring definition file to be reflected to the screen. Select a service linkage objects monitoring definition file. It will be reflected on the Object monitoring definition window.
For details about the format of service linkage objects monitoring definition files that can be imported, see G.1 Service linkage objects monitoring definition file.
- Note
-
Even during input of monitoring definitions, a service linkage objects monitoring definition file can be imported.
- Register button
-
Click this button to register monitoring information input in the Object monitoring definition window to JP1/AJS3 for Cloud Service Applications. When registration is successfully completed, the Home window is displayed.
If an error occurs, the item with the error is highlighted.
- Back button
-
Go to the Home window without doing anything.
No.
Display item
Input format
Input restriction
Required/Not required
Assumed value
1
Definition nameDefinition name
Text box
Character string of 1 to 30 bytes.
Single-byte alphanumeric characters, - (hyphen), and _ (underscore) are available.
Required
None
2
Comment
Text box
Character string within 243 bytes.
Not required
None
3
JP1 resource group
Text box
Character string within 63 bytes.
Single-byte alphanumeric characters and _ (underscores) are available.
Not required
JP1_CSA
- Organization of this subsection
(1) Variable settings
This section describes the Variable settings in the Object monitoring definition window.
|
The following shows the display items for Variable settings.
- AJS3 - View custom input items
-
Display added variables and the list of AJS3 - View label names.
- Add button
-
Click this button to open the Setting variables dialog box. Up to 15 variables can be added. For details about this dialog, see 7.1.9(3) Setting variables dialog box.
- Delete button
-
Click this button to delete the variable for the selected row.
- Edit button
-
Click this button to open the Setting variables dialog box with the variable for the selected row. For details about this dialog, see 7.1.9(3) Setting variables dialog box.
- ↑ button
-
Move the variable in the selected row one row up.
- ↓ button
-
Move the variable in the selected row one row down.
- Environment variables for the execution host
-
Display added variables and a list of environment variables.
- Add button
-
Click this button to open the Setting variables dialog box. Up to 32 variables can be added. For details about this dialog, see 7.1.9(3) Setting variables dialog box.
- Delete button
-
Click this button to delete the variable for the selected row.
- Edit button
-
Click this button to open the Setting variables dialog box for the selected row. For details about this dialog, see 7.1.9(3) Setting variables dialog box.
- ↑ button
-
Move the variable in the selected row one row up.
- ↓ button
-
Move the variable in the selected row one row down.
(2) Monitoring processing settings
This section describes the Monitoring processing settings in the Object monitoring definition window.
|
The following shows the display items and input restrictions for Monitoring processing settings.
(a) Monitoring processing
■ Execution command settings
- Command line
-
Enter the command line to run.
- Settings on monitoring information to be extracted from the command output result (JSON)
-
Enter the JMESPath query syntax to extract the object name and information subject to update monitoring from the output results of the executed command.
For details about content specified to this item, see 6.2.1(3) Processing for extracting object information on the cloud service.
- Environment variables at time of command execution
-
Enter an environment variable to be used for command line execution in environment-variable-name=environment-variable-value format. When specifying multiple variables, enter a line break for each one.
No.
Display item
Input format
Input restriction
Required/Not required
Assumed value
1
Command line
Text box
Character string within 1,023 bytes.
A tab character can also be specified.
You can specify a variable in this input item.
Also, specify @CSA(characters-to-escape)ASC@ at locations where escaping is required. For details, see 4.3.3 Escaping a command line for cloud service linkage information.
Required
None
2
Object name
Text box
Character string within 256 bytes.
Double quotes (") and single quotes (') cannot be used.
Required
None
3
Update monitoring target 1
Text box
Character string within 256 bytes.
Double quotes (") and single quotes (') cannot be used.
Not required
None
4
Update monitoring target 2
Text box
Character string within 256 bytes.
Double quotes (") and single quotes (') cannot be used.
Not required
None
5
Update monitoring target 3
Text box
Character string within 256 bytes.
Double quotes (") and single quotes (') cannot be used.
Not required
None
6
Environment variables at time of command execution
Text box
Character string within 20,479 bytes.
No line break is counted as part of the character string above.
A tab character can also be specified.
Up to 27,304 characters can be entered.
You can specify a variable in this input item.
Not required
None
■ Execution result judgment
- Return code judgment - Abnormality judgment condition
-
Enter the abnormality judgment condition of the return code of the execution command.
- Settings for abnormal end
-
Select the response when an abnormality occurs from the following:
-
Abnormal end occurs
Abnormally end the service linkage object monitoring job.
-
Monitoring continues
Continue monitoring regardless of the return code. If this item is selected, Job return code, Output settings for detailed execution results, and Log output settings are hidden from view.
-
- Job return code
-
Enter the return code of the job when ended abnormally.
- Output settings for detailed execution results
-
Select content to be output to detailed execution results when a job ends abnormally.
- Output the executed command line
-
Select whether to output the executed command to detailed execution results.
- Output the standard output
-
Select whether to output the standard output of executed commands to detailed execution results.
- Output the standard error output
-
Select whether to output the standard error output of executed commands to detailed execution results.
- Log output settings
-
Select content to be output to the log when a job ends abnormally.
- Output the standard output
-
Select whether to output the standard output of executed commands to the log.
No.
Display item
Input format
Input restriction
Required/Not required
Assumed value
1
Job return code
Text box
A numerical value between 101 and 150.
Required
110
■ Trace information settings
- Log output settings
-
Configure settings for output to the service linkage objects monitoring job log file for each monitoring interval. For details about service linkage monitoring job logs, see 9.2.7 Service Linkage Monitoring Job Log.
- Output the executed command line
-
Select whether to output the executed command line to the log.
- Output the standard error output
-
Select whether to output the standard error output of executed commands to the log.
(b) Passing information settings
Enter the values stored for passing information names OBJECT01 to OBJECT10 in a custom event job when the service linkage objects monitoring job ends normally. Variables can be specified for all items.
No. |
Name of passing information to be used as the storage destination |
Input format |
Input restriction |
Required/Not required |
Assumed value |
---|---|---|---|---|---|
1 |
OBJECT01 |
Text box |
Character string within 256 bytes. |
Not required |
?CSAONAME? |
2 |
OBJECT02 |
Text box |
Character string within 256 bytes. |
Not required |
None |
3 |
OBJECT03 |
Text box |
Character string within 256 bytes. |
Not required |
None |
4 |
OBJECT04 |
Text box |
Character string within 256 bytes. |
Not required |
None |
5 |
OBJECT05 |
Text box |
Character string within 256 bytes. |
Not required |
None |
6 |
OBJECT06 |
Text box |
Character string within 256 bytes. |
Not required |
None |
7 |
OBJECT07 |
Text box |
Character string within 256 bytes. |
Not required |
None |
8 |
OBJECT08 |
Text box |
Character string within 256 bytes. |
Not required |
None |
9 |
OBJECT09 |
Text box |
Character string within 256 bytes. |
Not required |
None |
10 |
OBJECT10 |
Text box |
Character string within 256 bytes. |
Not required |
None |
(3) Setting variables dialog box
The Setting variables dialog box is displayed for adding a new variable by clicking Add or editing an existing variable by clicking Edit in the AJS3 - View custom input items or Environment variables for the execution host.
|
|
The following shows the display items and input restrictions for the Setting variables dialog box:
- Variable name
-
When the system is started with the AJS3 - View custom input items, enter a variable name in the ?CSAOxxxx? format with xxxx replaced with the desired value. This variable stores details entered on the details definition screen of the service linkage job of JP1/AJS3 - View and sets information to be passed. When the system is started with the Environment variables for the execution host, enter the name of the variable that stores the value of the environment variable set on the execution host for the service linkage objects monitoring job and sets the information to be passed.
- AJS3 - View custom input item
-
This item is displayed only when you click the Add or Edit button in AJS3 - View custom input items.
- Label
-
Enter the label name of the input item on the detailed definition screen of the service linkage objects monitoring job of JP1/AJS3 - View.
- String length
-
Enter the input string length in the detailed definition screen of the service linkage objects monitoring job of JP1/AJS3 - View.
- Prohibited characters
-
Enter characters with a regular expression that are to be prohibited to input on the detailed definition screen of the service linkage objects monitoring job of JP1/AJS3 - View.
Available regular expressions are those that can be used in the .NET Framework. For details, see the related documents provided by Microsoft Corporation.
- Environment variable name
-
This item is displayed only when you click the Add or Edit button in Environment variables for the execution host.
Enter an environment variable name to be stored in the variable.
- OK button
-
Click this button to register the variable with the entered information.
- Cancel button
-
Closes the Setting variable dialog box without doing anything.
No.
Display item
Input format
Input restriction
Required/Not required
Assumed value
1
Variable name
Text box
Character string within 58 bytes.
A to Z (uppercase alphabetical letters) and 0 to 9 (Arabic numbers) are available.
Required
None
2
Label
Text box
Character string within 60 bytes.
Required
None
3
String length
Text box
A numerical value between 1 and 12,000.
Required
12000
4
Prohibited characters
Text box
Character string within 95 bytes.
Not required
None
5
Environment variable name
Text box
Character string within 64 bytes.
Required
None