サービス定義ファイル(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>
ファイル
-
物理ホスト用
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 |
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 |
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 |
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は,システムにインストールされているすべてのサービスの中で一意,かつ,すべて英数字で構成されている必要があります。 |
△ |
− |
|
||
<name> |
サービスの表示名(サービスの短い表示名)を指定します(任意)。 空白文字やほかの文字を含めることができます。<id>のように長い文字列は指定しないでください。また,特定のシステム内のすべてのサービス間で一意である必要があります。 |
△ |
− |
|
||
<description> |
説明を(長い説明文)を指定します(任意)。 この説明は,サービスが選択されたときに,Windowsサービスコントロールマネージャーに表示されます。 |
△ |
− |
|
||
<workingdirectory> |
作業ディレクトリ(サービスのカレントディレクトリ)を指定します。 |
△ |
− |
|
||
<env name="環境変数名" value="値"> |
環境変数名と値を指定します。 Promitor Scraper,Promitor Resource Discovery,およびOracleDB exporterの場合に指定します。 |
|
− |
|
||
<executable> |
プログラムのパス(起動する実行ファイルのパス)を指定します(必須)。 絶対パスを指定,または実行ファイル名を指定してPATHから検索させることができます。 ただし,サービスは別のユーザーアカウントで実行されることが多いため,シェルとは異なるPATHを持つ可能性があることに注意してください。 空の文字列を指定してもエラーにならないため,注意してください。 |
△ |
− |
|
||
<arguments> |
プログラムの引数(起動する実行ファイルに渡す引数)を指定します。 値を変更する場合は,値を変更したあとで,サービスを再起動してください。 |
〇 |
引数を変更したいときに設定を変更します。 |
|
||
<startmode> |
スタートアップの種類(Windowsサービスの開始モード)を指定します(任意)。 次のどちらかの値を指定します。
値を変更する場合は,一度サービスのアンインストールを実行し,値を変更したあとで,サービスの再インストールを実行してください。 |
〇 |
|
|
||
<logpath> |
ログ出力先ディレクトリ(ログファイルが作成されるディレクトリ)を指定します。 指定を省略した場合,設定ファイルが存在するディレクトリがデフォルトとなります。 値を変更する場合は,値を変更したあとで,サービスを再起動してください。 |
○ |
− |
セットアップ時に自動設定します。 |
||
<log mode="roll-by-size"> |
ログ出力のモードはroll-by-sizeモードです。appendモードと同様に動作しますが,ログファイルサイズに設定した値を超えた場合は,myapp.1.out.log,myapp.2.out.logなどにロールされます。 |
△ |
− |
− |
||
<sizeThreshold> |
ログファイルサイズ(ローテーションのしきい値)を変更するときにKB単位で指定します。 値を変更する場合は,値を変更したあとで,サービスを再起動してください。 |
△ |
サポート窓口から値の変更を指示されたときに設定を変更します。 |
10240 |
||
<keepFiles> |
ログ面数(保持するロールファイルの数)を変更するときに指定します。 指定した面数+1面のログが作成されます。 値を変更する場合は,値を変更したあとで,サービスを再起動してください。 設定できる値の範囲は7〜511です。 |
〇 |
サポート窓口から値の変更を指示されたときに設定を変更します。 |
7(Fluentdの場合だけ99) |
||
<stoptimeout> |
サービスの停止待ち時間(プログラムに停止要求を出してから,サービスが停止するまでの最大待ち時間)を指定します。 値を変更する場合は,値を変更したあとで,サービスを再起動してください。 |
〇 |
停止待ち時間を変更したいときに設定を変更します。 |
|
- (凡例)
-
〇:変更可 △:変更不可 −:該当なし
-
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
パフォーマンスデータの保存期間を,1〜48hの範囲で時間単位で指定します。
<設定例>
--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
- (凡例)
-
〇:変更可 △:変更不可 −:該当なし
-
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
-
- (凡例)
-
○:変更可 △:変更不可 −:該当なし
-
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.ymlのoracledb_exporter用のスクレイプジョブのrelabel_confg内に記載されている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
- (凡例)
-
〇:変更可 △:変更不可 −:該当なし