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

(a) Common way to setup

(b) Change settings of JP1/IM - Agent management base (for Windows)

The following describes how to change setup of JP1/IM - Agent management base (imbase,imbaseproxy).

(c) Creation and import of IM management node tree data (for Windows) (mandatory)

Follow the steps below to create and import IM management node tree.

1. Perform the steps in integrated agent host.

   Follow steps 1 to 4 in 1.21.2(10) Creation and import of IM management node tree data (for Windows) (mandatory).

2. Run JP1/IM - Manager's jddcreatetree command/create IM managed node-related API.

   If the execution fails, follow the instructions in Message and execute again.

3. When add-on program or user-defined Prometheus or Fluentd configuration is changed or deleted, IM management node-related files described in "Editing IM management node-related files" below is edited (it is not necessary to perform it when building a new system).

4. Execute jddupdatetree command of JP1/IM - Manager (configuration change mode) or the import API of IM control node-related information.

   If the execution fails, follow the instructions in Message and execute again.

5. Display integrated operation viewer and verify that IM management node is created correctly.

   If it is not created correctly, review settings in integrated agent, add-on program, user-defined Prometheus or Fluentd that was not created, and then repeat the procedure from step 2.

- Editing IM management node-related files

If add-on program, or user-defined Prometheus or Fluentd configuration changes (configuration changes or deletions) are made, a pre-configuration IM management node is created until those sample are removed from Trend data Management Database. For the timing when trend data is deleted, see 2.7.2 Trend data Management Database in JP1/Integrated Management 3 - Manager Overview and System Design Guide manual.

If you do not want to create a pre-configuration IM management node, you can modify IM management node file and IM management node tree file output by jddcreatetree command. For details on IM management node tree file, see "3.5.3 IM management node-related files" in JP1/Integrated Management 3 - Manager Overview and System Design Guide manual. Copy the file to make a backup before editing.

- Editing IM management node Files

Jddcreatetree command-generated IM management node file (filename: imdd_node_HITACHI_JP1_JPCCS_CONFINFO_JP1 hostname.json) also displays /IM-Manager's pre-configuration OOE. When the setting is changed, SID of the configuration information is the same before and after the change, and SID of the second and subsequent configuration information is output with the suffix "-xx"(xx are numbered from 01 to 99).

If you do not need IM management node prior to the configuration change, remove IM management node object from jddcreatetree before the configuration change by editing IM management node file. The format of IM management node file is shown below.

{
  "meta":{
    ...
  },
  "simtData": [
    Objects in IM management node,
    ...
  ]
}

An object of IM management node is an element of an array of simtData in the following format:

• IM management node Object-Format

{
  "sid": "SID Configuration",
  "value": {
    ...
    "property": {
      Displayed in IM management node Properties,
    },
    "jp1im_TrendData_labels": {
      Values for identifying trend data
    },
    ...
  }
}

Review the values that you want to see in the properties of IM management node and the values to identify the trend data. Remove the objects in IM management node prior to the configuration change. For the values displayed in the properties of IM management node, see "9.5.1(1)(f) Property Display" and "12.5.1(1)(b) Property Display" in the manual JP1/Integrated Management 3 - Manager Overview and System Design Guide. The values shown in the following table are set as values for identifying trend data.

Key	Value Description
jp1_pc_prome_hostname	Hostname of Prometheus server This is the setting for the jp1_pc_prome_hostname of Prometheus configuration file. For log-monitored SID, this key/value is not displayed.
job	Scrape job name This is the setting for job_name in Prometheus configuration file. For log-monitored SID, or SID of kubernetes, this key/value is not printed.
instance	Instance Name This is specified in targets of the discovery configuration file.
jp1_pc_nodelabel	Label-name of IM management node This is the scrape_configs or metrics_scrape_configs of Prometheus configuration file or the jp1_pc_nodelabel tag for AWS resource.

When deleting an object of IM management node that does not have "-xx" at the end of SID of the configuration information and leaving an object of IM management node that has "-xx" at the end, delete and save the "-xx" at the end of SID of the configuration information to be left.

The following shows an example of editing when Node exporter port number is changed.

In this example, the port number before the change is 20716 and the port number after the change is 29999.

• Sample Pre-Edit IM management node Files

{
  "meta":{
    ...
  },
  "simtData": [
    ...
    {
      "sid": "_JP1PC-IMB_MHOST/_JP1PC-M_AHOST/_JP1PC-AHOST_AHOST/_HOST_AHOST/_JP1PC-A_Linux%20metric%20collector%28Node%20exporter%29",
      "value": {
        "component": "/HITACHI/JP1/JPCCS/CONFINFO",
        "category": "platform",
        "visible": true,
        "label": "Linux metric collector(Node exporter)",
        "property": {
          "jp1_pc_prome_hostname": "ahost",
          "job": "jpc_node",
          "jp1_pc_exporter": "JPC Node exporter",
          "jp1_pc_trendname": "node_exporter"
        },
        "jp1im_TrendData_labels": {
          "jp1_pc_prome_hostname": "ahost",
          "job": "jpc_node",
          "instance": "ahost:20716",
          "jp1_pc_nodelabel": "Linux metric collector(Node exporter)"
        },
        "methods": [
          "__metricListGet",
          "__timeSeriesDataGet"
        ]
      }
    },
    {
      "sid": "_JP1PC-IMB_MHOST/_JP1PC-M_AHOST/_JP1PC-AHOST_AHOST/_HOST_AHOST/_JP1PC-A_Linux%20metric%20collector%28Node%20exporter%29-01",
      "value": {
        "component": "/HITACHI/JP1/JPCCS/CONFINFO",
        "category": "platform",
        "visible": true,
        "label": "Linux metric collector(Node exporter)",
        "property": {
          "jp1_pc_prome_hostname": "ahost",
          "job": "jpc_node",
          "jp1_pc_exporter": "JPC Node exporter",
          "jp1_pc_trendname": "node_exporter"
        },
        "jp1im_TrendData_labels": {
          "jp1_pc_prome_hostname": "ahost",
          "job": "jpc_node",
          "instance": "ahost:29999",
          "jp1_pc_nodelabel": "Linux metric collector(Node exporter)"
        },
        "methods": [
          "__metricListGet",
          "__timeSeriesDataGet"
        ]
      }
    },
    ...
  ]
}

Deletes IM management node object whose instance is set to ahost:20716, and removes-xx at the end of the configuration SID that you want to keep. The edited IM management node filename is shown below.

• Sample IM management node Files After Editing

{
  "meta":{
    ...
  },
  "simtData": [
    ...
    {
      "sid": "_JP1PC-IMB_MHOST/_JP1PC-M_AHOST/_JP1PC-AHOST_AHOST/_HOST_AHOST/_JP1PC-A_Linux%20metric%20collector%28Node%20exporter%29",
      "value": {
        "component": "/HITACHI/JP1/JPCCS/CONFINFO",
        "category": "platform",
        "visible": true,
        "label": "Linux metric collector(Node exporter)",
        "property": {
          "jp1_pc_prome_hostname": "ahost",
          "job": "jpc_node",
          "jp1_pc_exporter": "JPC Node exporter",
          "jp1_pc_trendname": "node_exporter"
        },
        "jp1im_TrendData_labels": {
          "jp1_pc_prome_hostname": "ahost",
          "job": "jpc_node",
          "instance": "ahost:29999",
          "jp1_pc_nodelabel": "Linux metric collector(Node exporter)"
        },
        "methods": [
          "__metricListGet",
          "__timeSeriesDataGet"
        ]
      }
    },
    ...
  ]
}

- Editing IM management node tree file

IM management node tree file output by jddcreatetree command. is edited.

If you delete the configuration, delete the description of the tree object of the deleted IM management node.

When the setting is changed, the description of SID of the configuration information to which "-xx" is added at the end of SID of the configuration information is deleted from target array.

The following shows an example of editing when Node exporter setting is changed.

• Pre-Edit IM management node tree file Sample

{
  "meta":{
    ...
  },
  "simtData": [
    ...
    {
      "sid": "_ROOT_AllSystems/_HOST_AHOST/_CATEGORY_platform/_OBJECT_JP1PC-ALinux%20metric%20collector%28Node%20exporter%29",
      "value": {
        "target": [
          "_JP1PC-IMB_MHOST/_JP1PC-M_AHOST/_JP1PC-AHOST_AHOST/_HOST_AHOST/_JP1PC-A_Linux%20metric%20collector%28Node%20exporter%29"
        ],
        "label": "Linux metric collector(Node exporter)"
      }
    },
    {
      "sid": "_ROOT_AllSystems/_HOST_AHOST/_CATEGORY_platform/_OBJECT_JP1PC-ALinux%20metric%20collector%28Node%20exporter%29-01",
      "value": {
        "target": [
          "_JP1PC-IMB_MHOST/_JP1PC-M_AHOST/_JP1PC-AHOST_AHOST/_HOST_AHOST/_JP1PC-A_Linux%20metric%20collector%28Node%20exporter%29-01"
        ],
        "label": "Linux metric collector(Node exporter)"
      }
    },
    ...
  ]
}

• Sample IM management node tree file After Editing

{
  "meta":{
    ...
  },
  "simtData": [
    ...
    {
      "sid": "_ROOT_AllSystems/_HOST_AHOST/_CATEGORY_platform/_OBJECT_JP1PC-ALinux%20metric%20collector%28Node%20exporter%29",
      "value": {
        "target": [
          "_JP1PC-IMB_MHOST/_JP1PC-M_AHOST/_JP1PC-AHOST_AHOST/_HOST_AHOST/_JP1PC-A_Linux%20metric%20collector%28Node%20exporter%29"
        ],
        "label": "Linux metric collector(Node exporter)"
      }
    },
    ...
  ]
}

- What happens when IM management node-related files is not edited

If you do not edit IM management node-related files, IM management node are created until the old sample is removed from Trend data Management Database. For configuration changes, JP1 events issued by add-on program, or user-defined Prometheus and Fluentd are mapped to IM management node without "-xx" at the end of the configuration SID.

(d) Settings of product plugin (for Windows)

This section explains how to set product plugin.

{
  "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"}]
        }
      ]
    }
  ]
}