Hitachi

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

[Figure]Yet another cloudwatch exporter metric definition file (metrics_ya_cloudwatch_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)"
    },
    "cloud_srv": "AWS service namespace name",
    "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_ya_cloudwatch_exporter.conf

metrics_ya_cloudwatch_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 Yet another cloudwatch 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.

IM management nodes for Yet another cloudwatch exporter are created only for resources for metrics defined in the Yet another cloudwatch exporter metrics definition file.

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.

IM management nodes in Yet another cloudwatch exporter are reflected when you run the jddcreatetree and jddupdatetree commands.

To Page Top

Information that is specified

The following value is setup to name and cloud_srv membership. For values that setup to other members, see the Information that is specified section in Node exporter metric definition file (metrics_node_exporter.conf).

Table 2‒94: Values to set for the name and cloud_srv members of the metric definition file

Member name

Optional

Type

Value to set

name

No

string

Set the metric name for the trend data.

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.

For yet another cloudwatch exporter metrics definition file, create only resources for the metrics defined here. Also, the metric name must match the metric name in Yet another cloudwatch exporter.

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.

cloud_srv

Yes

string

Set the AWS service namespace name.

This member is required only for Yet another cloudwatch exporter metrics definition file.

Set the name of the following namespace specified in the Yet another cloudwatch exporter configuration file (jpc_ya_cloudwatch_exporter.yml):

  • Namespace specified by [Auto-discovery job] type#

Example 1: AWS/EC2

Example 2: AWS/S33

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

  • Single-byte alphanumeric characters

  • . (period)

  • - (hyphen)

  • _ (underscore)

  • / (forward slash)

  • # (hash)

  • : (colon)

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

For details about the namespaces (services) that can be specified in Auto-discovery job's type, see the section describing the namespaces of AWS that JP1/IM - Agent supports as monitored at 3.15.6(1)(k) Creating an IM Management Node for Yet another cloudwatch exporter in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

To Page Top

Model file settings (initial status)

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

To Page Top

Copyright (C) 2023, 2025 Hitachi, Ltd.

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