Hitachi

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


Script exporter configuration file (jpc_script_exporter.yml)

Organization of this page

Syntax

Written in YAML format.

scripts:
  - name: run_scriptA
    command: ./examples/scriptA.sh
    timeout:
      max_timeout: 120
  - name: run_scriptB
    command: ./examples/scriptB.sh
    args:
      - arg1
      - arg2

File

jpc_script_exporter.yml

jpc_script_exporter.yml.model (Model file)

Storage directory

For Windows
When using a physical host

Agent-path\conf\

When using a logical host

shared-folder\jp1ima\conf\

For Linux
When using a physical host

/opt/jp1ima/conf/

When using a logical host

shared-directory/jp1ima/conf/

Description

The configuration file that determines the behavior of Script exporter.

Character encoding

UTF-8 (without BOM)

Linefeed code

In Windows: CR+LF

In Linux: LF

Timing in which definitions are reflected

When Script exporter is restarted.

Content description

Item#

Description

Modifiable

Content set by the user in JP1/IM - Agent

Default value in JP1/IM - Agent

scripts:

Script settings

--

--

None

-

name:

The name of the script. It must be a valid Prometheus label value (Unicode characters).

Specify in a character string within 1 to 255 characters.

REQ

Name of the script being monitored (any name)

None

command:

Specify the script to be executed. For the output format of the script, see the description of Prometheus Text-based format in 3.15.1 Performance monitoring function by JP1/IM - Agent in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

Setting example:

"/bin/foo"

Example of output:

# HELP metric_name description

# TYPE metric_name gauge

metric_name {label1="labelvalue1"} 12345

metric_name {label1="labelvalue2"} 67890

REQ

Script being monitored

None

args:

All arguments.

Setting example:

- "--output"

- "/dev/null"

REQ

Script arguments (not required if no arguments are used)

None

timeout:

Timeout settings

Y

--

None

max_timeout:

It limits the maximum timeout value that requests can specify; a request that specifies a larger timeout will have the timeout adjusted down to the max_timeout value.

Specify this value in seconds.

If omitted, this is specified as the timeout value set in Prometheus.

Y

Number of seconds until timeout

None

enforced:

If enforced is true, script_exporter attempts to enforce the timeout by killing the script's main process after the timeout expires. The default is to not enforce timeouts.

You can specify true or false.

If omitted, this is specified as false.

Y

Whether to forcibly terminate the script when timed out

None

Legend:

REQ: Required setting, Y: Modifiable, --: Not applicable

#

Brackets ([]) denote optional items.