Hitachi

JP1 Version 13 JP1/Integrated Management 3 - Manager Command, Definition File and API Reference

[Figure]Node exporter metric definition file (metrics_node_exporter.conf)

Organization of this page

Format

[
  {
    "name":"trend-data-metric-names",
    "default":default-selection-state,
    "promql":"PromQL-statement",
    "resource_en":{
      "category":"metric-category-(English)",
      "label":"metric-display-name-(English)",
      "description":"metric-description-(English)",
      "unit":"metric-unit-(English)"
    },
    "resource_ja":{
      "category":"metric-category-(Japanese)",
      "label":"metric-display-name-(Japanese)",
      "description":"metric-description-(Japanese)",
      "unit":"metric-unit-(Japanese)"
    },
    "drop_legend_labels": ["label-name", ...]
  }, ...
]#
#

The number of elements that can be described in [] is 1 to 1,000. If an out-of-range number of elements is described, a KAJY24609-E error message is output.

To Page Top

File

metrics_node_exporter.conf

metrics_node_exporter.conf.model (model file)

To Page Top

Storage directory

■Integrated manager host

In Windows:

  • For a physical host

    Manager-path\conf\imdd\plugin\jp1pccs\

  • For a logical host

    shared-folder\jp1imm\conf\imdd\plugin\jp1pccs\

In Linux:

  • For a physical host

    /etc/opt/jp1imm/conf/imdd/plugin/jp1pccs/

  • For a logical host

    shared-directory/jp1imm/conf/imdd/plugin/jp1pccs/

To Page Top

Description

This file defines the metric information of Node exporter displayed on the Trends tab, Dashboard tab, and Dashboard List dialog box of the Integrated Operation Viewer window.

The defined contents are used for the return values of __metricListGet method and __timeSeriesDataGet method of the JP1/IM - Agent product plug-in.

If JP1/IM - Manager is in a hierarchical configuration and you want to refer to trend data stored in Trend data Management Database of lower manager from Integrated manager, you must add trend data metrics that you want to refer to metric definition file of Integrated manager.

To Page Top

Character code

UTF-8 (without BOM)

To Page Top

Line feed code

In Windows: CR+LF

In Linux: LF

To Page Top

When the definitions are applied

Definitions are reflected when the metric information is obtained on the Trends tab, Dashboard tab, and Dashboard List dialog box of the Integrated Operation Viewer window, or with the REST API.

To Page Top

Information that is specified

Table 2‒91: Values to set for each member of the metrics definition file

Member name

Optional

Type

Value to set

name

No

string

Set trend data metric names.

The metric name of trend data (time series data) is displayed as a character string indicating the type of trend data on the Trend tab of the Unified Operation Viewer screen.

1 to 255 characters, and the following characters can be specified.

  • Single-byte alphanumeric characters

  • - (hyphen)

  • _ (underscore)

If it contains characters that cannot be specified, a KAJY24604-E or KAJY24605-E error message is printed.

The metric name must be unique within the metric definition file. Otherwise, a KAJY24608-E error message is output.

default

Yes

boolean

Set default selection state.

Specifies whether the check box of trend data selected on the Trend tab of the Integrated Operation Viewer screen is selected by default.

  • true: Checked by default.

  • false: Unchecked by default.

If it is omitted, it is not checked by default.

promql

No

string

Set PromQL statement.

You can configure PromQL statements that can be used in JP1/IM trend data reference API.

The string "$jp1im_TrendData_labels" in the PromQL statement is replaced by the PromQL statement described in "■Replacing $jp1im_TrendData_labels" below.

When specifying range vectors, the range vector selector (the value specified in square brackets [ ]) can be "$stepTime{minSeconds="minimum-seconds"}" or a fixed value.

For details, see Consolidated display of Trend Data with Dynamic Range Vectors in 3.15.6(4)(c) About Performance Data to Retrieve in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

For notes on PromQL statements, see Note on PromQL expression.

Specify 1 to 1,023 characters except control characters (0x00~0x1F, 0x7F~0x9F).

If it contains characters that cannot be specified, a KAJY24604-E or KAJY24605-E error message is printed.

resource_en

No

object

Configure resource information for metrics.

category

Yes

string

Set the category of the metric.

Specify 1 to 255 characters except control characters (0x00 to 0x1F, 0x7F to 0x9F).

If it contains characters that cannot be specified, a KAJY24604-E or KAJY24605-E error message is printed.

The default is not to set the metric category.

label

Yes

string

Set the display name of the metric.

Specify 1 to 255 characters except control characters (0x00 to 0x1F, 0x7F to 0x9F).

If it contains characters that cannot be specified, a KAJY24604-E or KAJY24605-E error message is printed.

By default, the settings of the name member are used for the display name of the metric on the Trends tab of the Unified Operations Viewer screen. Also, the display name of the metric is not returned by the metric list acquisition API.

description

Yes

string

Sets the description of the metric.

Specifies 1 to 1,023 characters, excluding control characters (0x00 to 0x1F,0x7F to 0x9F).

If it contains characters that cannot be specified, a KAJY24604-E or KAJY24605-E error message is printed.

By default, metric descriptions are not displayed on the Trends tab of the Unified Operations Viewer screen. Also, the metric description is not returned by the metric list acquisition API.

unit

No

string

Set the units for the metric.

Specify 1 to 255 characters except control characters (0x00 to 0x1F, 0x7F to 0x9F).

If it contains characters that cannot be specified, a KAJY24604-E or KAJY24605-E error message is printed.

resource_ja

Yes

object

Set the resource information (Japanese) for the metric.

By default, the resource_en settings are used.

category

Yes

string

Set the category of the metric (Japanese).

Specify 1 to 255 characters except control characters (0x00 to 0x1F, 0x7F to 0x9F).

If it contains characters that cannot be specified, a KAJY24604-E or KAJY24605-E error message is printed.

By default, the settings of the resource_en category are used.

label

Yes

string

Set the display name (Japanese) of the metric.

Specify 1 to 255 characters except control characters (0x00 to 0x1F, 0x7F to 0x9F).

If it contains characters that cannot be specified, a KAJY24604-E or KAJY24605-E error message is printed.

If it is the default, the label setting of the resource_en is used.

description

Yes

string

Set the description of the metric (Japanese).

Specifies 1 to 1,023 characters, excluding control characters (0x00 to 0x1F,0x7F to 0x9F).

If it contains characters that cannot be specified, a KAJY24604-E or KAJY24605-E error message is printed.

By default, the description setting of the resource_en is used.

unit

Yes

string

Set the unit of the metric (Japanese).

Specify 1 to 255 characters except control characters (0x00 to 0x1F, 0x7F to 0x9F).

If it contains characters that cannot be specified, a KAJY24604-E or KAJY24605-E error message is printed.

By default, the settings of the resource_en unit are used.

drop_legend_labels

Yes

Array (string)

Set the label name if you want to add a label that you want to exclude from the trend chart legend.

In addition to the labels to be excluded shown in 3.15.6(4)(b) Instance name (a string to display as a legend in the graph) of the JP1/Integrated Management 3 - Manager Overview and System Design Guide, the names of labels to be excluded from the legend of the trend graph are described.

Specify 1 to 255 characters except control characters (0x00 to 0x1F, 0x7F to 0x9F).

If it contains characters that cannot be specified, it is not excluded from the legend of the trend graph.

You can specify up to 100 labels. If there are more than 100 labels, the 101st and subsequent labels are ignored.
■Replacing $jp1im_TrendData_labels

The string "$jp1im_TrendData_labels" in the promql value is replaced with a PromQL statement to narrow down the target of retrieval when retrieving performance data.

The following is the replaced PromQL statement for each SID type of configuration information specified in the Trending API or Unified Operations Viewer (for CloudWatchSIDs other than EC2, for each monitored AWS namespace). The bold part (variable value) is replaced by the Exporter setting managed by the corresponding SID or the sample value output by the Exporter.

Table 2‒92: PromQL statement after replacing $jp1im_TrendData_labels

Configuration information SID type

PromQL statement after replacement

Agent SID

{jp1_pc_prome_hostname="Prometheus-host-name",job="scrape-job-name",instance="value-of-instance-label"}

Remote agent SID

CloudWatchSID of EC2

{jp1_pc_prome_hostname="Prometheus-host-name",job="scrape-job-name",instance="value-of-instance-label"},jp1_pc_nodelabel="The value that you set for the jp1_pc_nodelabel tag of the resource in AWS"}

CloudWatchSID other than EC2

To Page Top

Model file settings (initial status)

The settings (initial status) of each metric described in the model file of the Node exporter metric definition file are shown below.

To Page Top

Copyright (C) 2023, 2025 Hitachi, Ltd.

Copyright (C) 2023, 2025 Hitachi Solutions, Ltd.