Ubuntu16.04にNATSをインストールして構成する方法
序章
NATS は、オープンソースの高性能メッセージングシステムであり、「クラウドの中枢神経系」と呼ばれることがよくあります。 毎秒数百万のメッセージをルーティングできるため、マイクロサービスと IoT (モノのインターネット)デバイスの接続に最適です。
NATSは、PubSubメッセージングシステムです。 この種のシステムでは、1つ以上のパブリッシャーが特定の件名のメッセージをメッセージブローカーに送信し、メッセージブローカーはこれらのメッセージを任意のクライアントまたはサブスクライバーに配信します。 ]与えられた主題の。 パブリッシャーはサブスクライバーを知らないか、気にかけません。その逆も同様です。 このアーキテクチャでは、システムの他の部分に影響を与えることなくパブリッシャーとサブスクライバーを追加できるため、システムの拡張と新しい機能の追加が容易になります。 このタイプのシステムは、サーバーとデバイスの監視に最適です。 デバイスはメッセージを送信でき、それらのメッセージをサブスクライブして、電子メールまたはその他の手段で通知を送信できます。
このチュートリアルでは、公式のNATSサーバーであるgnatsd
をサービスとしてインストールし、安全な方法でアクセスできるようにします。 また、gnatsd
をメッセージブローカーとして使用して、サーバーの負荷が高くなりすぎたときに電子メールを送信する基本的なサーバー過負荷警告システムを作成します。
前提条件
このチュートリアルを完了するには、次のものが必要です。
- 新しいUbuntu16.04サーバー。
sudo
権限を持つ標準ユーザーアカウント。 Ubuntu 16.04でのサーバーの初期設定に従って、標準アカウントを設定できます。
ステップ1—NATSサーバーをダウンロードする
gnatsd
サーバーをダウンロードして、問題なくシステムで実行できることを確認することから始めましょう。
このチュートリアルの執筆時点では、最新の安定したgnatsd
リリースはバージョン0.9.4です。 NATSダウンロードページで新しいバージョンを確認し、新しいバージョンを使用する場合は、必要に応じて以下のコマンドを適用できます。
まず、root以外のアカウントでサーバーにログインします。
- ssh sammy@your_server_ip
次に、ユーザーのホームディレクトリにいることを確認します。
- cd
次に、wget
を使用して、gnatsd
をサーバーにダウンロードします。
- wget https://github.com/nats-io/gnatsd/releases/download/v0.9.4/gnatsd-v0.9.4-linux-amd64.zip
ダウンロードしたアーカイブは圧縮アーカイブであるため、ファイルを抽出するにはunzip
をインストールする必要があります。 apt
でインストールできます。
- sudo apt-get install -y unzip
次に、unzip
を使用してgnatsd
を抽出します。
- unzip -p gnatsd-v0.9.4-linux-amd64.zip gnatsd-v0.9.4-linux-amd64/gnatsd > gnatsd
次に、gnatsd
を実行可能にして、実行できるようにします。
- chmod +x gnatsd
gnatsd
を現在のディレクトリから実行して、実行できることをテストしてみましょう。 次のコマンドを使用して、gnatsd
を起動します。
- ./gnatsd --addr 127.0.0.1 --port 4222
表示される出力は、次の例のようになります。
Output[1851] 2016/09/23 05:20:02.247420 [INF] Starting nats-server version 0.9.4
[1851] 2016/09/23 05:20:02.248182 [INF] Listening for client connections on 127.0.0.1:4222
[1851] 2016/09/23 05:20:02.248626 [INF] Server is ready
デフォルトでは、gnatsd
は、すべてのインターフェイスに対応するアドレス0.0.0.0
のポート4222
でリッスンします。 --port
引数を使用すると、ポートを変更でき、--addr
を使用すると、リッスンするアドレスを変更できます。 gnatsd
を--addr 127.0.0.1
で実行したため、サーバー内でのみ使用可能であり、外部クライアントからはアクセスできません。 チュートリアルの後半で、gnatsd
を保護し、世界に公開します。
CTRL+C
を押して、gnatsd
をシャットダウンします。
物事が機能することがわかったので、より正式な方法で物事を設定しましょう。
ステップ2—ディレクトリ構造と構成ファイルを作成する
Linuxでは、サードパーティのサービス関連ソフトウェアが/srv
ディレクトリに保存されることがよくあります。 その規則に従い、NATS関連のファイルを/srv/nats
の下に保持します。 gnatsd
実行可能ファイルを/srv/nats/bin
に配置します。
まず、/srv/nats/bin
フォルダーを作成します。
- sudo mkdir -p /srv/nats/bin
次に、gnatsd
を/srv/nats/bin
フォルダーに移動します。
- sudo mv ~/gnatsd /srv/nats/bin
サーバーはファイルから構成をロードできます。これは、チュートリアルの後半でサーバー設定を変更する必要がある場合に役立ちます。 ファイル/srv/nats/gnatsd.config
を作成します。
- sudo nano /srv/nats/gnatsd.config
そして、次の内容をファイルに追加します。
port: 4222
net: '127.0.0.1'
この構成ファイルは、以前と同様に、gnatsd
サーバーにアドレス127.0.0.1
のポート4222
でリッスンするように指示しますが、今回はコマンドでこれらのオプションを指定する必要はありません。ライン。
サーバーを再度実行して、正しく構成されていることを確認しましょう。 次のコマンドを実行して、新しい構成ファイルを使用してgnatsd
を起動します。
- /srv/nats/bin/gnatsd -c /srv/nats/gnatsd.config
出力は、前に見たものと似ています。
Output[1869] 2016/06/18 05:30:55.988856 [INF] Starting nats-server version 0.9.4
[1869] 2016/06/18 05:30:55.989190 [INF] Listening for client connections on 127.0.0.1:4222
[1869] 2016/06/18 05:30:55.989562 [INF] Server is ready
もう一度、CTRL+C
を押してgnatsd
をシャットダウンし、プロンプトに戻ります。 次に、このサービスを実行するユーザーを作成しましょう。
ステップ3—サービスユーザーの作成
サービスが危険にさらされた場合の被害を制限するために、各サービスを独自のユーザーアカウントで実行することをお勧めします。 NATSサービスとNATS関連ファイルを所有するユーザーとグループを作成しましょう。
まず、nats
というシステムユーザーとグループを作成しましょう。
- sudo adduser --system --group --no-create-home --shell /bin/false nats
OutputAdding system user `nats' (UID 106) ...
Adding new group `nats' (GID 114) ...
Adding new user `nats' (UID 106) with group `nats' ...
Not creating home directory `/home/nats'.
/bin/false
シェルをnats
システムユーザーに割り当てて、このユーザーのログインを無効にし、ホームディレクトリの作成を抑制しました。 nats
グループも作成しました。
/srv
ディレクトリの所有者をnats
ユーザーとグループに変更しましょう。
- sudo chown -R nats:nats /srv
nats
ユーザーとグループを作成したので、NATSサービスの作成を続けましょう。
ステップ4—サービスとしてのgnatsdの実行
gnatsd
は、システムの起動時に起動し、クラッシュした場合は再起動します。 これを処理するには、systemdを使用します。
systemd は、Linuxシステムのサービスマネージャーです。 起動時にサービスを開始し、必要に応じてサービスを再起動し、システムのシャットダウン時に制御された方法でサービスを停止します。
NATSサービスをいつどのように開始するかを定義するには、サービス構成を作成する必要があります。 ユーザーが作成したサービスファイルは/etc/systemd/system
にあるため、ファイル/etc/systemd/system/nats.service
を作成します。
- sudo nano /etc/systemd/system/nats.service
そして、ファイルに次のスクリプトを配置して、gnatsd
の起動方法を定義します。
[Unit]
Description=NATS messaging server
[Service]
ExecStart=/srv/nats/bin/gnatsd -c /srv/nats/gnatsd.config
User=nats
Restart=on-failure
[Install]
WantedBy=multi-user.target
[Unit]
セクションには、サービスを説明するDescription
など、サービスに関する一般的な情報が含まれています。[Service]
セクションには、サービス関連の構成が含まれています。ExecStart
は、サーバーを実行するためのコマンドです。 ここでは、gnatsd
実行可能ファイルの絶対パスを使用します。Restart=on-failure
は、サービスがクラッシュしたり、失敗して終了したりした場合に、サービスを再起動する必要があることを意味します。 systemdによって停止された場合、再起動されません。[Install]
セクションには、サービスに関するインストール情報が含まれています。WantedBy=multi-user.target
は、multi-user.target
の開始時にサービスを開始するようにsystemdに指示します。 これは、システムの起動時にサービスを開始する一般的な方法です。
サービスの説明を配置したら、次のコマンドでサービスを開始できます。
- sudo systemctl start nats
PING
メッセージを送信して、gnatsd
が実行されていることを確認しましょう。
- printf "PING\r\n" | nc 127.0.0.1 4222
nc
を使用してgnatsd
と通信しました。 nc
は、TCPまたはUDPサーバーと通信するためのコマンドラインユーティリティです。 使用したコマンドは、次のような出力を出力します。
OutputINFO {"server_id":"Os7xI5uGlYFJfLlfo1vHox","version":"0.9.4","go":"go1.6.3","host":"127.0.0.1","port":4222,"auth_required":false,"ssl_required":false,"tls_required":false,"tls_verify":false,"max_payload":1048576}
PONG
応答PONG
は、サーバーが期待どおりにリッスンして動作していることを通知します。 NATSサーバーを起動時に起動するには、最後の1つのコマンドを実行する必要があります。
- sudo systemctl enable nats
サービスがインストールされたことを確認する次の出力が表示されます。
OutputCreated symlink from /etc/systemd/system/multi-user.target.wants/nats.service to /etc/systemd/system/nats.service.
gnatsd
をサービスとして実行するように正常に構成しました。 それでは、それを保護して、外部クライアントがアクセスできるようにしましょう。
ステップ5—NATSサービスへの接続を保護する
gnatsd
で使用したいすべてのパブリッシャーとサブスクライバーが同じサーバー上で実行されている場合、それを完了と呼んで先に進むことができますが、最近はめったにありません。 外部クライアントが安全な方法でgnatsd
に接続してメッセージを公開できるようにする必要があります。
gnatsd
はTLSトランスポートをサポートしているため、これを使用してgnatsd
とNATSクライアント間の通信を保護します。
まず、証明書が必要です。 商用証明書を購入するか、 Let’s Encrypt から証明書を取得するか、自己署名証明書を生成することができます。 証明書の取得はこの記事の範囲外であるため、後者のアプローチを使用します。
証明書を一時的に保持するディレクトリを作成します。
- mkdir ~/priv
次に、次のコマンドを使用して自己署名証明書を作成します。
- openssl req -x509 -nodes -days 3650 -newkey rsa:2048 \
- -keyout priv/gnatsd.key -out priv/gnatsd.crt \
- -subj "/C=US/ST=Texas/L=Austin/O=AwesomeThings/CN=www.example.com"
このコマンドは、2048ビットで有効期間が10年のRSA証明書を作成します。 この記事ではgnatsd
サーバーのTLS検証を有効にしないため、任意のドメイン名を使用していることに注意してください。
これで、ファイルgnatsd.key
とgnatsd.crt
が~/priv
ディレクトリにあるはずです。 これらのファイルを/srv/nats/
ディレクトリ構造の下に移動して、すべてが1か所にあるようにします。 次のコマンドを実行します。
- sudo mv ~/priv /srv/nats
ここで、/srv/nats/priv
にnats
ユーザーとグループのみがアクセスできるようにします。
- sudo chmod 440 /srv/nats/priv/*
- sudo chmod 550 /srv/nats/priv
- sudo chown -R nats:nats /srv/nats/priv
次に、/srv/nats/gnatsd.config
を更新して、作成したばかりの証明書とキーを含めます。 構成ファイルを再度開きます。
- sudo nano /srv/nats/gnatsd.config
そして、次のセクションを追加して、gnatsd
に証明書とキーを使用するように指示します。
. . .
tls {
cert_file: "/srv/nats/priv/gnatsd.crt"
key_file: "/srv/nats/priv/gnatsd.key"
timeout: 1
}
ファイルを保存して、エディターを終了します。 次に、サービスを再起動して、変更を取得できるようにします。
- sudo systemctl restart nats
証明書が機能することをテストしてみましょう。 次のコマンドを実行します。
- printf "PING\r\n" | nc localhost 4222
今回、コマンドは次のメッセージを出力します。
OutputINFO {"server_id":"npkIPrCE5Kp8O3v1EfV8dz","version":"0.9.4","go":"go1.6.3","host":"127.0.0.1","port":4222,"auth_required":false,"ssl_required":true,"tls_required":true,"tls_verify":false,"max_payload":1048576}
-ERR 'Secure Connection - TLS Required'
サーバーは、新しい構成が取得され、安全な接続が必要であることを確認するメッセージ-ERR 'Secure Connection - TLS Required'
を返しましたが、nc
はその方法を知りません。
本格的なNATSクライアントをインストールせずにNATSサービスと通信できるようにするために、catnatsというツールを使用します。 最初にダウンロードしましょう:
- wget https://github.com/yuce/catnats/raw/0.1.2/catnats.py
そしてそれを実行可能にします:
- chmod +x catnats.py
最後に、catnats.py
を/srv/nats/bin
フォルダーに移動し、名前をcatnats
に変更します。
- sudo mv catnats.py /srv/nats/bin/catnats
以前に送信したのと同じPING
メッセージを送信して、catnats
を使用してNATSサービスと通信できることを確認しましょう。
- printf "PING\r\n" | /srv/nats/bin/catnats --addr 127.0.0.1:4222
接続が安全であることを示す次の出力が表示されます。
OutputINFO {"server_id":"npkIPrCE5Kp8O3v1EfV8dz","version":"0.9.4","go":"go1.6.3","host":"127.0.0.1","port":4222,"auth_required":false,"ssl_required":true,"tls_required":true,"tls_verify":false,"max_payload":1048576}
PONG
通信を保護したので、認証を有効にして、NATSに接続するためにユーザー名とパスワードが必要になるようにします。
ステップ6—認証を要求する
NATSサービスは、デフォルトでは認証を必要としません。 これは、サービスがプライベートネットワークでのみアクセス可能である場合は問題ありませんが、インターネット上でNATSサービスにアクセスできるようにしたいので、認証を有効にする必要があります。 gnatsd
はユーザー名とパスワードの認証をサポートしており、簡単に有効にできます。
/srv/nats/gnatsd.config
ファイルを開きます。
- sudo nano /srv/nats/gnatsd.config
資格情報を指定する新しいauthorization
セクションを追加します。 このチュートリアルでは、ユーザー名としてuser1
を使用し、パスワードとしてpass1
を使用します。 実稼働環境では、より長く、より複雑なパスワードを使用する必要があります。
. . .
authorization {
user: user1
password: pass1
}
ファイルを保存してから、/srv/nats/gnatsd.config
の所有者をnats
に変更し、システム上の他のユーザーからユーザー名とパスワードを保護するために、そのユーザーが読み取れるようにします。
- sudo chown nats /srv/nats/gnatsd.config
- sudo chmod 400 /srv/nats/gnatsd.config
次に、サービスを再起動して変更を有効にします。
- sudo systemctl restart nats
PING
メッセージをgnatsd
に送信して、すべてが正常かどうかを確認しましょう。 もう一度、catnats
を使用してメッセージを送信します。
- printf "PING\r\n" | /srv/nats/bin/catnats --addr 127.0.0.1:4222
次の出力が表示されます。
OutputNFO {"server_id":"sY0SSJBNbEw53HxzS9mH1t","version":"0.9.4","go":"go1.6.3","host":"127.0.0.1","port":4222,"auth_required":true,"ssl_required":true,"tls_required":true,"tls_verify":false,"max_payload":1048576}
-ERR 'Authorization Violation'
これは、変更が正常に適用されたことを示しており、サービスに接続するために正しいユーザー名とパスワードを送信する必要があります。 今度はユーザー名user1
とパスワードpass1
を入力して、もう一度試してみましょう。
- printf "PING\r\n" | /srv/nats/bin/catnats --addr 127.0.0.1:4222 --user user1 --pass pass1
次の出力からわかるように、今回は機能しました。
OutputINFO {"server_id":"sY0SSJBNbEw53HxzS9mH1t","version":"0.9.4","go":"go1.6.3","host":"127.0.0.1","port":4222,"auth_required":true,"ssl_required":true,"tls_required":true,"tls_verify":false,"max_payload":1048576}
+OK
PONG
このサービスをユーザー名とパスワードを知っているクライアントに制限したので、外部のクライアントが接続できるようにサービスを再構成できます。
ステップ7—サービスを世界に開く
ローカルインターフェイスである127.0.0.1
でリッスンするようにNATSサーバーを構成しました。 0.0.0.0
でリッスンさせると、世界中で利用できるようになります。 最後にもう一度/srv/nats/gnatsd.config
を更新しましょう。
- sudo nano /srv/nats/gnatsd.config
次に、net
設定に関連付けられているIPアドレスを変更します。
. . .
net: '0.0.0.0'
. . .
ファイルを保存して、サービスを再起動します。
- sudo systemctl restart nats
これで、NATSサービスは外部クライアント接続の準備が整いました。 使用方法を学ぶために、NATSサーバーをメッセージブローカーとして使用する簡単な監視サービスを作成しましょう。
手順8—(オプション)サーバーの過負荷に関する通知の構成
このセクションでは、NATSサービスを利用する単純な過負荷監視システムを作成します。 システムはサーバーの平均負荷を受信し、いずれかのサーバーが過負荷の場合は管理者に電子メールを送信します。
サンプルプロジェクトは、次のコンポーネントで構成されます。
- 構成したばかりのNATSサービス。
- モニター。サーバーのホスト名、負荷平均、およびプロセッサー数を
stats.loadaverage
サブジェクトに60秒ごとに公開します。 このコンポーネントは、負荷を監視する任意のサーバーで実行する必要があります。 - notifier は、
stats.loadaverage
サブジェクトにサブスクライブし、サーバーのホスト名、負荷平均、およびプロセッサー数を受け取ります。 ホストの負荷平均が特定のしきい値を超えている場合、通知機能はSMTPサーバーを介して事前定義されたアドレスに電子メールを送信します。
簡単にするために、これらすべてのコンポーネントを同じサーバーで実行しますが、このチュートリアルを完了したら、各コンポーネントを別のサーバーで実行してみることができます。
モニターのセットアップ
Linuxシステムの平均負荷は/proc/loadavg
から読み取ることができます。 このプロジェクトでは、出力の最初のフィールドである直前の負荷平均のみに関心があります。 このコマンドを使用して、その値を取得します。
- cat /proc/loadavg | cut -f1 -d" "
次の出力が表示されます。
Output0.11
/proc/loadavg
を読み取ることで得られる負荷平均はプロセッサの数に依存するため、負荷平均をプロセッサの数で割って正規化する必要があります。 次のコマンドを使用して、サーバーのプロセッサ数を取得できます。
- getconf _NPROCESSORS_ONLN
ターミナルに結果が表示されます。
Output1
サーバーのデフォルトシェルは浮動小数点演算を処理できないため、負荷平均とプロセッサ数の両方を、メッセージのペイロードとしてホスト名と一緒に送信し、後で通知機能で除算します。 ペイロードを作成するために使用するコマンドは次のとおりです。
- echo $(hostname) `cat /proc/loadavg | cut -f1 -d" "` `getconf _NPROCESSORS_ONLN`
このコマンドは、ホスト名、負荷平均、およびプロセッサの数をそれぞれ表示します。
Outputyour_hostname 0.28 1
ホスト名、負荷平均、プロセッサ数を件名stats.loadaverage
でNATSサーバーに公開するシェルスクリプトを作成しましょう。 このスクリプトを定期的に実行するようにシステムを構成します。 ~/publish_load_average.sh
という名前の新しいファイルを作成します。
- nano ~/publish_load_average.sh
ファイルに、次のスクリプトを追加します。
NATS_ADDR=127.0.0.1:4222
LOADAVG=$(cat /proc/loadavg | cut -f1 -d" ")
NPROC=$(getconf _NPROCESSORS_ONLN)
SUBJECT="stats.loadaverage"
PAYLOAD=$(echo $(hostname) $LOADAVG $NPROC)
MESSAGE="PUB $SUBJECT ${#PAYLOAD}\r\n${PAYLOAD}\r\n"
printf "$MESSAGE" | /srv/nats/bin/catnats -q --raw --addr $NATS_ADDR --user user1 --pass pass1
このスクリプトはメッセージを作成し、それをcatnats
にパイプします。これにより、メッセージがNATSサービスに公開されます。 catnats
を-q
スイッチで実行して出力を抑制し、--raw
スイッチを使用して、catnats
が入力。 NATSサービスが異なるサーバー上にある場合は、$NATS_ADDR
変数の値を変更できます。
スクリプトが負荷平均をNATSに送信することをテストしてみましょう。
次のコマンドは、5秒ごとに~/publish_load_average.sh
を実行します。 行末で&
文字を使用して、コマンドをバックグラウンドで実行することに注意してください。
- while true; do sh ~/publish_load_average.sh; sleep 5; done &
コマンドがプロセスIDでバックグラウンドで実行されていることを示す出力が表示されます。
Output[1] 14123
注:後でコマンドを停止するためにIDを使用する必要があるため、プロセスIDをどこかに書き留めます。
次に、NATSに接続し、サブジェクトstats.loadaverage
にサブスクライブして、負荷平均を取得します。
- printf "SUB stats.loadaverage 0\r\n" | /srv/nats/bin/catnats --raw --no-exit --pong --user user1 --pass pass1
--no-exit
フラグを使用して自動終了を無効にし、--pong
を使用してNATSへの接続を維持します。 すべてが正しければ、5秒ごとに更新される次のような出力が得られるはずです。
OutputINFO {"server_id":"A8qJc7mdTy8AWBRhPWACzW","version":"0.8.1","go":"go1.6.2","host":"0.0.0.0","port":4222,"auth_required":true,"ssl_required":true,"tls_required":true,"tls_verify":false,"max_payload":1048576}
+OK
+OK
MSG stats.loadaverage 0 27
your_hostname 0.08 1
CTRL+C
を押して、catnats
を終了します。 publish_load_average.sh
を実行するためのより良い方法があるので、publish_load_average.sh
を呼び出したループも停止しましょう。
- kill 14123
私たちが採用したアプローチはテストには最適ですが、永続的に使用したいものではありません。 システムでpublish_load_average.sh
を毎分実行するようにします。 これを実現するために、crontabエントリを追加できます。 Linuxシステムは、cron
を使用します。これは、指定したスケジュールでコマンドまたは「ジョブ」を実行できるシステムです。 crontab
コマンドを使用すると、これらのジョブを管理できます。 チュートリアルCronを使用してVPSでタスクを自動化する方法でCronのすべてを学ぶことができます。
新しいエントリを作成するには、次のコマンドを実行します。
- crontab -e
上記のコマンドを実行したことがない場合は、エントリを管理するためのテキストエディタを選択するように求める次のプロンプトが表示される場合があります。
Outputno crontab for demo - using an empty one
Select an editor. To change later, run 'select-editor'.
1. /bin/ed
2. /bin/nano <---- easiest
3. /usr/bin/vim.basic
4. /usr/bin/vim.tiny
Choose 1-4 [2]:
最も使いやすいエディタに対応する番号を入力し、ENTER
を押します。 選択したエディターにファイルが表示されます。
開いたファイルの最後に次の行を追加しますが、sammy
以外のものを使用した場合は、ユーザー名に置き換えてください。
*/1 * * * * bash /home/sammy/publish_load_average.sh
上記のエントリは、cron
にpublish_load_average.sh
スクリプトを毎分実行するように指示しています。 ファイルを保存して、エディターを閉じます。
次に、負荷平均の定期的な公開が機能していることをテストしましょう。
- printf "SUB stats.loadaverage 0\r\n" | /srv/nats/bin/catnats --raw --no-exit --pong --user user1 --pass pass1
数分待つと、表示される出力は次のようになります。
OutputINFO {"server_id":"A8qJc7mdTy8AWBRhPWACzW","version":"0.8.1","go":"go1.6.2","host":"0.0.0.0","port":4222,"auth_required":true,"ssl_required":true,"tls_required":true,"tls_verify":false,"max_payload":1048576}
+OK
+OK
MSG stats.loadaverage 0 27
your_hostname 0.01 1
MSG stats.loadaverage 0 27
your_hostname 0.00 1
CTRL+C
を押して、catnats
を終了します。
モニターのセットアップに成功し、NATSサーバーにメッセージを送信しています。 次に、このデータを利用する通知機能を設定します。
通知機能の作成
NATSサービスに接続し、stats.loadaverage
メッセージをリッスンする通知機能を作成しましょう。 プログラムがメッセージを受信するたびに、プロセッサごとの平均負荷が計算されます。 0.6、つまりプロセッサあたりのCPU使用率が60%を超える場合は、メッセージを公開したホストに警告フラグを設定し、事前定義されたアドレスに電子メールを送信します。 プロセッサあたりの平均負荷が0.4未満の場合、ホストの警告フラグはクリアされます。 受信トレイのフラッディングを防ぐために、警告フラグが設定されている場合は1通のメールを送信します。
Node.js用の優れたNATSクライアントがあるため、Node.JSを使用して通知機能を作成します。 したがって、最初にNode.jsをインストールします。
- sudo apt-get install -y npm
次に、通知機能のディレクトリを作成し、それに切り替えます。
- mkdir ~/overload_notifier && cd ~/overload_notifier
Node.jsプロジェクトは、プロジェクトとその依存関係に関する情報を含むpackage.json
というファイルを使用します。 次のコマンドを実行して、そのファイルを作成します。
- npm init -y
次に、Node.js用のNATSクライアントと、このプロジェクトで警告メールを送信するために使用するnodemailer
モジュールをインストールします。
- npm install [email protected] [email protected] --save-exact
これで、通知機能を作成できます。 ファイルnotifier.js
を作成します。
- nano notifier.js
次に、次のコードをファイルに追加します。
var NATS_URL = 'nats://127.0.0.1:4222';
var NATS_USER = 'user1';
var NATS_PASS = 'pass1';
var EMAIL_TO = '[email protected]';
これらのオプションは、NATSサービスのユーザー名とパスワード、および電子メールアドレスと一致するように変更してください。
次に、次のコードを追加してNode.js NATSクライアントをインポートし、gnatsd
サービスに接続します。
var tlsOptions = {
rejectUnauthorized: false,
};
var nats = require('nats').connect({url: NATS_URL,
tls: tlsOptions,
user: NATS_USER,
pass: NATS_PASS});
次に、このコードを追加してメーラーを設定し、電子メールを送信するSMTPサーバーに接続します。 このサーバーはまもなくセットアップされます。
var nodemailer = require('nodemailer');
var transport = nodemailer.createTransport('smtp://localhost:2525');
次に、残りのコードを追加して負荷平均を計算し、通知メールを送信する必要があるかどうかを判断します。
// keep the state of warnings for each host
var warnings = {};
function sendEmail(subject, text) {
transport.sendMail({
to: EMAIL_TO,
subject: subject,
text: text
});
}
function processMessage(message) {
// message fields: host load processor_count
var fields = message.split(" ");
var host = fields[0];
var loadAverage = parseFloat(fields[1]) / parseInt(fields[2]);
if (loadAverage > 0.6) {
if (!warnings[host]) {
// send warning email if one wasn't already sent
var res = sendEmail('Warning! Server is Overloaded: ' + host,
'Load average: ' + loadAverage);
// set warning for the host
warnings[host] = true;
}
}
else if (loadAverage < 0.4) {
if (warnings[host]) {
// clear the warning
warnings[host] = false;
}
}
}
nats.subscribe('stats.loadaverage', processMessage);
メッセージをサブスクライブし、メッセージを受信するたびにprocessMessage
関数を実行します。この関数は、送信したペイロードを解析し、負荷の平均を決定します。 高すぎる場合は、メッセージを送信し、ホスト名に基づいてフラグを設定することにより、以前にメッセージを送信したかどうかを追跡します。 このようにして、ホストごとに通知を追跡できます。 負荷平均がしきい値を下回っている場合は、そのフラグをクリアします。
モニターと通知機能を配置したら、サンプルプロジェクトをテストします。
プロジェクトのテスト
これを試乗してみましょう。 人工的な負荷を生成し、負荷が高くなりすぎたときに通知メールが警告メールを送信するかどうかを確認します。
stress
ツールをインストールして、サーバーにCPU負荷を生成しましょう。
- sudo apt-get install -y stress
次に、通知機能からメッセージをメールで送信するようにSMTPサーバーを設定する必要があります。 本格的なSMTPサーバーのインストールと構成は、このテストではやり過ぎになるため、実際に送信するのではなく、渡された電子メールを表示するだけの単純なSMTPサーバーを使用します。 Pythonプログラミング言語にはDebuggingServer
モジュールがあり、受信した電子メールを破棄しますが、画面に表示するので、確実に機能します。 PythonはすでにUbuntuサーバーにインストールされているため、これは完璧なソリューションです。
SMTPサーバーのデバッグをバックグラウンドで開始しましょう。 localhost
ポート2525
でリッスンします。これは、notifier.js
コードで構成したSMTPアドレスと一致します。 次のコマンドを実行して、SMTPサーバーを起動します。
- python -m smtpd -n -c DebuggingServer localhost:2525 &
次に、次のコマンドを使用して、バックグラウンドで通知機能を開始します。
- nodejs ~/overload_notifier/notifier.js &
最後に、サーバーのすべてのプロセッサに負荷をかけましょう。 次のオプションを指定して、stress
コマンドを実行します。
- stress --cpu $(getconf _NPROCESSORS_ONLN)
数分後、SMTPサーバーが通知機能によって送信されたメッセージの表示を開始すると、次のような出力が表示されます。
Output---------- MESSAGE FOLLOWS ----------
Content-Type: text/plain
To: [email protected]
Subject: Warning! Server is Overloaded: your_hostname
Message-Id: <1466354822129-04c5d944-0d19670b-780eee12@localhost>
X-Mailer: nodemailer (2.4.2; +http://nodemailer.com/;
SMTP/2.5.0[client:2.5.0])
Content-Transfer-Encoding: 7bit
Date: Sun, 19 Jun 2016 16:47:02 +0000
MIME-Version: 1.0
X-Peer: 127.0.0.1
Load average: 0.88
------------ END MESSAGE ------------
これにより、サーバーの負荷が高くなりすぎたときにメールを正常に送信したことがわかります。
CTRL+C
を押して、負荷の生成を停止します。 これでサンプルプロジェクトが完了し、自分の環境でこれを機能させる方法がわかったはずです。
結論
この記事では、NATS PubSubメッセージングシステムについて学び、サービスとして安全な方法でインストールし、サンプルプロジェクトでテストしました。 サンプルプロジェクトではNode.JSクライアントを使用しましたが、NATSには、NATSダウンロードページにリストされているより多くの言語とフレームワークのクライアントがあります。 NATSの詳細については、公式ドキュメントをご覧ください。