コンテンツにスキップ

SPO Block Notify設定

お知らせ

ブロック生成ステータス通知が「SPO Block Notify」に生まれ変わりました！

概要

最終更新日：2024/7/16 v2.3.0

  • ブロックログで表示されるブロック生成結果を任意のソーシャルアプリへ通知します。
    *

  • ブロック生成スケジュールを自動取得し、取得スケジュール一覧を通知します。
    *

  • 通知先対応アプリ LINE/Slack/discord/telegram

  • 多言語ファイルを用意することで様々な言語に対応しました！

  • ブロックログと連動しておりますので、まだ設定されてない場合はブロックログ導入手順を先に導入してください。

  • 以下の作業はguild-dbが存在するBPサーバーのみで実施し、ブロック生成スケジュールがないタイミングで実施してください。

  • 設定は任意です。(設定しなくてもブロック生成に影響はありません)

更新履歴▼
  • 2.3.0 ・通知にブロックサイズを表示 　　　　　・スペイン語、フランス語、ポルトガル語を追加
  • 2.2.2 ・任意のPrometheusポートを設定可能 　　　　　・データベース接続の最適化
  • 2.2.1 ・特定の条件下における無限ループバグを解消
  • 2.2.0 ・サービス再起動時の強制終了バグを解消 　　　　　・プログラム最適化 　　　　　・Python3.10以上
  • 2.1.3　・次スケジュールが無い場合のエラー解消
  • 2.1.2　・次エポックスケジュール日付の通知有無対応
  • 2.1.1　・ブロックログサービスファイル対応
  • 2.0.0　・多言語対応
  • 1.9.5　・LINE通知不具合修正
  • 1.9.4　・スケジュール取得スロットを303300～317700間でランダム化
  • 1.9.0　・ノード再起動時のエラー修正

  • 1.8.9　・エポック境界の通知内容不具合修正
    　　　・通知内容フォーマット変更

  • 1.8.8 ・ステータス通知サービス起動時に通知
    　　　・通知先トークン未入力の場合にサービス画面でエラー排出

  • 1.8.7 ノード再起動後、通知されない不具合を修正
  • 1.8.6 スケジュール取得自動化導入(選択式)
    　　　・取得スケジュール一覧通知
  • 1.7 スケジュール取得タイミング通知
    　　　・生成ブロックのPooltoolリンク追加
  • 1.6 ブロック未生成プールで使用する場合の起動時エラーを修正
  • 1.5 10分以内に複数のスケジュールがある場合の通知バグ修正
  • 1.4 次のスケジュールを表示
  • 1.3 ノード再起動時の不具合を修正
  • 1.2.3 エポック取得フロー修正
  • 1.2.2 通知バグ修正
  • 1.2 ・Telegram、Slackに対応
    　　　・通知基準設定( 全て/confirm以外全て/Missedとivaildのみ)
    　　　・通知内容を変更(X番目/トータルスケジュール数)
  • 1.1 スケジュール取得時、その他通知判定修正
  • 1.0.1 軽微な修正
  • 1.0 初版リリース

11-1. 依存プログラムをインストールする

Python環境をセットアップする

パッケージを更新する 

sudo apt update && sudo apt upgrade -y

pythonバージョンを確認する 

python3 -V

Python 3.10以上

Python 3.9以下の場合こちらのツールでアップデートしてください

pythonUpdate.shをダウンロードして自動アップデートする 

cd
wget https://raw.githubusercontent.com/btbf/spojapanguild/master/scripts/pythonUpdate.sh
chmod +x pythonUpdate.sh
./pythonUpdate.sh

依存関係をインストールする 

sudo apt install -y build-essential libssl-dev libffi-dev python3-dev python3-pip python3-testresources

pip3 install watchdog pytz python-dateutil requests discordwebhook slackweb i18nice

実行スクリプトと設定ファイルをダウンロードする

bn_release="$(curl -s https://api.github.com/repos/btbf/block-notify/releases/latest | jq -r '.tag_name')"
wget https://github.com/btbf/block-notify/archive/refs/tags/${bn_release}.tar.gz -P $NODE_HOME/scripts
cd $NODE_HOME/scripts
tar zxvf ${bn_release}.tar.gz block-notify-${bn_release}/block_notify.py block-notify-${bn_release}/config.ini block-notify-${bn_release}/i18n/ 
mv block-notify-${bn_release} block-notify
rm ${bn_release}.tar.gz

11-2. 通知アプリの設定

通知させたいアプリのタブをクリックし設定を確認してください。

  • 1.LINEグループを作成する
    *

  • 2.「Line Notify」を追加する
    *

  • 3.任意のグループ名を設定し「作成」をクリックする *

  • 4.LINE Notifyマイページにアクセスする

  • 5.トークンを発行するをクリックします
    *

  • 6.トークン名「ブロック生成通知」(任意)を入力し、3で作成したグループ名を選択する
    *

  • 7.「発行する」をクリックする

  • 8.表示されたトークンをコピーし、一旦メモ帳などに貼り付ける
    （発行されたトークンを閉じると2度と確認できませんのでご注意ください）
    *

  • 1.サーバーを追加する
    *

  • 2.「オリジナルの作成」を選択する
    *

  • 3.「自分と友達のため」を選択する
    *

  • 4.任意のサーバー名を入力して「新規作成」をクリックする
    *

  • 5.通知したいチャンネルの歯車マークをクリックする
    *

  • 6.「連携サービス」をクリックし、「ウェブフックを作成」をクリックする
    *

  • 7.「ウェブフックURLをコピー」をクリックし、一旦メモ帳などに貼り付ける
    *

  • 1.Telegramの検索欄で「@botFather」を検索して認証マーク付きのアカウントをクリックする
    *

  • 2.「START」をクリックする
    *

  • 3.「/newbot」コマンドを入力する
    *

  • 4.任意のbot名を入力する 例）「btbf_bot」最後は必ず_botで終わるようにする
    *

  • 5.緑で隠した部分のAPIトークンをメモ帳に控える
    *

  • 6.赤枠で囲ったbotチャンネルに参加する
    *

  • 7.検索欄で「@RawDataBot」を検索してクリックする
    *

  • 8.「START」をクリックする
    *

  • 9.「Chat id」をメモ帳に控える
    *

  • 1.Slackを起動し、通知用のワークスペースとチャンネルを設定する

  • 2.Incoming Webhookの設定ページへアクセスする

  • 3.通知したいワークスペースとチャンネルを選択する
    *

  • 4.「Webhook URL」をメモ帳に控える
    *

  • 5.ページ下部の「設定を保存する」をクリックする
    *

11-3. 通知プログラムの設定

設定ファイルをSJG用に書き換える 

cd block-notify
sed -i config.ini \
    -e 's!/opt/cardano/cnode!'${NODE_HOME}'!' \
    -e 's!files/!'${NODE_CONFIG}-'!' \
    -e 's!notify_language = en!notify_language = ja!' \
    -e 's!Etc/UTC!Asia/Tokyo!'

設定ファイルの編集
以下の設定ファイル内容詳細を参照し、ご自身の環境に合わせた値を設定してください。

cd $NODE_HOME/scripts/block-notify
nano config.ini

設定ファイル内容詳細

項目 値 使用用途
pool_ticker ex.) SJG プールティッカー名を入力する
notify_language 英語:en
日本語:ja		 通知言語を入力する
notify_timezone Asia/Tokyo
タイムゾーン一覧		 お住いのタイムゾーンを指定する
notify_platform Line
Discord
Slack
Telegram		 通知先プラットフォームを指定する
(複数指定は無効)
notify_level 全て:All
Confirm以外:ExceptCofirm
Missのみ:OnlyMissed		 通知基準を設定する
nextepoch_leader_date 概要のみ:SummaryOnly
概要と日付:SummaryDate		 次エポックスケジュール日時の通知有無
次エポックスケジュール日付一覧を通知に流したくない場合はSummaryOnlyを記載してください
line_notify_token LINE設定の(8)で発行したトークンID Line Notifyトークンを入力する
discord_webhook_url Discord設定の(7)で発行したウェブフックURL DiscordウェブフックURLを入力する
slack_webhook_url Slack設定の(4)で発行したWebhook URL SlackウェブフックURLを入力する
telegram_token Telegram設定の(5)で発行したAPIトークン Telegram APIトークンを入力する
telegram_id Telegram設定の(9)で表示されたChat id Telegram ChatIDを入力する
node_home ex.)/home/usr/cnode node_homeディレクトリパスを入力する
guild_db_dir ex.)%(node_home)s/guild-db/blocklog/ guild-dbのパスを入力する
%(node_home)sは変数のため変更しないでください
shelley_genesis ex.)%(node_home)s/files/shelley-genesis.json shelley_genesisのファイルパスを入力する
%(node_home)sは変数のため変更しないでください
byron_genesis ex.)%(node_home)s/files/byron-genesis.json byron_genesisのファイルパスを入力する
%(node_home)sは変数のため変更しないでください

サービスファイルを設定する

このボックスはすべてコピーして実行してください
cat > $NODE_HOME/service/cnode-blocknotify.service << EOF 
# file: /etc/systemd/system/cnode-blocknotify.service

[Unit]
Description=Cardano Node - SPO Blocknotify
BindsTo=cnode-cncli-sync.service
After=cnode-cncli-sync.service

[Service]
Type=simple
User=$(whoami)
WorkingDirectory=${NODE_HOME}/scripts/block-notify
ExecStart=/bin/bash -c 'cd ${NODE_HOME}/scripts/block-notify/ && python3 -u block_notify.py'
Restart=on-failure
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=cnode-blocknotify

[Install]
WantedBy=cnode-cncli-sync.service
EOF

sudo cp $NODE_HOME/service/cnode-blocknotify.service /etc/systemd/system/cnode-blocknotify.service

Ubuntu22.04の場合は１行づつ実行してください
sudo chmod 644 /etc/systemd/system/cnode-blocknotify.service
sudo systemctl daemon-reload
sudo systemctl enable cnode-blocknotify.service
SPO BlockNotifyを起動する 
sudo systemctl start cnode-blocknotify.service

環境変数にログ確認用エイリアスを追加する 

echo alias blocknotify='"journalctl --no-hostname -u cnode-blocknotify -f"' >> $HOME/.bashrc
環境変数再読み込み 
source $HOME/.bashrc

起動確認 

blocknotify
以下の表示なら正常です。

[xxx] ブロック生成ステータス通知を起動しました

新規セットアップは以上です。

11-4.アップデート手順

旧バージョンからのアップデート(移行)について

旧ブロック生成通知またはSPO Block Notify2.1.3からアップデートする場合は、移行マニュアルをご参照ください

SPO BlockNotifyを停止する 

sudo systemctl stop cnode-blocknotify.service

アップデートファイルをダウンロードする 

bn_release="$(curl -s https://api.github.com/repos/btbf/block-notify/releases/latest | jq -r '.tag_name')"
wget https://github.com/btbf/block-notify/archive/refs/tags/${bn_release}.tar.gz -P $NODE_HOME/scripts
cd $NODE_HOME/scripts
tar zxvf ${bn_release}.tar.gz block-notify-${bn_release}/block_notify.py block-notify-${bn_release}/i18n
cp block-notify-${bn_release}/block_notify.py block-notify/block_notify.py
cp -r block-notify-${bn_release}/i18n block-notify/
rm -rf block-notify-${bn_release} ${bn_release}.tar.gz

v2.2.0またはv2.2.1からのアップデートの場合はこちらも実施 
cd $NODE_HOME/scripts/block-notify/
sed -i '9a prometheus_port = 12798' config.ini

SPO BlockNotifyを起動する 

sudo systemctl start cnode-blocknotify.service

バージョン確認 

python3 $NODE_HOME/scripts/block-notify/block_notify.py version

11-5.アンインストール手順

sudo systemctl stop cnode-blocknotify.service

sudo systemctl disable cnode-blocknotify.service
sudo rm /etc/systemd/system/cnode-blocknotify.service