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

〈このページの構成〉

形式
記述内容

形式

<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>

ページの先頭へ

記述内容

IMエクスポーターが提供するアドオンプログラムで使用するExporter（Windows exporter，Yet another cloudwatch exporter，Promitor Scraper，Promitor Resource Discovery，およびScript exporter）で定義できる記述内容だけを，次に示します。そのほかのサービス定義ファイルの詳細については，JP1/IM - Agentの「サービス定義ファイル（jpc_プログラム名_service.xml）」（2.　定義ファイル）を参照してください。

項目名		説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
<service>		サービスの設定をします。	−	−	−
	<id>	サービスのID（Windowsがサービスを識別するために内部的に使用するID）を指定します（必須）。このIDは，システムにインストールされているすべてのサービスの中で一意，かつ，すべて英数字で構成されている必要があります。	△	−	Windows exporterの場合 jpc_windows_exporter 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
	<name>	サービスの表示名（サービスの短い表示名）を指定します（任意）。空白文字やほかの文字を含めることができます。<id>のように長い文字列は指定しないでください。また，特定のシステム内のすべてのサービス間で一意である必要があります。	△	−	Windows exporterの場合 JPC Windows Exporter 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
	<description>	説明を（長い説明文）を指定します（任意）。この説明は，サービスが選択されたときに，Windowsサービスコントロールマネージャーに表示されます。	△	−	Windows exporterの場合 windows_exporter 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
	<env name="環境変数名" value="値">	環境変数名と値を指定します。 Promitor ScraperおよびPromitor Resource Discoveryの場合に指定します。	△	−	Promitor Scraperの場合 name="PROMITOR_CONFIG_FOLDER" value="インストール先/jp1pccs/conf/promitor/scraper" Promitor Resource Discoveryの場合 name="PROMITOR_CONFIG_FOLDER" value="インストール先/jp1pccs/conf/promitor/resource-discovery"
	<executable>	プログラムのパス（起動する実行ファイルのパス）を指定します（必須）。絶対パスを指定，または実行ファイル名を指定してPATHから検索させることができます。ただし，サービスは別のユーザーアカウントで実行されることが多いため，シェルとは異なるPATHを持つ可能性があることに注意してください。空の文字列を指定してもエラーにならないため，注意してください。	△	−	Windows exporterの場合 windows_exporter.exe Yet another cloudwatch exporterの場合 ya_cloudwatch_exporter.exe Promitor Scraperの場合 promitor_scraper.exe Promitor Resource Discoveryの場合 promitor_resource_discovery.exe Script exporterの場合 script_exporter.exe
	<arguments>	プログラムの引数（起動する実行ファイルに渡す引数）を指定します。値を変更する場合は，値を変更したあとで，サービスを再起動してください。	〇	引数を変更したいときに設定を変更します。	Windows exporterの場合 windows_exporter.exeの引数については，JP1/IM - Agentの「サービス定義ファイル（jpc_プログラム名_service.xml）」（2.　定義ファイル）の「windows_exporterコマンドのオプション」を参照してください。 Yet another cloudwatch exporterの場合 ya_cloudwatch_exporter.exeの引数については，JP1/IM - Agentの「サービス定義ファイル（jpc_プログラム名_service.xml）」（2.　定義ファイル）の「ya_cloudwatch_exporterコマンドのオプション」を参照してください。 Promitor Scraperの場合 promitor_scraper.exeの引数については，「promitor_scraperコマンドのオプション」を参照してください。 Promitor Resource Discoveryの場合 promitor_resource_discovery.exeの引数については，「promitor_resource_discoveryコマンドのオプション」を参照してください。 Script exporterの場合 script_exporter.exeの引数については，「script_exporterコマンドのオプション」を参照してください。
	<startmode>	スタートアップの種類（Windowsサービスの開始モード）を指定します（任意）。次のどちらかの値を指定します。 Automatic（自動） Manual（手動）値を変更する場合は，一度サービスのアンインストールを実行し，値を変更したあとで，サービスの再インストールを実行してください。	〇	クラスタ運用のときはManualを指定します。	Automatic
	<stoptimeout>	サービスの停止待ち時間（プログラムに停止要求を出してから，サービスが停止するまでの最大待ち時間）を指定します。値を変更する場合は，値を変更したあとで，サービスを再起動してください。	〇	停止待ち時間を変更したいときに設定を変更します。	Windows exporter，Yet another cloudwatch exporter，Promitor Scraper，Promitor Resource Discovery，およびScript exporterの場合 60sec

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

promitor_scraperコマンドのオプション

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

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

script_exporterコマンドのオプション

項目名	説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
-config.file	Script exporterの設定ファイルのパスを指定します。	○	−	--config.file="インストール先/jp1pccs/conf/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の設定ファイルのパスを指定します。

○

−

--config.file="インストール先/jp1pccs/conf/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

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

ページの先頭へ