ユニット定義ファイル(jpc_プログラム名.service)
形式
[Unit] Description = ユニットの説明 After=local-fs.target remote-fs.target rsyslog.service network.target [Service] WorkingDirectory = 作業ディレクトリ ExecStart = /bin/sh -c 'プログラムの起動コマンドライン |& (trap "" 15 && exec インストール先ディレクトリ/jp1ima/bin/rotatelogs -n 8※1 ログ出力先ディレクトリ※2 10240K)' Type = simple Restart=no User=root TimeoutStopSec=終了タイムアウト時間 LimitNOFILE=65536※3 Environment=SIGDUMP_PATH=-※3 [Install] WantedBy=multi-user.target graphical.target
- 注※1
-
Fluentdのユニット定義ファイルの場合だけ「100」を指定します。
- 注※2
-
初期値として設定されるログ出力先ディレクトリは,プログラムによって異なります。初期値のパスについては,マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「付録A.4(4) 統合エージェントホスト(Linux)」の「統合エージェントホスト(Linux)のJP1/IM - Agentでユーザーが参照・編集できるファイル・ディレクトリ一覧」を参照してください。
- 注※3
-
Fluentdのユニット定義ファイルの場合だけ記載します。
説明
Linux環境でプログラムをsystemctlに登録するための定義ファイルです。
ファイル
-
物理ホスト用
jpc_プログラム名.service
jpc_プログラム名.service.model(モデルファイル)
-
論理ホスト用
jpc_プログラム名_論理ホスト名.service
格納先ディレクトリ
- ■統合エージェントホスト
-
-
物理ホスト(モデルファイルの格納先)
/opt/jp1ima/conf/
-
物理ホストおよび論理ホスト(定義ファイルの格納先)
/usr/lib/systemd/system/
-
インストール先のターゲットは次のとおりです。
ターゲット名 |
説明 |
---|---|
multi-user.target |
runlevel=3 マルチユーザーモード(テキストログイン) |
graphical.target |
runlevel=5 マルチユーザーモード(グラフィカルログイン) |
文字コード
UTF-8(BOM無し)
改行コード
LF
定義の反映時期
systemctl daemon-reloadコマンドを実行したときに反映されます。
記述内容
Prometheus server,Alertmanager,およびExporterの依存するサービスの起動順序を,次に示します。
-
Prometheus serverの場合
依存するサービスの起動順序
説明
local-fs.target
ローカルファイルシステム
remote-fs.target
リモートファイルシステム
rsyslog.service
rsyslog
-
ExporterやAlertmanager,Fluentd,imagent,imagentproxy,imagentactionの場合
依存するサービスの起動順序
説明
local-fs.target
ローカルファイルシステム
remote-fs.target
リモートファイルシステム
rsyslog.service
rsyslog
network.target
ネットワーク
終了タイムアウト時間を,次に示します。
プログラムの種類 |
終了タイムアウト時間(単位:秒) |
---|---|
Prometheus server |
110 |
Alertmanager |
60 |
Node exporter |
|
Blackbox exporter |
|
Yet another cloudwatch exporter |
|
process_exporter |
|
promitor_scraper |
|
promitor_resource_discovery |
|
script_exporter |
|
Fluentd |
|
OracleDB exporter |
|
imagent |
140 |
imagentproxy |
|
imagentaction |
60 |
ユーザーが変更できる個所を,次に示します。
-
コマンドラインのオプションを変更したい場合
ExecStart行を編集します。
■Prometheus serverの場合
prometheusコマンドの引数については,「サービス定義ファイル(jpc_プログラム名_service.xml)」の「prometheusコマンドのオプション」の説明を参照してください。
■Alertmanagerの場合
alertmanagerコマンドの引数については,「サービス定義ファイル(jpc_プログラム名_service.xml)」の「alertmanagerコマンドのオプション」の説明を参照してください。
■Node exporterの場合
Node exporterコマンドの引数については,下記の「node_exporterコマンドのオプション」の説明を参照してください。
■Yet another cloudwatch exporterの場合
yet-another-cloudwatch-exporterコマンドの引数については,下記の「yet-another-cloudwatch-exporterコマンドのオプション」の説明を参照してください。
■Process exporterの場合
process_exporterコマンドの引数については,「Process exporter設定ファイル(jpc_process_exporter.yml)」の「process_exporterコマンドのオプション」の説明を参照してください。
■Primitorの場合
promitor_scraperコマンドおよびpromitor_resource_discoveryコマンドには,指定できる引数はありません。
■Script exporterの場合
script_exporterコマンドの引数については,「サービス定義ファイル(jpc_プログラム名_service.xml)」の「script_exporterコマンドのオプション」の説明を参照してください。
■OracleDB exporterの場合
oracledb_exporterコマンドの引数については,「サービス定義ファイル(jpc_プログラム名_service.xml)」の「oracledb_exporterコマンドのオプション」の説明を参照してください。
-
ログ面数を変更したい場合
ExecStart行の-nオプションの後ろの値を編集します。指定できるログ面数は8〜512です。
-
ログサイズを変更したい場合
ExecStart行の末尾の値を編集します。
-
ログの出力先を変更したい場合
rotatelogsの引数で指定するログ出力先ディレクトリを編集します。
-
プロセスが異常停止したときに自動的にプロセスを再起動する場合,Restartに「always」を指定します。クラスタ構成など,自動的にプロセスを再起動しない場合,Restartに「no」を指定します。
node_exporterコマンドのオプション,およびyet-another-cloudwatch-exporterコマンドのオプションを,次に示します。
-
node_exporterコマンドのオプション
コレクターに関する項目は,「--collector.コレクター名」フラグで有効化できます。コレクターに関する項目を無効化する場合は,「--no-collector.コレクター名」フラグを指定します。
項目名
説明
変更可否
JP1/IM - Agentでユーザーが設定する内容
JP1/IM - Agentのデフォルト値
--collector.cpu.info
node_cpu_infoメトリックの収集を有効にします。
有効にする場合,--collector.cpu.infoを指定します。
無効にする場合,--no-collector.cpu.infoを指定します。
○
−
--collector.cpu.info
--collector.filesystem.ignored-mount-points
filesystemコレクターで無視するマウントポイントの正規表現を指定します。
○
filesystemコレクターで無視するマウントポイントの正規表現
--collector.filesystem.ignored-mount-points="^/(dev|proc|sys|var/lib/docker/.+)($|/)"
--collector.filesystem.ignored-fs-types
filesystemコレクターで無視するファイルシステムタイプの正規表現を指定します。
○
filesystemコレクターで無視するマウントポイントの正規表現
--collector.filesystem.ignored-fs-types="^/(dev|proc|sys|var/lib/docker/.+)($|/)"
--collector.netstat.fields
netstatコレクターに返すフィールドの正規表現を指定します。
○
netstatコレクターに返すフィールドの正規表現
--collector.netstat.fields="^(.*_(InErrors|InErrs) |Ip_Forwarding|Ip(6|Ext)_(InOctets|OutOctets)|Icmp6?_(InMsgs|OutMsgs)|TcpExt_(Listen.*|Syncookies.*|TCPSynRetrans)|Tcp_(ActiveOpens|InSegs|OutSegs|OutRsts|PassiveOpens|RetransSegs|CurrEstab)|Udp6?_(InDatagrams|OutDatagrams|NoPorts|RcvbufErrors|SndbufErrors))$"
--path.procfs
procfsマウントポイントを指定します。
○
procfsマウントポイント
--path.procfs="/proc"
--path.sysfs
sysfsマウントポイントを指定します。
○
sysfsマウントポイント
--path.sysfs="/sys"
--path.rootfs
rootfsマウントポイントを指定します。
○
rootfsマウントポイント
--path.rootfs="/"
--collector.systemd.unit-include
サービス監視機能で監視するSystemdのユニットファイル名を,正規表現で指定します。
初期設定は空文字で,サービスは1つも監視されません。正規表現が不正な場合,Node exporterのサービスの起動に失敗します。
正規表現の指定のしかたによって,性能情報の収集に時間がかかることがあります。詳細については,マニュアル「JP1/Integrated
Management 3 - Manager 導入・設計ガイド」の「付録G.4 正規表現を使用する際のヒント」を参照してください。
○
ユニットファイル名にマッチする正規表現
--collector.systemd.unit-include=""
--collector.cpu
cpuコレクターを有効にします。
有効にする場合,--collector.cpuを指定します。
無効にする場合,--no-collector.cpuを指定します。
○
−
--collector.cpu
--collector.diskstats
diskstatsコレクターを有効にします。
有効にする場合,--collector.diskstatsを指定します。
無効にする場合,--no-collector.diskstatsを指定します。
○
−
--collector.diskstats
--collector.filesystem
filesystemコレクターを有効にします。
有効にする場合,--collector.filesystemを指定します。
無効にする場合,--no-collector.filesystemを指定します。
○
−
--collector.filesystem
--collector.loadavg
loadavgコレクターを有効にします。
有効にする場合,--collector.loadavgを指定します。
無効にする場合,--no-collector.loadavgを指定します。
○
−
--collector.loadavg
--collector.meminfo
meminfoコレクターを有効にします。
有効にする場合,--collector.meminfoを指定します。
無効にする場合,--no-collector.meminfoを指定します。
○
−
--collector.meminfo
--collector.netclass
netclassコレクターを有効にします。
有効にする場合,--collector.netclassを指定します。
無効にする場合,--no-collector.netclassを指定します。
○
−
--collector.netclass
--collector.netdev
netdevコレクターを有効にします。
有効にする場合,--collector.netdevを指定します。
無効にする場合,--no-collector.netdevを指定します。
○
−
--collector.netdev
--collector.netstat
netstatコレクターを有効にします。
有効にする場合,--collector.netstatを指定します。
無効にする場合,--no-collector.netstatを指定します。
○
−
--collector.netstat
--collector.nfs
nfsコレクターを有効にします。
有効にする場合,--collector.nfsを指定します。
無効にする場合,--no-collector.nfsを指定します。
○
−
--collector.nfs
--collector.nfsd
nfsdコレクターを有効にします。
有効にする場合,--collector.nfsdを指定します。
無効にする場合,--no-collector.nfsdを指定します。
○
−
--collector.nfsd
--collector.stat
statコレクターを有効にします。
有効にする場合,--collector.statを指定します。
無効にする場合,--no-collector.statを指定します。
○
−
--collector.stat
--collector.systemd
systemdコレクターを有効にします。
有効する場合,--collector.systemdを指定します。
無効にする場合,--nocollector.systemdを指定します。
○
−
--collector.systemd
--collector.time
timeコレクターを有効にします。
有効にする場合,--collector.timeを指定します。
無効にする場合,--no-collector.timeを指定します。
○
−
--collector.time
--collector.uname
unameコレクターを有効にします。
有効にする場合,--collector.unameを指定します。
無効にする場合,--no-collector.unameを指定します。
○
−
--collector.uname
--collector.vmstat
vmstatコレクターを有効にします。
有効にする場合,--collector.vmstatを指定します。
無効にする場合,--no-collector.vmstatを指定します。
○
−
--collector.vmstat
--web.listen-address
待ち受けポートを指定します。リッスンするIPアドレスを限定したい場合は,ホスト名またはIPアドレスも記載します。ホスト名を指定する場合は255バイトまで指定できます。
このオプションに,ホスト名を指定する場合は,同じホスト上にあるNode exporterのディスカバリ設定ファイル(jpc_file_sd_config_node.yml)のtargetsに,このオプションと同じホスト名を設定し,Prometheus serverを再起動またはリロードする必要があります。
このオプションに,IPアドレスを指定する場合は,同じホスト上にあるNode exporterのディスカバリ設定ファイル(jpc_file_sd_config_node.yml)のtargetsに,このオプションと同じIPアドレスに解決されるホスト名を設定し,Prometheus serverを再起動またはリロードする必要があります。
<設定例>
すべてのIPアドレスに対する要求を受け付ける場合は,次のように設定します。
--web.listen-address=":20716"
受け付けるIPアドレスを制限する場合は,次のようにホスト名またはIPアドレスを指定して制限できます。
--web.listen-address="ホスト名またはIPアドレス:20716"
○
ポートを変更したい場合,または,リッスンするIPアドレスを限定したい場合に指定します。
--web.listen-address=":20716"
--web.max-requests
同時に受け付けるスクレイプ要求の最大数を指定します。
△
−
--web.max-requests=40
--log.level=info
指定されたレベル以上のメッセージだけをログに出力します。
指定できるレベルは,debug,info,warn,errorのどれかです。
△
サポート窓口から値の変更を指示されたときに設定を変更します。
通常は変更不要です。
--log.level=debug
- (凡例)
-
〇:変更可 △:変更不可 −:該当なし
-
yet-another-cloudwatch-exporterコマンドのオプション
項目名
説明
変更可否
JP1/IM - Agentでユーザーが設定する内容
JP1/IM - Agentのデフォルト値
-cloudwatch-concurrency
Amazon CloudWatch APIへの最大同時リクエスト数を指定します。
○
最大同時リクエスト数
-cloudwatch-concurrency=5
-config.file
Yet another cloudwatch exporterの設定ファイルのパスを指定します。
○
−
-config.file="Agentパス/conf/jpc_ya_cloudwatch_exporter.yml"
-fips
FIPS準拠のAmazon Web Services(AWS)のAPIを使用する場合※に指定します。
- 注※
-
セキュリティ要件で,連邦情報処理規格(FIPS(Federal Information Processing Standard) 140-2)に準拠する必要がある場合などに指定してください。
○
有効にする場合は指定します。
指定しない(有効にしない)
-listen-address
待ち受けポートを指定します。リッスンするIPアドレスを限定したい場合は,ホスト名またはIPアドレスも記載します。ホスト名を指定する場合は255バイトまで指定できます。
このオプションに,ホスト名を指定する場合は,同じホスト上にあるYet another cloudwatch exporterのディスカバリ設定ファイル(jpc_file_sd_config_cloudwatch.yml)のtargetsに,このオプションと同じホスト名を設定し,Prometheus serverを再起動またはリロードする必要があります。
このオプションに,IPアドレスを指定する場合は,同じホスト上にあるYet another cloudwatch exporterのディスカバリ設定ファイル(jpc_file_sd_config_cloudwatch.yml)のtargetsに,このオプションと同じIPアドレスに解決されるホスト名を設定し,Prometheus serverを再起動またはリロードする必要があります。
<設定例>
すべてのIPアドレスに対する要求を受け付ける場合は,次のように設定します。
-listen-address=":20718"
受け付けるIPアドレスを制限する場合は,次のようにホスト名またはIPアドレスを指定して制限できます。
-listen-address="ホスト名またはIPアドレス:20718"
○
ポートを変更したい場合,または,リッスンするIPアドレスを限定したい場合に指定します。
-listen-address=":20718"
-metrics-per-query
1回のGetMetricsDataリクエストで作成されたメトリックの数を指定します。
○
通常は変更しません。
-metrics-per-query=500
-tag-concurrency
Resource Tagging APIへの最大同時リクエスト数を指定します。
○
通常は変更しません。
-tag-concurrency=5
- (凡例)
-
〇:変更可 −:該当なし