Metric definition file (metrics_product-ID.conf)

Function

The metric definition file is the file for adding, editing, or deleting the metrics to be used in JP1/IM2. The model file for metric definitions is provided to you when you install JP1/IM2.

When you want to reset the metric definition file to the state it was in immediately after the installation of JP1/IM2, overwrite the metric definition file with the model file.

For details on the file permission for the metric definition file, see the JP1/IM2 manual.

To Page Top

Name of file

metrics_product-ID.conf (Metric definition file)

metrics_product-ID.conf.model (Model file for metric definitions)

To Page Top

Location

In Windows:

• For physical hosts:

  installation-folder-of-JP1/IM2\conf\imdd\plugin\jp1pfm

• For logical hosts:

  environment-directory\jp1imm\conf\imdd\plugin\jp1pfm

In UNIX:

• For physical hosts:

  /var/opt/jp1imm/conf/imdd/plugin/jp1pfm/

• For logical hosts:

  environment-directory/jp1imm/conf/imdd/plugin/jp1pfm/

To Page Top

Timing of applying definition information

The definition information is applied immediately after you save the metric definition file.

To Page Top

How to modify

You can edit the metric definition file as follows:

1. Open the metrics_product-ID.conf file in a text editor.

2. Edit the metrics_product-ID.conf file.

3. Save the metrics_product-ID.conf file, and close it.

4. Confirm that the format of the edited file is correct.

   You can check the format of the edited file by using one of the following methods:

   • By using the Integrated Operation Viewer of JP1/IM2, display a chart showing the trend information derived from all metrics you have added or edited.

   • By using the metric list acquisition API and the time-series data acquisition API provided by JP1/IM2, acquire performance data derived from all metrics you have added or edited.

   If the format of the edited file is correct, you can display or acquire trend information derived from the metrics you have added or edited.

   If the format of the edited file is incorrect, an error message is either displayed or returned. By following the instructions provided in the error message, correct the metrics_product-ID.conf file and then try displaying or acquiring trend information again.

   For details on how to operate the Integrated Operation Viewer of JP1/IM2 and how to use REST APIs (metric list acquisition API and time-series data acquisition API), see the JP1/IM2 manual or document.

Note:

When the display or acquisition of trend information by the Integrated Operation Viewer of JP1/IM2 or a REST API coincides with the saving of the metrics_product-ID.conf file, the file might not be read correctly, which results in an error message being displayed. In this case, try displaying or acquiring trend information again.

To Page Top

Setting items

Create a metric definition file with the following format.

The JSON-format metric definition file is shown below. Arrays of metric information are specified in a metric definition file. One metric information item is specified in each object, which is one of the elements of an array.

[
  {
    "name":"metric-name",
    "default":whether-the-default-is-selected,
    "resource_en":{
      "category":"category-(English)-for-the-metric",
      "label":"display-name-(English)-for-the-metric",
      "description":"description-(English)-for-the-metric",
      "unit":"unit-(English)-for-the-music"
    },
    "resource_ja":{
      "category":"category-(Japanese)-for-the-metric",
      "label":"display-name-(Japanese)-for-the-metric",
      "description":"description-(Japanese)-for-the-metric",
      "unit":"unit-(Japanese)-for-the-music"
    },
    "recordId":"record-ID",
    "fieldId":"field-ID",
    "filter": [
      {
        "fieldId":"field-ID-to-be-filtered",
        "operator":"comparison-operator",
        "value":"value-against-which-to-compare-performance-data",
      }, ...
    ],
    "summarizationRule":"summarization-rule"
  }, ...
]

The table below describes the items to be set in the metric definition file.

record-ID_PFM - Manager-name-of-the field

record-ID_PFM - Manager-name-of-the field

#1

n adjacent data items are summarized, where n is the calculation result of number of data items/maximum number of data items allowed rounded up to the next whole number. The newest date and time among the summarized data items is used as the date and time of the summarized data.

For example, data can be summarized as follows:

(Example 1) When data is summarized under the following conditions: number of data items = 6, maximum number of data items allowed = 5, summarization rule = average:

In this case, n = 2. The values of two adjacent data items are therefore summarized and averaged.

Performance data of Performance Management		Data summarized with the JP1/PFM plug-in
Date and time	Data	Date and time	Data
2019/01/01 00:00:00	1	2019/01/01 00:01:00	1.5
2019/01/01 00:01:00	2
2019/01/01 00:02:00	3	2019/01/01 00:03:00	3.5
2019/01/01 00:03:00	4
2019/01/01 00:04:00	5	2019/01/01 00:05:00	5.5
2019/01/01 00:05:00	6

(Example 2) When data is summarized under the following conditions: number of data items = 8, maximum number of data items allowed = 8, summarization rule = sum:

In this case, n = 3. The values of three adjacent data items are therefore summarized and summed up. Because data items in this example cannot be divided evenly by 3, there would be two remaining data items. In this case, the values of the remaining two data items are just summarized and summed up.

Performance data of Performance Management		Data summarized with the JP1/PFM plug-in
Date and time	Data	Date and time	Data
2019/01/01 00:00:00	1	2019/01/01 00:02:00	6
2019/01/01 00:01:00	2
2019/01/01 00:02:00	3
2019/01/01 00:03:00	4	2019/01/01 00:05:00	15
2019/01/01 00:04:00	5
2019/01/01 00:05:00	6
2019/01/01 00:06:00	7	2019/01/01 00:07:00	15
2019/01/01 00:07:00	8

#2

In the case of records of the PI record type, summarized data is stored in the Store database. If AVG is set as the summarization rule for the records and average is set as the summarization rule for the metrics, the average of the averages is calculated.

No problem can occur when no change has been made to the collection interval. If, however, a change has been made to the collection interval, and data items having different collection intervals are to be summarized, caution is advised because the calculated average is not precise.

#3

The maximum value and the minimum value that can be specified for the data item to be summarized are 1.797E308 and -1.797E308, respectively. When the summarization rule sum (total value) or average (average = total value / number of data items) is applied to the calculation, if the total value of the data items to be summarized exceeds the maximum value, calculation is performed by using the maximum value as the total value. Similarly, when the total value of the data items to be summarized falls below the minimum value, calculation is performed by using the minimum value as the total value.

To Page Top

Definition example

An example of the coding for a metric definition file is shown below, which is applicable when you add metrics from the Windows version of JP1/Performance Management - Agent Option for Platform to JP1/IM2.

[
  {
    "name":"cpu_used_rate",
    "default":true,
    "resource_en":{
      "label":"CPU used rate",
      "description":"Processor usage. Percentage of elapsed time used by the processor for executing non-idle threads. [Units: %]",
      "unit":"%"
    },
    "recordId":"PI",
    "fieldId":"PI_PCT_TOTAL_PROCESSOR_TIME",
    "summarizationRule":"average"
  },
  {
    "name":"memory_unused",
    "default":false,
    "resource_en":{
      "label":"Memory unused",
      "description":"Available size in the physical memory area. The combined total of zero memory, free memory, and standby memory (cached) that can be immediately allocated to a process or be used by the system. [Units: MB]",
      "unit":"MB"
    },
    "recordId":"PI",
    "fieldId":"PI_AVAILABLE_BYTES",
    "summarizationRule":"low"
  },
  {
    "name":"disk_unused",
    "default":false,
    "resource_en":{
      "label":"Disk unused",
      "description":"Size of the unused area of the disk. [Units: MB]",
      "unit":"MB"
    },
    "recordId":"PI_LOGD",
    "fieldId":"PI_LOGD_FREE_MEGABYTES",
    "summarizationRule":"low"
  },
  {
    "name":"disk_busy_rate",
    "default":false,
    "resource_en":{
      "label":"Disk busy rate",
      "description":"Percentage of time the disk was busy when a read or write request was processed. [Units: %]",
      "unit":"%"
    },
    "recordId":"PI_PHYD",
    "fieldId":"PI_PHYD_PCT_DISK_TIME",
    "summarizationRule":"average"
  },
  {
    "name":"network_sent",
    "default":false,
    "resource_en":{
      "label":"Network sent",
      "description":"Rate at which packets were sent throughthe network interface. [Units: packets/second]",
      "unit":"packets/second"
    },
    "recordId":"PI_NETI",
    "fieldId":"PI_NETI_PACKETS_SENT_PER_SEC",
    "summarizationRule":"average"
  },
  {
    "name":"network_received",
    "default":false,
    "resource_en":{
      "label":"Network received",
      "description":"Rate at which packets were receivedthrough the network interface. [Units: packets/second]",
      "unit":"packets/second"
    },
    "recordId":"PI_NETI",
    "fieldId":"PI_NETI_PACKETS_RECEIVED_PER_SEC",
    "summarizationRule":"average"
  }
]

To Page Top