1.19.3 Setup When Using JP1/IM - Agent as an agent

■ To edit the configuration files (for Windows)

Configuration file is located in the following directories:

OS	Storage destination
Windows	Manager-path\conf\imdd\plugin\jp1pccs\ Manager-path\conf\imddimagent\
Linux	/etc/opt/JP1imm/conf/imdd/plugin/jp1pccs/ /etc/opt/JP1imm/conf/imdd/imagent/

There are two ways to change configuration file:

• The way to use integrated operation viewer

• The way to Login the host and Setup

For configuration file that can be edited when integrated operation viewer is used, see the notes of the definition file for JP1/IM - Manager in List of definition files in Chapter 2. Definition Files in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference. If you want to Login and Setup the host, all configuration files can be edited.

The following are the steps for setting:

- How to use integrated operation viewer

1. Download configuration file from integrated operation viewer.

   If you add File, it does not need to be downloaded.

2. Edit the downloaded File.

3. Use integrated operation viewer to upload the edited File.

   Setup is automatically reflected when uploaded.

- How to Login and Setup the Hosts

1. Login to the Integration Manager host.

2. Stop JP1/IM - Manager servicing.

   For details about how to stop the service, see 3.2 Stopping JP1/IM - Manager in the JP1/Integrated Management 3 - Manager Administration Guide.

3. To edit the configuration file

4. Start the service.

   For details about how to start the service, see 3.1 Starting JP1/IM - Manager in the JP1/Integrated Management 3 - Manager Administration Guide.

■ Change configuration file of JP1/IM agent management base

JP1/IM agent management base's configuration file are imbase configuration file (jpc_imbase.json) and imbaseproxy configuration file (.json).

For configuration file editing procedure, see 1.19.3(1)(a) Common way to setup.

■ Changing JP1/IM agent management base ports

Perform the following steps:

1. Stop JP1/IM - Manager.

2. Change the listen port number of JP1/IM agent management base.

   The listen port number is set to JP1/IM agent management base's imbase configuration file (jpc_imbase.json) and imbaseproxy configuration file (jpc_imbaseproxy.json) port member. Change this to the new port number.

   For details on imbase configuration file and imbaseproxy configuration file, see the description of the appropriate file in Chapter 2. Definition Files in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference.

3. Starts JP1/IM - Manager.

If the listen Port number of the JP1/IM agent management base is changed in an environment that is already in operation, the destination port number of the JP1/IM agent control base must also be changed.

■ Setup the certificate

To encrypt communication between JP1/IM3-Manager and JP1/IM3-Agent, perform the following steps:

1. Stop JP1/IM - Manager.

2. Change Server certificate and keying File for JP1/IM agent management base.

   The listen port number is set to a member of the cert_file or key_file of imbase shared configuration file (jjpc_imbasecommon.json).

   Updates Setup Value of cert_file or key_file, or File that you set itself.

   For details of imbase shared configuration file, see the explanation of appropriate file in Chapter 2. Definition Files in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference.

3. Starts JP1/IM - Manager.

■ Setup event-forwarding relay function (optional)

If you use event-forwarding relay function, JP1/IM - Manager must be 13-01 or later.

The following describes how to configure JP1/IM - Manager to enable event-forwarding relay function.

1. Stop JP1/IM - Manager servicing.

   For a cluster configuration, stop the service from the cluster software.

2. Open imbase configuration file (jpc_imbase.json) and set the jp1base_forward_send items.

   • When JP1/IM - Manager 13-10 or later is newly installed

     The jp1base_forward_send items are listed in imbase configuration file, but because they are commented like "//jp1base_forward_send", remove the leading "//".

   • Upgrading from a version earlier than JP1/IM - Manager 13-10

     Imbase configuration file refers to imbase configuration file model file, because the jp1base_forward_send items are not listed. When writing, remove the leading "//".

3. Set port below the jp1base_forward_send items in imbase configuration file.

   Specifies the port for event-forwarding for JP1/Base that reside together.

   If you specify a service name, set the service name and TCP in services file.

4. Start JP1/IM - Manager servicing.

   For a cluster configuration, start the service from the cluster software.

To disable the event forwarding function, follow the same steps as above and comment out the jp1base_forward_send items as "//jp1base_forward_send" or remove the jp1base_forward_send items in step 2.

■ Define metric to Trend (optional)

Define metric to be displayed in the [Trend] tabbed page of integrated operation viewer in metric Defined File. The primary metric is initially setup. For details about the metric definition file, see the description of each metric definition file in Chapter 2. Definition Files in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference.

To use the service monitoring function, configure the following settings. However, if you do not want to add metrics to display in the Trends tab, this setting is not required.

• When monitoring service with the Windows version of JP1/IM - Agent

  Edit the Windows exporter (service monitoring) metric definition file (metrics_windows_exporter_service.conf). For details about the Windows exporter (service monitoring) metric definition file, see Windows exporter (service monitoring) metric definition file (metrics_windows_exporter_service.conf) in Chapter 2. Definition Files in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference. For the initial value of this metric definition file, see Model file settings (initial status) in Windows exporter (service monitoring) metric definition file (metrics_windows_exporter_service.conf).

• When monitoring service with the Linux version of JP1/IM - Agent

  Edit the Node exporter (service monitoring) metric definition file (metrics_node_exporter_service.conf). For details about the Node exporter (service monitoring) metric definition file, see Node exporter (service monitoring) metric definition file (metrics_node_exporter_service.conf) in Chapter 2. Definition Files in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference. For the initial value of this metric definition file, see Model file settings (initial status) in Node exporter (service monitoring) metric definition file (metrics_node_exporter_service.conf).

  If you newly installed JP1/IM - Manager 13-50 or later, promql range vector selector in metric definition-file (value specified in square brackets [ ]) is set to "$stepTime{minSeconds="minimum-seconds"}".

  When upgrading JP1/IM - Manager from versions 13-00 to 13-11 to version 13-50 or later, the range vector selector in promql of metric definition file does not have "$stepTime{minSeconds="minimum-seconds"}". The values set in JP1/IM - Manager 13-00 to 13-11 are inherited (the default is "2m"). In this case, if you want to specify "$stepTime{minSeconds="minimum-seconds"}" as the promql range vector selector in the metric definition file, you must edit the metric definition file to specify it.

  For details about the value of the range vector selector specified in promql of metric definition file, see 3.15.6(4)(c) About Performance Data to Retrieve in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

■ Setup AWS definition file (optional)

When monitoring with Yet another cloudwatch exporter, specify the mapping between the account ID of AWS that you want to use monitoring with Yet another cloudwatch exporter, and the account strings that setup to SID and IM management node properties by editing AWS definition file.

For details about AWS definition file, see AWS definition file (aws_settings.conf) in Chapter 2. Definition Files in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference.

■ Edit system node definition file (imdd_systemnode) (Required only when using Yet another cloudwatch exporter)

If you want to monitor using Yet another cloudwatch exporter of add-on program and create a system node, setup system node definition file (imdd_systemnode) of JP1/IM - Manager.

This setup is mandatory if you want to monitor it using add-on program's Yet another cloudwatch exporter.

When creating system node shown in 3.15.6(1)(i) Tree Format in the JP1/Integrated Management 3 - Manager Overview and System Design Guide, specify the following settings by editing system node definition file (imdd_systemnode). For setting items not listed here, specify an arbitrary value.

Item nam	Description
displayName	Specifies the name# of the service that publishes Amazon CloudWatch metric.
type	The slash (/) must be changed to a hyphen (-).
name	Specify the following string: [{".*":"regexp"}]

#

Indicates what is on Web of Amazon CloudWatch.

When configuring a system-managed node for AWS namespace monitored by Yet another cloudwatch exporter metric definition file (metrics_ya_cloudwatch_exporter).conf default settings, the following is a sample of the values to be set for the items in system node definition file.

displayName	type	name
Amazon Simple Storage Service	JP1PC-AWS-S3	[{".*":"regexp"}]
AWS Lambda	JP1PC-AWS-LAMBDA
Amazon DynamoDB	JP1PC-AWS-DYNAMODB
AWS Step Functions	JP1PC-AWS-STATES
Amazon Simple Queue Service	JP1PC-AWS-SQS
Amazon Elastic Container Service	JP1PC-AWS-ECS
Amazon Elastic Block Store	JP1PC-AWS-EBS
Amazon Elastic File System	JP1PC-AWS-EFS
FSx File System	JP1PC-AWS-FSX
Simple Notification Service	JP1PC-AWS-SNS
Relational Database Service	JP1PC-AWS-RDS

If you set the above content to system node definition file, it will be as follows.

{
  "meta":{
    "version":"2"
  },
  "allSystem":[
    {
      "id":"strageSystem",
      "displayName":"Amazon Simple Storage Service",
      "objectRoot":[
        {
          "type":"JP1PC-AWS-S3",
          "name":[{".*":"regexp"}]
        }
      ]
    },
    {
      "id":"lambda",
      "displayName":"AWS Lambda",
      "objectRoot":[
        {
          "type":"JP1PC-AWS-LAMBDA",
          "name":[{".*":"regexp"}]
        }
      ]
    },
    {
      "id":"dynamodb",
      "displayName":"Amazon DynamoDB",
      "objectRoot":[
        {
          "type":"JP1PC-AWS-DYNAMODB",
          "name":[{".*":"regexp"}]
        }
      ]
    },
    {
      "id":"states",
      "displayName":"AWS Step Functions",
      "objectRoot":[
        {
          "type":"JP1PC-AWS-STATES",
          "name":[{".*":"regexp"}]
        }
      ]
    },
    {
      "id":"sqs",
      "displayName":"Amazon Simple Queue Service",
      "objectRoot":[
        {
          "type":"JP1PC-AWS-SQS",
          "name":[{".*":"regexp"}]
        }
      ]
    },
    {
      "id":"ecs",
      "displayName":"Amazon Elastic Container Service",
      "objectRoot":[
        {
          "type":"JP1PC-AWS-ECS",
          "name":[{".*":"regexp"}]
        }
      ]
    },
    {
      "id":"ebs",
      "displayName":"Amazon Elastic Block Store",
      "objectRoot":[
        {
          "type":"JP1PC-AWS-EBS",
          "name":[{".*":"regexp"}]
        }
      ]
    },
    {
      "id":"efs",
      "displayName":"Amazon Elastic File System",
      "objectRoot":[
        {
          "type":"JP1PC-AWS-EFS",
          "name":[{".*":"regexp"}]
        }
      ]
    },
    {
      "id":"fsx",
      "displayName":"FSx File System",
      "objectRoot":[
        {
          "type":"JP1PC-AWS-FSX",
          "name":[{".*":"regexp"}]
        }
      ]
    },
    {
      "id":"sns",
      "displayName":"Simple Notification Service",
      "objectRoot":[
        {
          "type":"JP1PC-AWS-SNS",
          "name":[{".*":"regexp"}]
        }
      ]
    },
    {
      "id":"rds",
      "displayName":"Relational Database Service",
      "objectRoot":[
        {
          "type":"JP1PC-AWS-RDS",
          "name":[{".*":"regexp"}]
        }
      ]
    }
  ]
}

After configuring system node definition file, if you run JP1/IM - Manager's jddcreatetree command to create a CloudWatch other than EC2, JP1/IM - Manager displays IM managed node under system node in the Operating status area of the integrated operation viewer, depending on AWS namespace name.

For details about the system node definition file, see System node definition file (imdd_systemnode.conf) in Chapter 2. Definition Files in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference.

■ Placing the credential file

When monitoring with the add-on program Yet another cloudwatch exporter, place the credentials file under "C:\Windows\System32\config\systemprofile\.aws\" written in 1.21.2(7) Setup in Yet another cloudwatch exporter, (b) Modify Setup to connect to CloudWatch (for Windows) (required).

■ Editing category name definition file for IM management nodes (imdd_category_name.conf) (optional)

To use the service monitoring function, configure the following settings. However, if you newly installed JP1/IM - Manager 13-01 or later, this setting is not required because it was set at the time of installation.

In category name definition file for IM management nodes (imdd_category_name.conf), add the definitions shown in the following table. IM management node of agent SID created by the service-monitoring feature is displayed as the displayed category name shown in this table. If no definitions are added, IM management node category is "service" (the value of specified category ID). This setting is not required if "service" is already set for the specified category ID.

Table 1‒9: Service monitoring function categories

Display category name	Specified category ID
Service	service

For details about this definition file, see Category name definition file for IM management nodes (imdd_category_name.conf) in Chapter 2. Definition Files in the JP1/Integrated Management 3 - Manager Command, Definition File and API Reference.