Process Group Configuration

Home > Select Project > Laboratory > Process Group Setting

Process Group Setting is a configuration menu for grouping processes by server in a project using pattern-based rules. Instead of grouping individual processes one by one in the server detail view, you can create and manage process groups for multiple servers in one place. The project Edit or Alert settings role is required. The configured process group name is collected as the name field in the infra_process_group category.

Note

For more information about roles, see the following document.

Adding a process group

1. Select a Server Monitoring project from the Home screen.

2. Select Laboratory > Process Group Setting.

3. Click the + Process group Add button in the upper right corner of the screen.

4. When the group configuration window opens, enter the following fields.

   Item	Description
   Process group name (required)	Enter a process group name. Use $1 or $2 to split groups by the text matched by the parentheses in the process pattern. For more information, see Process pattern extraction.
   Process pattern (required)	Enter the process pattern to include in the group as a regular expression. (e.g. java*yard*)
   Process exclude pattern	Enter the process pattern to exclude from the group as a regular expression. (e.g. except)
   Process user (required)	Enter the user information that runs the processes defined by the pattern.
   Activation	Set whether to activate the group. You can save the group even in an inactive state.

5. Click the Add button. Processes matching the configured pattern are grouped together.

   • Process names are based on the process names displayed on the screen.

   • Process group configuration applies only to the selected servers in the project.

   • Groups added via Grouping in the existing server detail view cannot be managed in Process Group Setting.

Process pattern extraction

When you use $1 or $2 in Process group name, the group name is built from the text matched by the parentheses ( ) in Process pattern. A separate group is created for each extracted value, so one rule can split multiple processes into groups. You do not need to create a separate rule for each JAR file.

If the group name does not contain $ followed by a number, pattern extraction does not apply, and one group is created with the entered name as before.

Info

Process pattern extraction is supported on agent 2.9.27 or later for Linux and Windows, and 1.4.18 or later for Unix (AIX, HP-UX, Solaris). On earlier versions, the entered name (such as $1) is used as is for a single group.

Examples

The following examples group processes whose command line contains whatap.server.front.jar or whatap.server.yard.jar.

Process group name	Process pattern	Resulting groups
$1	/whatap\.server\.(\w+)\.jar	front, yard
$1	/(whatap\.server\.\w+\.jar)	whatap.server.front.jar, whatap.server.yard.jar (entire file name)
whatap-$1	/whatap\.server\.(\w+)\.jar	whatap-front, whatap-yard
$1_svc	/whatap\.server\.(\w+)\.jar	front_svc, yard_svc
$0	whatap\.server\.\w+\.jar	whatap.server.front.jar, whatap.server.yard.jar (entire matched string)
$1	python3? .*?([\w-]+)\.py	One group per Python script name (e.g. daily_report)
$1-$2	(java|python3?) .*?([\w.-]+)\.(?:jar|py)	Combination of two groups (e.g. java-whatap.server.front)

Syntax rules

• $0 is the entire string matched by the pattern.

• $1 and $2 are numbered in the order of opening parentheses (, counted from the left.

• (?: ) groups without assigning a number.

• $12 is read as group 12. To put a digit right after $1, insert a separator, such as $1-2.

• ${1}, $name, and $$ are not supported.

• The regular expression is matched against the entire command line of the process. A partial match counts as a match.

• Matching is case-sensitive.

• If the pattern matches multiple times, the leftmost match is used.

How it works

• If the referenced group does not exist or is empty, the entered name (e.g. $1) is used as is for the group.

• Fixed-name rules are evaluated first, followed by pattern extraction rules. Each process belongs only to the first rule it matches.

• Each rule can create up to 20 groups, and each server can have up to 100 pattern extraction groups in total. Processes beyond these limits are combined into one group with the entered name as is.

• Group names can be up to 128 characters. Longer names are truncated.

• When no process matches, a fixed-name rule is displayed with a process count of 0, but a pattern extraction rule is not displayed.

• If an extracted name is the same as the fixed name of another rule, they are merged into one group.

Precautions

• Avoid broad captures. With (.*)\.jar, the entire front part of the command line becomes the group name.

• Do not capture values that differ per process, such as numbers, dates, ports, or PIDs. A new group is created for each process, and groups that disappear remain as rows with a value of 0 for 24 hours.

• Wrap parts that do not need a number in (?: ) so that group numbers do not shift.

• A repeated group keeps only the last match. To capture the entire repetition, wrap it in another pair of parentheses, such as ((?:...)+).

• When editing whatap.conf directly, enter each backslash twice (e.g. \\w). Saving from the service screen handles this automatically.

Specifying group application targets

You can specify the range of servers to which the process group applies. In addition to selecting individual servers one by one, you can specify targets by the entire project, OS type, or host name pattern.

Item	Description
All	Apply the group to all servers in the project
Direct server selection	Directly select the servers to apply the group to
OS type pattern	Apply the group to servers matching the specified OS type
Host name pattern	Apply the group to servers matching the specified host name pattern

Note

If you do not specify application targets, the specific-server selection method is used by default.

The OS type pattern and host name pattern are entered as wildcards, not regular expressions, and are case-insensitive. If you specify multiple patterns, a server that matches any one of them becomes a target.

Process grouping is supported on agent 2.9.18 or later for Linux and Windows, and 1.4.9 or later for Unix (AIX, HP-UX, Solaris). Agents that do not meet the condition cannot be selected as targets.

Matched server preview

When you specify targets with a host name pattern or an OS type pattern, you can check the list of servers that actually match the entered pattern before saving. Once you enter a pattern, the number of matched servers and the server list are displayed on the screen. Use it to check before saving whether the range is specified more broadly or narrowly than intended.

• Before a pattern is entered, only a guide message is displayed; once you enter a pattern, it changes to the matching result.

• You can use up to two wildcards (*) in one pattern. Entering three or more displays a warning.

• You can register up to 10 patterns.

The search on the process group list screen has also been improved. You can search groups by application target, and the switch column that changes the activation status has moved to the front of the list.

Editing a process group

1. Select Laboratory > Process Group Setting.

2. Click the Manage icon for the group you want to edit.

3. Change the fields in the group configuration window, then click the Save button.

Copying a process group

You can copy a process group to one or more projects at once. Use this when reusing the same group configuration across multiple projects.

1. Select Laboratory > Process Group Setting.

2. When you select one or more groups to copy, a Copy button appears at the top. Click Copy to open the process group copy window.

3. Select the target projects to copy to. You can select multiple projects at once, including the current project.

4. Click Copy. The selected groups are created as new groups in each target project.

• Copies are created with the same group name as the original.

• Copies are always created in an inactive state. Check the configuration in each project, then activate them.

• Only projects for which you have edit (modify) permission can be selected as copy targets.

• The process group configuration feature must be enabled in the target project to check and manage the copied groups.

• If a group with the same name already exists in the target project, it is skipped and not copied to that project.

Note

Handling of group application targets (server selection)

When the original group's application target uses the specific-server selection method, the selected server list is not copied when you copy it to another project, because the server list differs per project. Application targets specified by OS type pattern or host name pattern are independent of the project and are copied as is.

Deleting a process group

1. Select Laboratory > Process Group Setting.

2. Click the button on the right side of the row of the group you want to delete.

3. When the confirmation message appears, click the Delete button.

Caution

Historical data for deleted process groups is retained, but no new data will be collected afterward.