サービス定義ファイル（jpc_プログラム名_service.xml）

〈このページの構成〉

形式

統合エージェント制御基盤（imagent，imagentproxy，imagentaction），およびアドオン管理機能に対応していないOSS^※のサービスの場合

<service>
  <id>サービスのID</id>
  <name>サービスの表示名</name>
  <description>説明</description>
  <workingdirectory>作業ディレクトリ</workingdirectory>
  <env name="環境変数名" value="値"></env>
  <executable>"プログラムのパス"</executable>
  <arguments>プログラムの引数</arguments>
  <startmode>スタートアップの種類</startmode>
  <logpath>ログ出力先ディレクトリ</logpath>
  <log mode="roll-by-size">
    <sizeThreshold>ログファイルサイズ</sizeThreshold>
    <keepFiles>ログ面数</keepFiles>
  </log>
  <stoptimeout>終了タイムアウト時間</stoptimeout>
</service>

アドオン管理機能に対応しているOSS^※のサービスの場合

<service>
  <id>サービスのID</id>
  <name>サービスの表示名</name>
  <description>説明</description>
  <workingdirectory>作業ディレクトリ</workingdirectory>
  <env name="環境変数名" value="値"></env>
  <executable>"OSSラッパーのプログラムのパス"</executable>
  <arguments>
    "OSSのプログラムのパス"
    OSSのプログラムの引数
  </arguments>
  <startmode>スタートアップの種類</startmode>
  <logpath>ログ出力先ディレクトリ</logpath>
  <log mode="roll-by-size">
    <sizeThreshold>ログファイルサイズ</sizeThreshold>
    <keepFiles>ログ面数</keepFiles>
  </log>
  <stoptimeout>終了タイムアウト時間</stoptimeout>
  <env name="IMA_OSSWRAPPER_RESTART_INTERVAL" value="OSSラッパーがOSSのプロセスを再起動する間隔"/>
</service>

注※: アドオン管理機能に対応しているOSSについては，マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「3.15 JP1/IM - Agentによる監視機能」を参照してください。

ページの先頭へ

ファイル

物理ホスト用

jpc_プログラム名_service.xml

jpc_プログラム名_service.xml.model（モデルファイル）
論理ホスト用

jpc_プログラム名_service_論理ホスト名.xml

ページの先頭へ

格納先ディレクトリ

■統合エージェントホスト

物理ホストのとき（モデルファイルの格納先）

Agentパス\conf\
物理ホストおよび論理ホストのとき（定義ファイルの格納先）

Agentパス\bin\

ページの先頭へ

説明

Windowsサービス化プログラムの定義ファイルです。

ページの先頭へ

文字コード

UTF-8（BOM無し）

ページの先頭へ

改行コード

CR+LF

ページの先頭へ

定義の反映時期

定義ファイルの<startmode>を変更した場合は，サービスの再インストールにより反映されます。サービスの再インストールは，統合エージェント制御基盤またはアドオンプログラムのサービスごとに，次の表に示すコマンドで行います。

アドオンプログラムまたは統合エージェント制御基盤	サービス名	コマンド
Prometheus server	jpc_prometheus_server_service.exe	jpc_prometheus_server_service.exe
Alertmanager	jpc_alertmanager_service.exe	jpc_alertmanager_service.exe
Windows exporter	jpc_windows_exporter_service.exe	jpc_windows_exporter_service.exe
Windows exporter（Hyper-V監視）	jpc_windows_exporter_hyperv_service.exe	jpc_windows_exporter_hyperv_service.exe
Blackbox exporter	jpc_blackbox_exporter_service.exe	jpc_blackbox_exporter_service.exe
Yet another cloudwatch exporter	jpc_ya_cloudwatch_exporter_service.exe	jpc_ya_cloudwatch_exporter_service.exe
Promitor	jpc_promitor_scraper_service.exe	jpc_promitor_scraper_service.exe
Promitor	jpc_promitor_resource_discovery_service.exe	jpc_promitor_resource_discovery_service.exe
Script exporter	jpc_script_exporter_service.exe	jpc_script_exporter_service.exe
Fluentd	jpc_fluentd_service.exe	jpc_fluentd_service.exe
Web exporter	jpc_web_exporter_service.exe	jpc_web_exporter_service.exe
VMware exporter	jpc_vmware_exporter_service.exe	jpc_vmware_exporter_service.exe
SQL exporter	sql_exporter_service.exe	sql_exporter_service.exe
imagent	jpc_imagent_service.exe	jpc_imagent_service.exe
imagentproxy	jpc_imagentproxy_service.exe	jpc_imagentproxy_service.exe
imagentaction	jpc_imagentaction_service.exe	jpc_imagentaction_service.exe

定義ファイルの<arguments>または<stoptimeout>を変更した場合は，サービスの再起動により反映されます。

ページの先頭へ

記述内容

項目名			説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
<service>			サービスの設定をします。	−	−	−
	<id>		サービスのID（Windowsがサービスを識別するために内部的に使用するID）を指定します（必須）。このIDは，システムにインストールされているすべてのサービスの中で一意，かつ，すべて英数字で構成されている必要があります。	△	−	Prometheus serverの場合 jpc_prometheus Alertmanagerの場合 jpc_alertmanager Windows exporterの場合 jpc_windows_exporter Blackbox exporterの場合 jpc_blackbox_exporter 統合エージェント制御基盤（imagent）の場合^※ jpc_imagent 統合エージェント制御基盤（imagentproxy）の場合^※ jpc_imagentproxy 統合エージェント制御基盤（imagentaction）の場合^※ jpc_imagentaction Fluentdの場合 jpc_fluentd Yet another cloudwatch exporterの場合 jpc_ya_cloudwatch_exporter Promitor Scraperの場合 jpc_promitor_scraper Promitor Resource Discoveryの場合 jpc_promitor_resource_discovery Script exporterの場合 jpc_script_exporter OracleDB exporterの場合 oracledb_exporter_インスタンス名 Web exporterの場合 jpc_web_exporter VMware exporterの場合 jpc_vmware_exporter Windows exporter（Hyper-V監視）の場合 jpc_windows_exporter_hyperv SQL exporterの場合 sql_exporter
	<name>		サービスの表示名（サービスの短い表示名）を指定します（任意）。空白文字やほかの文字を含めることができます。<id>のように長い文字列は指定しないでください。また，特定のシステム内のすべてのサービス間で一意である必要があります。	△	−	Prometheus serverの場合 JP1/IM3-Agent Metric forwarder Alertmanagerの場合 JP1/IM3-Agent Alert forwarder Windows exporterの場合 JP1/IM3-Agent Windows metric collector Blackbox exporterの場合 JP1/IM3-Agent Synthetic metric collector 統合エージェント制御基盤（imagent）の場合^※ JP1/IM3-Agent 統合エージェント制御基盤（imagentproxy）の場合^※ JP1/IM3-Agent proxy 統合エージェント制御基盤（imagentaction）の場合^※ JP1/IM3-Agent action Fluentdの場合 JP1/IM3-Agent Log trapper Yet another cloudwatch exporterの場合 JPC YA Cloudwatch exporter Promitor Scraperの場合 JPC Promitor Scraper Promitor Resource Discoveryの場合 JPC Promitor Resource Discovery Script exporterの場合 JPC Script exporter OracleDB exporterの場合 OracleDB metric collector インスタンス名 Web exporterの場合 JP1/IM3-Agent Synthetic web metric collector VMware exporterの場合 JP1/IM3-Agent VMware metric collector Windows exporter（Hyper-V監視）の場合 JP1/IM3-Agent Windows Hyper-V metric collector SQL exporterの場合 SQL Exporter
	<description>		説明を（長い説明文）を指定します（任意）。この説明は，サービスが選択されたときに，Windowsサービスコントロールマネージャーに表示されます。	△	−	Prometheus serverの場合 Prometheus server Alertmanagerの場合 Alertmanager Windows exporterの場合 windows_exporter Blackbox exporterの場合 blackbox_exporter 統合エージェント制御基盤（imagent）の場合^※ JPC IM-Agent Service 統合エージェント制御基盤（imagentproxy）の場合^※ JPC IM-Agent Proxy Service 統合エージェント制御基盤（imagentaction）の場合^※ JPC IM-Agent Action Service Fluentdの場合 Fluentd Yet another cloudwatch exporterの場合 jpc_ya_cloudwatch_exporter Promitor Scraperの場合 jpc_promitor_scraper Promitor Resource Discoveryの場合 jpc_promitor_resource_discovery Script exporterの場合 jpc_script_exporter OracleDB exporterの場合 OracleDB exporter Web exporterの場合 Web exporter VMware exporterの場合 vmware_exporter Windows exporter（Hyper-V監視）の場合 jpc_windows_exporter_hyperv SQL exporterの場合 MSSQL metric collector
	<workingdirectory>		作業ディレクトリ（サービスのカレントディレクトリ）を指定します。	△	−	Prometheus server，Alertmanager，Windows exporter，Blackbox exporter，およびVMware exporterの場合セットアップ時に自動設定します。統合エージェント制御基盤（imagent，imagentproxy，およびimagentaction），Fluentd，およびWeb exporterの場合 Agentパス`\bin`
	<env name="環境変数名" value="値">		環境変数名と値を指定します。 Promitor Scraper，Promitor Resource Discovery，およびOracleDB exporterの場合に指定します。	Promitor ScraperおよびPromitor Resource Discoveryの場合 △ OracleDB exporterの場合 ○	−	Promitor Scraperの場合 name="PROMITOR_CONFIG_FOLDER" value="インストール先/jp1ima/conf/promitor/scraper" Promitor Resource Discoveryの場合 name="PROMITOR_CONFIG_FOLDER" value="インストール先/jp1ima/conf/promitor/resource-discovery" OracleDB exporterの場合マニュアル「JP1/Integrated Management 3 - Manager 構築ガイド」の「1.23.1(4)(a) 監視対象を追加する（必須）」の「監視対象を追加するための準備」の手順3と4を参照してください。
	<executable>		プログラムのパス（起動する実行ファイルのパス）を指定します（必須）。絶対パスを指定，または実行ファイル名を指定してPATHから検索させることができます。ただし，サービスは別のユーザーアカウントで実行されることが多いため，シェルとは異なるPATHを持つ可能性があることに注意してください。空の文字列を指定してもエラーにならないため，注意してください。	△	−	Prometheus server，Alertmanager，Windows exporter，Windows exporter（Hyper-V監視），Yet another cloudwatch exporter，Promitor Scraper，Promitor Resource Discovery，Blackbox exporter，Script exporter，Web exporter，VMware exporter，およびFluentdの場合 osswrapper.exe 統合エージェント制御基盤（imagent）の場合 imagent 統合エージェント制御基盤（imagentproxy）の場合 imagentproxy 統合エージェント制御基盤（imagentaction）の場合 imagentaction OracleDB exporterの場合配置先`\`oracledb_exporter_windows`\`jp1ima`\`bin`\`oracledb_exporter.exe SQL exporterの場合配置先`\`sql_exporter_windows`\`jp1ima¥bin`\`sql_exporter.exe
	<arguments>		プログラムの引数（起動する実行ファイルに渡す引数）を指定します。値を変更する場合は，値を変更したあとで，サービスを再起動してください。	〇	引数を変更したいときに設定を変更します。	Prometheus serverの場合 "Agentパス`\`bin`\`prometheus.exe" prometheus.exeの引数注 prometheus.exeの引数については，「prometheusコマンドのオプション」を参照してください。 Alertmanagerの場合 "Agentパス`\`bin`\`alertmanager.exe" alertmanager.exeの引数注 alertmanager.exeの引数については，「alertmanagerコマンドのオプション」を参照してください。 Windows exporterの場合 "Agentパス`\`bin`\`windows_exporter.exe" windows_exporter.exeの引数注 windows_exporter.exeの引数については，「windows_exporterコマンドのオプション」を参照してください。 Blackbox exporterの場合 "Agentパス`\`bin`\`blackbox_exporter.exe" blackbox_exporter.exeの引数注 blackbox_exporter.exeの引数については，「blackbox_exporterコマンドのオプション」を参照してください。統合エージェント制御基盤（imagent，imagentproxy，およびimagentaction）の場合 ■通常ホストの場合 `なし` ■クラスタ環境の場合 `-hostname` 論理ホスト名 ■複数マネージャーホストへのデータ配信機能を使用し，統合エージェント制御基盤をセカンダリーとして起動する場合^※ `-imagid` imagentグループ識別子 Fluentdの場合 "Agentパス`\`lib`\`ruby`\`ruby.exe" fluentdコマンドの引数注 fluentdコマンドの引数については，「fluentdコマンドのオプション」を参照してください。 Yet another cloudwatch exporterの場合 "Agentパス`\`bin`\`ya_cloudwatch_exporter.exe" ya_cloudwatch_exporter.exeの引数注 ya_cloudwatch_exporter.exeの引数については，「yet-another-cloudwatch-exporterコマンドのオプション」を参照してください。 Promitor Scraperの場合 "Agentパス`\`bin`\`promitor_scraper.exe" promitor_scraper.exeの引数注 promitor_scraper.exeの引数については，「promitor_scraperコマンドのオプション」を参照してください。 Promitor Resource Discoveryの場合 "Agentパス`\`bin`\`promitor_resource_discovery.exe" promitor_resource_discovery.exeの引数注 promitor_resource_discovery.exeの引数については，「promitor_resource_discoveryコマンドのオプション」を参照してください。 Script exporterの場合 "Agentパス`\`bin`\`script_exporter.exe" script_exporter.exeの引数注 script_exporter.exeの引数については，「script_exporterコマンドのオプション」を参照してください。 OracleDB exporterの場合 oracledb_exporter.exeの引数注 oracledb_exporter.exeの引数については，「oracledb_exporterコマンドのオプション」を参照してください。 Web exporterの場合 "Agentパス`\`bin`\`web_exporter.exe" web_exporter.exeの引数注 web_exporter.exeの引数については，「web_exporterコマンドのオプション」を参照してください。 VMware exporterの場合 "Agentパス`\`bin`\`vmware_exporter.exe" vmware_exporter.exeの引数注 vmware_exporter.exeの引数については，「vmware_exporterコマンドのオプション」を参照してください。 Windows exporter（Hyper-V監視）の場合 windows_exporter.exe（Hyper-V監視）の引数注 windows_exporter.exe（Hyper-V監視）の引数については，「windows_exporterコマンドのオプション（Hyper-V監視）」を参照してください。 SQL exporterの場合 sql_exporter.exeの引数注 sql_exporter.exeの引数については，「sql_exporterコマンドのオプション」を参照してください。
	<startmode>		スタートアップの種類（Windowsサービスの開始モード）を指定します（任意）。次のどちらかの値を指定します。 Automatic（自動） Manual（手動）値を変更する場合は，一度サービスのアンインストールを実行し，値を変更したあとで，サービスの再インストールを実行してください。	〇	Prometheus server，Alertmanager，Windows exporter，Blackbox exporter，統合エージェント制御基盤（imagentおよびimagentproxy），Fluentd，OracleDB exporter，Web exporter，VMware exporter，Windows exporter（Hyper-V監視），およびSQL exporterの場合クラスタ運用のときはManualを指定します。	Prometheus server，Alertmanager，Windows exporter，Blackbox exporter，Yet another cloudwatch exporter，Promitor Scraper，Promitor Resource Discovery，Script exporter，統合エージェント制御基盤（imagentおよびimagentproxy），Fluentd，Web exporter，VMware exporter，Windows exporter（Hyper-V監視），およびSQL exporterの場合 Automatic
	<logpath>		ログ出力先ディレクトリ（ログファイルが作成されるディレクトリ）を指定します。指定を省略した場合，設定ファイルが存在するディレクトリがデフォルトとなります。値を変更する場合は，値を変更したあとで，サービスを再起動してください。	○	−	セットアップ時に自動設定します。
	<log mode="roll-by-size">		ログ出力のモードはroll-by-sizeモードです。appendモードと同様に動作しますが，ログファイルサイズに設定した値を超えた場合は，myapp.1.out.log，myapp.2.out.logなどにロールされます。	△	−	−
		<sizeThreshold>	ログファイルサイズ（ローテーションのしきい値）を変更するときにKB単位で指定します。値を変更する場合は，値を変更したあとで，サービスを再起動してください。	△	サポート窓口から値の変更を指示されたときに設定を変更します。	10240（imagent，imagentproxy，imagentaction，OracleDB exporterの場合だけ1024）
		<keepFiles>	ログ面数（保持するロールファイルの数）を変更するときに指定します。指定した面数＋1面のログが作成されます。値を変更する場合は，値を変更したあとで，サービスを再起動してください。設定できる値の範囲は1〜511です。	〇	サポート窓口から値の変更を指示されたときに設定を変更します。	7（Fluentdの場合だけ99。OracleDB exporterの場合3。imagent，imagentproxy，imagentactionの場合1。）
	<stoptimeout>		サービスの停止待ち時間（プログラムに停止要求を出してから，サービスが停止するまでの最大待ち時間）を指定します。値を変更する場合は，値を変更したあとで，サービスを再起動してください。	〇	停止待ち時間を変更したいときに設定を変更します。	Prometheus serverの場合 110sec Alertmanager，Windows exporter，Blackbox exporter，Yet another cloudwatch exporter，Promitor Scraper，Promitor Resource Discovery，Script exporter，Fluentd，OracleDB exporter，Web exporter，VMware exporter，Windows exporter（Hyper-V監視），およびSQL exporterの場合 60sec 統合エージェント制御基盤（imagent）の場合 90sec 統合エージェント制御基盤（imagentproxy）の場合 140sec 統合エージェント制御基盤（imagentaction）の場合 60sec
	<env name="IMA_OSSWRAPPER_RESTART_INTERVAL" value="OSSラッパーがOSSのプロセスを再起動する間隔">		環境変数IMA_OSSWRAPPER_RESTART_INTERVALの値（OSSラッパーがOSSのプロセスを再起動する間隔）を時間単位で指定します。指定できる値は0〜2160（90日）です。デフォルト値は0です。次の場合はOSSのプロセスを再起動は行いません。この環境変数を設定していない場合この環境変数の値に0が指定された場合指定された値を整数値に変換できない場合指定できる範囲外の値が指定された場合 OSSのプロセスを起動する直前を基点とし，デフォルト値または指定された値の時間が経過したときに，OSSのプロセスを再起動します。	〇	−	name="IMA_OSSWRAPPER_RESTART_INTERVAL" value="0"

（凡例）: 〇：変更可　△：変更不可　−：該当なし
注※: 複数マネージャーホストへのデータ配信機能を使用する場合のサービス定義ファイルの記述内容については，マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「3.15.7(5)(c)セカンダリーのサービス起動の設定」の「サービス定義ファイル（Windowsの場合）」を参照してください。

prometheusコマンドのオプション

項目名	説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
--config.file="jpc_prometheus_server.yml"	Prometheusの設定ファイルのパスを指定します。	〇	−	--config.file="Agentパス/conf/jpc_prometheus_server.yml"
--web.listen-address="0.0.0.0:9090"	待ち受けポートを指定します。リッスンするIPアドレスを限定したい場合は，ホスト名またはIPアドレスも記載します。ホスト名を指定する場合は255バイトまで指定できます。＜設定例＞すべてのIPアドレスに対する要求を受け付ける場合は，次のように設定します。 --web.listen-address="0.0.0.0:20713" 受け付けるIPアドレスを制限する場合は，次のようにホスト名またはIPアドレスを指定して制限できます。 --web.listen-address="ホスト名またはIPアドレス:20713"	〇	ポートを変更したい場合，または，リッスンするIPアドレスを限定したい場合に指定します。	--web.listen-address="0.0.0.0:20713"
--web.read-timeout=5m	リクエストの読み取りをタイムアウトして，アイドル状態のコネクションを閉じるまでの最大時間を指定します。	△	−	--web.read-timeout=5m
--web.max-connections=512	最大同時接続数を指定します。	△	−	--web.max-connections=10
--web.enable-lifecycle	HTTPリクエストによるシャットダウンとリロードを有効にする場合に指定します。	△	−	--web.enable-lifecycle
--storage.tsdb.path="data/"	パフォーマンスデータの保存先パスを指定します。	△	−	--storage.tsdb.path="data/prometheus_server/"
--storage.tsdb.min-block-duration=2h	ブロックの最小期間を指定します。	△	−	--storage.tsdb.min-block-duration=1h
--storage.tsdb.max-block-chunk-segment-size=512MB	ブロック内の単一のチャンクセグメントの最大サイズを指定します。	△	−	--storage.tsdb.max-block-chunk-segment-size=32MB
--storage.tsdb.retention.time=STORAGE.TSDB.RETENTION.TIME	パフォーマンスデータの保存期間を，時間単位または日単位で指定します。時間単位 1hから360hの範囲で指定します。日単位 1dから366dの範囲で指定します。＜設定例＞ --storage.tsdb.retention.time=24h	○	アラートルールの条件に範囲ベクトルセレクターを使用する場合，その範囲より大きい値を指定します。	--storage.tsdb.retention.time=1h
--storage.remote.flush-deadline=<duration>	リモートライトやアラート送信ができない状態で停止する際の最大待ち時間を指定します。	△	−	--storage.remote.flush-deadline=5s
--rules.alert.for-outage-tolerance=1h	アラートの「pending」状態を復元できるPrometheus serverの最大停止期間を指定します。	△	−	--rules.alert.for-outage-tolerance=1h
--rules.alert.for-grace-period=10m	アラートから復元された場合の「for」状態の最小期間を指定します。このオプションよりも長い「for」時間が設定されているアラートに対してだけ有効です。	△	−	--rules.alert.for-grace-period=10m
--log.level=info	指定されたレベル以上のメッセージだけをログに出力します。指定できるレベルは，debug，info，warn，errorのどれかです。	△	サポート窓口から値の変更を指示されたときに設定を変更します。通常は変更不要です。	--log.level=debug

（凡例）: 〇：変更可　△：変更不可　−：該当なし

alertmanagerコマンドのオプション

項目名	説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
--config.file="jpc_alertmanager.yml"	Alertmanagerの設定ファイルのパスを指定します。	〇	−	--config.file="Agentパス/conf/jpc_alertmanager.yml"
--storage.path="data/"	管理用データの保存先パスを指定します。	△	−	--storage.path="data/alertmanager/"
--data.retention=120h	管理用データの保存期間を指定します。 Silenceの情報や発生したアラートの情報が保存されます。	△	−	--data.retention=168h
--alerts.gc-interval=30m	Garbage Collectionのインターバルを指定します。	△	−	--alerts.gc-interval=30m
--web.listen-address=":9093"	待ち受けポートを指定します。リッスンするIPアドレスを限定したい場合は，ホスト名またはIPアドレスも記載します。ホスト名を指定する場合は255バイトまで指定できます。このオプションに，ホスト名またはIPアドレスを指定する場合は，同じホスト上にあるPrometheus設定ファイル（jpc_prometheus_server.yml）のalerting.alertmanagers.static_configs.targetsに記載されているlocalhostに，このオプションと同じホスト名またはIPアドレスを設定し，Prometheus serverを再起動またはリロードする必要があります。＜設定例＞すべてのIPアドレスに対する要求を受け付ける場合は，次のように設定します。 --web.listen-address=":20714" 受け付けるIPアドレスを制限する場合は，次のようにホスト名またはIPアドレスを指定して制限できます。 --web.listen-address="ホスト名またはIPアドレス:20714"	〇	ポートを変更したい場合，または，リッスンするIPアドレスを限定したい場合に指定します。	--web.listen-address=":20714"
--web.get-concurrency=0	同時に処理するGETリクエストの最大数を指定します。	△	−	--web.get-concurrency=0
--web.timeout=0	HTTPリクエストのタイムアウト時間を指定します。	△	−	--web.timeout=0
--cluster.listen-address="0.0.0.0:9094"	AlertmanagerをHAモードで動作させるときにリッスンアドレスを指定します。空の文字列を設定すると，HAモードが無効になります。	△	−	--cluster.listen-address=""
--log.level=info	指定されたレベル以上のメッセージだけをログに出力します。指定できるレベルは，debug，info，warn，errorのどれかです。	△	サポート窓口から値の変更を指示されたときに設定を変更します。通常は変更不要です。	--log.level=info
--log.format=logfmt	ログメッセージの出力形式を指定します。使用できる出力形式はlogfmtまたはjsonです。	△	−	--log.format=logfmt

（凡例）: 〇：変更可　△：変更不可　−：該当なし

windows_exporterコマンドのオプション

項目名	説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
--telemetry.addr	待ち受けポートを指定します。リッスンするIPアドレスを限定したい場合は，ホスト名またはIPアドレスも記載します。ホスト名を指定する場合は255バイトまで指定できます。このオプションに，ホスト名を指定する場合は，同じホスト上にあるWindows exporterのディスカバリ設定ファイル（jpc_file_sd_config_windows.yml）のtargetsに，このオプションと同じホスト名を設定し，Prometheus serverを再起動またはリロードする必要があります。このオプションに，IPアドレスを指定する場合は，同じホスト上にあるWindows exporterのディスカバリ設定ファイル（jpc_file_sd_config_windows.yml）のtargetsに，このオプションと同じIPアドレスに解決されるホスト名を設定し，Prometheus serverを再起動またはリロードする必要があります。＜設定例＞すべてのIPアドレスに対する要求を受け付ける場合は，次のように設定します。 --telemetry.addr=":20717" 受け付けるIPアドレスを制限する場合は，次のようにホスト名またはIPアドレスを指定して制限できます。 --telemetry.addr="ホスト名またはIPアドレス:20717"	〇	ポートを変更したい場合，または，リッスンするIPアドレスを限定したい場合に指定します。	--telemetry.addr=":20717"
--config.file	Windows exporterの設定ファイルのパスを指定します。このファイルに設定された値は，コマンドラインオプションによって上書きされます。	〇	−	--config.file="Agentパス`/`conf`/`jpc_windows_exporter.yml"
--log.level	指定されたレベル以上のメッセージだけをログに出力します。指定できるレベルは，debug，info，warn，errorのどれかです。	△	−	--log.level=debug

項目名

説明

変更可否

JP1/IM - Agentでユーザーが設定する内容

JP1/IM - Agentのデフォルト値

--telemetry.addr

待ち受けポートを指定します。リッスンするIPアドレスを限定したい場合は，ホスト名またはIPアドレスも記載します。ホスト名を指定する場合は255バイトまで指定できます。

このオプションに，ホスト名を指定する場合は，同じホスト上にあるWindows exporterのディスカバリ設定ファイル（jpc_file_sd_config_windows.yml）のtargetsに，このオプションと同じホスト名を設定し，Prometheus serverを再起動またはリロードする必要があります。

このオプションに，IPアドレスを指定する場合は，同じホスト上にあるWindows exporterのディスカバリ設定ファイル（jpc_file_sd_config_windows.yml）のtargetsに，このオプションと同じIPアドレスに解決されるホスト名を設定し，Prometheus serverを再起動またはリロードする必要があります。

＜設定例＞

すべてのIPアドレスに対する要求を受け付ける場合は，次のように設定します。

--telemetry.addr=":20717"

受け付けるIPアドレスを制限する場合は，次のようにホスト名またはIPアドレスを指定して制限できます。

--telemetry.addr="ホスト名またはIPアドレス:20717"

〇

ポートを変更したい場合，または，リッスンするIPアドレスを限定したい場合に指定します。

--telemetry.addr=":20717"

--config.file

Windows exporterの設定ファイルのパスを指定します。

このファイルに設定された値は，コマンドラインオプションによって上書きされます。

〇

−

--config.file="Agentパス/conf/jpc_windows_exporter.yml"

--log.level

指定されたレベル以上のメッセージだけをログに出力します。

指定できるレベルは，debug，info，warn，errorのどれかです。

△

−

--log.level=debug

（凡例）: 〇：変更可　△：変更不可　−：該当なし

windows_exporterコマンドのオプション（Hyper-V監視）

項目名	説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
--telemetry.addr	待ち受けポートを指定します。リッスンするIPアドレスを限定したい場合は，ホスト名またはIPアドレスも記載します。ホスト名を指定する場合は255バイトまで指定できます。このオプションに，ホスト名を指定する場合は，同じホスト上にあるWindows exporter（Hyper-V監視）のディスカバリ設定ファイル（jpc_file_sd_config_windows_hyperv.yml）のtargetsに，同じホスト名を設定し，Prometheus serverを再起動またはリロードする必要があります。このオプションに，IPアドレスを指定する場合は，同じホスト上にあるWindows exporter（Hyper-V監視）のディスカバリ設定ファイル（jpc_file_sd_config_windows_hyperv.yml）のtargetsに，このオプションと同じIPアドレスに解決されるホスト名を設定し，Prometheus serverを再起動またはリロードする必要があります。＜設定例＞すべてのIPアドレスに対する要求を受け付ける場合は，次のように設定します。 --telemetry.addr=":20717" 受け付けるIPアドレスを制限する場合は，次のようにホスト名またはIPアドレスを指定して制限できます。 --telemetry.addr="ホスト名またはIPアドレス:20713"	〇	ポートを変更したい場合，または，リッスンするIPアドレスを限定したい場合に指定します。	20734
--config.file	Windows exporter（Hyper-V監視）設定ファイルのパスを指定します。このファイルに設定された値は，コマンドラインオプションによって上書きされます。	〇	−	CONFIG.FILE
--log.level	指定されたレベル以上のメッセージだけをログに出力します。指定できるレベルは，debug，info，warn，errorのどれかです。	△	−	"debug"

項目名

説明

変更可否

JP1/IM - Agentでユーザーが設定する内容

JP1/IM - Agentのデフォルト値

--telemetry.addr

このオプションに，ホスト名を指定する場合は，同じホスト上にあるWindows exporter（Hyper-V監視）のディスカバリ設定ファイル（jpc_file_sd_config_windows_hyperv.yml）のtargetsに，同じホスト名を設定し，Prometheus serverを再起動またはリロードする必要があります。

このオプションに，IPアドレスを指定する場合は，同じホスト上にあるWindows exporter（Hyper-V監視）のディスカバリ設定ファイル（jpc_file_sd_config_windows_hyperv.yml）のtargetsに，このオプションと同じIPアドレスに解決されるホスト名を設定し，Prometheus serverを再起動またはリロードする必要があります。

＜設定例＞

すべてのIPアドレスに対する要求を受け付ける場合は，次のように設定します。

--telemetry.addr=":20717"

受け付けるIPアドレスを制限する場合は，次のようにホスト名またはIPアドレスを指定して制限できます。

--telemetry.addr="ホスト名またはIPアドレス:20713"

〇

ポートを変更したい場合，または，リッスンするIPアドレスを限定したい場合に指定します。

20734

--config.file

Windows exporter（Hyper-V監視）設定ファイルのパスを指定します。

このファイルに設定された値は，コマンドラインオプションによって上書きされます。

〇

−

CONFIG.FILE

--log.level

指定されたレベル以上のメッセージだけをログに出力します。

指定できるレベルは，debug，info，warn，errorのどれかです。

△

−

"debug"

（凡例）: 〇：変更可　△：変更不可　−：該当なし

blackbox_exporterコマンドのオプション

項目名	説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
--config.file	Blackbox exporterの設定ファイルのパスを指定します。	〇	−	--config.file="Agentパス/conf/jpc_blackbox_exporter.yml"
--web.listen-address	待ち受けポートを指定します。リッスンするIPアドレスを限定したい場合は，ホスト名またはIPアドレスも記載します。ホスト名を指定する場合は255バイトまで指定できます。このオプションに，ホスト名またはIPアドレスを指定する場合は，同じホスト上にあるPrometheus設定ファイル（jpc_prometheus_server.yml）のblackbox_exporter用のスクレイプジョブのrelabel_config内に記載されているlocalhost（複数存在します）に，このオプションと同じホスト名またはIPアドレスを設定し，Prometheus serverを再起動またはリロードする必要があります。＜設定例＞すべてのIPアドレスに対する要求を受け付ける場合は，次のように設定します。 --web.listen-address=":20715" 受け付けるIPアドレスを制限する場合は，次のようにホスト名またはIPアドレスを指定して制限できます。 --web.listen-address="ホスト名またはIPアドレス:20715"	〇	ポートを変更したい場合，または，リッスンするIPアドレスを限定したい場合に指定します。	--web.listen-address=":20715"
--timeout-offset	Prometheusのscrape_timeoutの値から減算する秒数を指定します。 Prometheusのscrape_timeoutの値からこのオプションに指定された値を減算した秒数でタイムアウトするようになります。	△	タイムアウト時間から差し引くオフセット（秒）	--timeout-offset=0.5
--history.limit	Probe結果の履歴の上限を指定します。この履歴はblackbox_exporter内部に保存され，古い履歴は削除されていきます。	△	履歴に残すアイテム数の上限	--history.limit=100
--log.level	指定されたレベル以上のメッセージだけをログに出力します。指定できるレベルは，debug，info，warn，errorのどれかです。	△	サポート窓口から値の変更を指示されたときに設定を変更します。通常は変更不要です。	--log.level=info

（凡例）: 〇：変更可　△：変更不可　−：該当なし

promitor_scraperコマンドのオプション

指定できるオプションはありません。
promitor_resource_discoveryコマンドのオプション

指定できるオプションはありません。

script_exporterコマンドのオプション

項目名	説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
-config.file	Script exporterの設定ファイルのパスを指定します。	○	−	Windowsの場合インストール先`\jp1ima\conf\jpc_script_exporter.yml` Linuxの場合 `/opt/jp1ima/conf/jpc_script_exporter.yml`
-web.listen-address	待ち受けポートを指定します。リッスンするIPアドレスを限定したい場合は，ホスト名またはIPアドレスも記載します。ホスト名を指定する場合は255バイトまで指定できます。＜設定例＞すべてのIPアドレスに対する要求を受け付ける場合は，次のように設定します。 --web.listen-address=":9469" 受け付けるIPアドレスを制限する場合は，次のようにホスト名またはIPアドレスを指定して制限できます。 --web.listen-address="ホスト名またはIPアドレス:9469"	○	ポートを変更したい場合，または，リッスンするIPアドレスを限定したい場合に指定します。	20722
-timeout-offset	Prometheusのscrape_timeoutの値から減算する秒数を指定します。 Prometheusのscrape_timeoutの値からこのオプションに指定された値を減算した秒数でタイムアウトするようになります。	△	タイムアウト時間から差し引くオフセット（秒）	--timeout-offset=0.5

項目名

説明

変更可否

JP1/IM - Agentでユーザーが設定する内容

JP1/IM - Agentのデフォルト値

-config.file

Script exporterの設定ファイルのパスを指定します。

○

−

Windowsの場合

インストール先\jp1ima\conf\jpc_script_exporter.yml
Linuxの場合

/opt/jp1ima/conf/jpc_script_exporter.yml

-web.listen-address

＜設定例＞

すべてのIPアドレスに対する要求を受け付ける場合は，次のように設定します。

--web.listen-address=":9469"

受け付けるIPアドレスを制限する場合は，次のようにホスト名またはIPアドレスを指定して制限できます。

--web.listen-address="ホスト名またはIPアドレス:9469"

○

ポートを変更したい場合，または，リッスンするIPアドレスを限定したい場合に指定します。

20722

-timeout-offset

Prometheusのscrape_timeoutの値から減算する秒数を指定します。

Prometheusのscrape_timeoutの値からこのオプションに指定された値を減算した秒数でタイムアウトするようになります。

△

タイムアウト時間から差し引くオフセット（秒）

--timeout-offset=0.5

（凡例）: ○：変更可　△：変更不可　−：該当なし

fluentdコマンドのオプション

項目名		説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
-c	--config.file PATH	Fluentdの設定ファイルのパスを指定します。	〇	論理ホストの場合は，論理ホストの共有フォルダに配置したログ監視共通定義ファイルのパスに修正する必要があります。	Fluentdのログ監視共通定義ファイルのパス
'-i CONFIG_STRING	--enable-input-metrics	Fluentdの入力プラグインメトリックを有効にします。	△	−	なし
-G	--conf-encoding ENCODING	構成ファイルのエンコーディングを指定します。	△	−	UTF-8

（凡例）: 〇：変更可　△：変更不可　−：該当なし

oracledb_exporterコマンドのオプション

項目名	説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
--web.telemetry-path="/metrics"	スクレイプするURLを指定します。	△	−	"/metrics"
--default.metrics="default-metrics.toml"	デフォルトメトリックの定義ファイルを指定します。	△	−	"default_metrics.toml"
--custom.metrics=""	カスタムメトリックの定義ファイルを指定します。	△	−	""
--query.timeout=5	oracledb_exporterからOracle Databaseにアクセスして情報を取得するときのタイムアウト時間を指定します。時間単位で5から60で指定します。＜設定例＞ --query.timeout=5	〇	Oracle Databaseから情報を取得するのに時間がかかる場合に指定します。	5
--database.maxIdleConns=0	アイドル状態の接続数の最大値を指定します。	△	−	0
--database.maxOpenConns=10	オープン状態の接続数の最大値を指定します。	△	−	1
--scrape.interval=0s	スクレイプ間隔を指定します。	△	−	0s
--[no-]web.systemd-socket	ソケットベースのアクティベーションを使用する場合に指定します。	△	−	指定しない（使用しない）
--web.listen-address=:9161	待ち受けポートを指定します。リッスンするIPアドレスを限定したい場合は，ホスト名またはIPアドレスも記載します。ホスト名を指定する場合は255バイトまで指定できます。このオプションに，ホスト名またはIPアドレスを指定する場合は，同じホスト上にあるPrometheus設定ファイル（jpc_prometheus_server.yml）のoracledb_exporter用のスクレイプジョブのrelabel_config内に記載されているlocalhost（複数存在します）に，このオプションと同じホスト名またはIPアドレスを設定し，Prometheus serverを再起動またはリロードする必要があります。＜設定例＞すべてのIPアドレスに対する要求を受け付ける場合は，次のように設定します。 --web.listen-address=":20729" 受け付けるIPアドレスを制限する場合は，次のようにホスト名またはIPアドレス指定して制限できます。 --web.listen-address="ホスト名またはIPアドレス:20729"	〇	ポートを変更したい場合，または，リッスンするIPアドレスを限定したい場合に指定します。	--web.listen-address="@@port@@"
--log.level=info	指定されたレベル以上のメッセージだけをログに出力します。指定できるレベルは，debug，info，warn，errorのどれかです。	△	サポート窓口から値の変更を指示されたときに設定を変更します。通常は変更不要です。	--log.level=info

（凡例）: 〇：変更可　△：変更不可　−：該当なし

web_exporterコマンドのオプション

項目名	説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
--config.file	Web exporterの設定ファイルのパスを指定します。	○	−	--config.file="Agentパス`/conf/jpc_web_exporter.yml`"
--web.listen-address	待ち受けポートを数字で指定します。リッスンするIPアドレスを限定したい場合は，ホスト名またはIPアドレスも記載します。ホスト名を指定する場合は255バイトまで指定できます。このオプションに，ホスト名またはIPアドレスを指定する場合は，同じホスト上にあるPrometheus設定ファイル（jpc_prometheus_server.yml）のweb_exporter用のスクレイプジョブのrelabel_config内に記載されているlocalhost（複数存在します）に，このオプションと同じホスト名またはIPアドレスを設定し，Prometheus serverを再起動またはリロードする必要があります。＜設定例＞すべてのIPアドレスに対する要求を受け付ける場合は，次のように設定します。 --web.listen-address="0.0.0.0:20731" 受け付けるIPアドレスを制限する場合は，次のようにホスト名またはIPアドレスを指定して制限できます。 --web.listen-address="ホスト名またはIPアドレス:20731"	〇	ポートを変更したい場合，または，リッスンするIPアドレスを限定したい場合に指定します。	--web.listen-address=":20731"
--timeout-offset	Prometheusのscrape_timeoutの値から減算する秒数を指定します。 Prometheusのscrape_timeoutの値からこのオプションに指定された値を減算した秒数でタイムアウトするようになります。	△	タイムアウト時間から差し引くオフセット（秒）	--timeout-offset=0.5
--log.level	指定されたレベル以上のメッセージだけをログに出力します。指定できるレベルは，debug，info，warn，errorのどれかです。	△	サポート窓口から値の変更を指示されたときに設定を変更します。通常は変更不要です。	--log.level=info

（凡例）: 〇：変更可　△：変更不可　−：該当なし

vmware_exporterコマンドのオプション

項目名		説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
-c	--config	設定ファイルのパスを指定します。	〇	設定ファイルの配置先を変更したいときに設定を変更します。	--config="Agentパス/conf/jpc_vmware_exporter.yml"
-a	--address	Exporterを起動するWebサーバのアドレスを指定します。指定しない場合はローカルホストのアドレスで実行します。	〇	Exporterを起動するIPアドレスを変更する際に指定します。	なし
-p	--port	待ち受けポートを指定します。	〇	ポートを変更したいときに設定を変更します。	20732
-l	--loglevel	指定されたレベル以上のメッセージだけをログに出力します。指定できるレベルは，INFOまたはDEBUGのどちらかです。	△	サポート窓口から値の変更を指示されたときに設定を変更します。通常は変更不要です。	--loglevel=info

（凡例）: 〇：変更可　△：変更不可　−：該当なし

sql_exporterコマンドのオプション

項目名	説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
--config.file	SQL exporter設定ファイルのパスを指定します。このファイルに設定された値は，コマンドラインオプションによって上書きされます。	△	−	sql_exporter.yml
--log.format	ログメッセージの出力形式を設定します。	△	−	logfmt
--log.level	指定されたレベル以上のメッセージだけをログに出力します。指定できるレベルは，debug，info，warn，errorのどれかです。	△	通常は変更不要です。サポート窓口から値の変更を指示されたときに設定を変更します。	info
-web.listen-address	待ち受けポートを指定します。リッスンするIPアドレスを限定した場合は，ホスト名またはIPアドレスも記載します。	〇	ポートを変更したい場合，または，リッスンするIPアドレスを限定したい場合に指定します。	20735
-web.metrics-path	メトリクスを公開するパスを指定します。	△	−	/metrics

（凡例）: 〇：変更可　△：変更不可　−：該当なし

ページの先頭へ