diff --git a/README.md b/README.md index 81c756b..ae38c09 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ sabatrapdのリリースアーカイブを使うと、プログラミング環 [リリースページ](https://github.com/yseto/sabatrapd/releases)から、インストール対象のアーキテクチャ(amd64またはarm64)に合ったtar.gz形式のアーカイブファイルをダウンロードします。 -適当なフォルダーを用意し、`tar`コマンドで展開してください。新規に`sabatrapd-dist`フォルダーを作り、ダウンロードフォルダーにあるファイルをそこに展開する例を以下に示します。 +適当なフォルダーを用意し、`tar`コマンドで展開してください。例として、新規に`sabatrapd-dist`フォルダーを作り、ダウンロードフォルダーにあるファイルをそこに展開する場合の操作を以下に示します。 ``` $ mkdir sabatrapd-dist @@ -66,7 +66,7 @@ snmp: ``` - 上記の設定では、IPv4アドレスで到達可能な範囲からのアクセスを受け付け(`0.0.0.0`)、ポート番号は9162(UDP)を使用、SNMPコミュニティは「public」としています。 -- SNMP Trapを送る機器上で送信先ポートを指定できないときには、sabatrapd側の監視ポート番号を標準ポートである「162」にします。 +- SNMP Trapを送る機器上で送信先ポートを指定できないときには、sabatrapd側の監視ポート番号を標準ポートである「162」にします。ただし、このポートで動作させるには管理者権限で実行する必要があります。 - SNMPコミュニティの名前はSNMP Trapを送る機器に合わせます。コミュニティの異なるSNMP Trapは無視されます。 - SNMPコミュニティ設定は1つのみ指定できます。複数のSNMPコミュニティで運用しなければならないときには、`community`行を削除して、コミュニティの名前照合をスキップするようにしてください。 @@ -82,7 +82,7 @@ snmp: ![チェック監視のアラート](./images/alert.png) -`debug`設定を`true`にすると、受け取ったSNMP Trapメッセージや詳細なログが出力されます。SNMP Trapメッセージをうまく処理できないときにご利用ください。 +`sabatrapd.yml`の`debug`設定を`true`にすると、受け取ったSNMP Trapメッセージや詳細なログが出力されます。SNMP Trapメッセージをうまく処理できないときにご利用ください。 sabatrapdはいくつかのオプションをとることができます。 @@ -93,7 +93,7 @@ sabatrapdはいくつかのオプションをとることができます。 Linuxのsystemd環境で自動起動させるためのファイルを用意しています。 -正常に稼働する`sabatrapd.yml`が用意できたら、インストーラーの`install.sh`を管理者権限で実行してください。 +正常に稼働する`sabatrapd.yml`を用意できたら、インストーラーの`install.sh`を管理者権限で実行してください。 ``` $ sudo ./install.sh @@ -104,7 +104,7 @@ To check sabatrapd's status, type 'journalctl -u sabatrapd' デフォルトでは`/usr/local/bin`フォルダーに`sabatrapd`実行ファイルが、`/usr/local/etc`フォルダーに設定ファイルが、systemd設定フォルダーに`sabatrapd.service`がコピーされます。 -実行ファイルと設定ファイルのインストール先フォルダーは環境変数`DESTBINDIR`および`DESTETCDIR`で指定し、`sudo -E ./install.sh`とすれば変更できます。 +実行ファイルと設定ファイルのインストール先フォルダーを変えたいときには、環境変数`DESTBINDIR`および`DESTETCDIR`でそれぞれフォルダーを指定してから、`sudo -E ./install.sh`としてください。 状態やログについては`journalctl -u sabatrapd`で確認できます。 @@ -161,13 +161,13 @@ trap: どのようなMIBオブジェクトが利用可能かは、各MIBファイルを参照してください。 -SNMP Trapを捕捉しすぎると、無用なアラートがMackerelで多発することになります。緊急性の高い最低限のもののみ設定するようにすることをお勧めします。 +SNMP Trapを捕捉しすぎると、無用なアラートがMackerelで多発することになります。緊急性の高い、最小限のもののみ設定するようにすることをお勧めします。 `samples`フォルダーには、例としてYAMAHA SWX2220およびSWX3220が発行するSNMP Trapの一覧を用意しています。捕捉したいものを`sabatrapd.yml`にコピーするとよいでしょう。 ### ネットワーク機器ごとの文字エンコーディング設定 -一部のネットワーク機器では、Shift JISエンコーディングの日本語メッセージを発行することがあります。Mackerelに投稿する際にはUTF-8エンコーディングでなければならないため、ネットワーク機器のIPアドレスを明示して変換対象とするようにします。 +一部のネットワーク機器では、Shift JISエンコーディングの日本語メッセージを発行することがあります。Mackerelに投稿する際にはUTF-8エンコーディングでなければならないため、ネットワーク機器のIPアドレスを明示して文字エンコーディング変換対象とするようにします。 たとえばIPアドレス「192.168.1.200」のネットワーク機器からのShift JISエンコーディングのメッセージを変換対象とするには、以下のように記載します。