boltz コマンドマニュアル

boltzコマンドは、プッシュ通知配信サーバと管理ツールを提供します。

 1boltz master [-license file] [-addr address] [-a address] [-slave slaveaddrs] [-log xx]
 2
 3boltz slave [-addr address] [-n maxagents] [-log xx]
 4
 5boltz auth-server [-a address]
 6
 7boltz status [-addr address]
 8
 9boltz config [-addr address] command...
10
11boltz halt [-addr address]
12
13boltz version

masterサブコマンド

boltz masterはBoltzEngineの配信マネージャサーバを起動します。 masterは自分自身でAPNs/GCM/FCM/WebPushへ接続しません。 かわりに、slaveサーバを1つ以上使って、分散させてAPNs/FCM/WebPush/ADMへPush依頼を行います。 masterから接続するslaveは -slave オプションで指定します(デフォルトはlocalhost)。 複数のslaveを使う場合、slaveのアドレスをカンマ区切りで指定します。

masterは-addrオプションで指定されたアドレスで、具体的な配信リクエストを待ち受けます。(デフォルトはTCP/13010)

バージョン2.2より、masterサブコマンドはgRPCに対応しました。 デフォルトでは、これまでのnet/rpcを -addr オプションのポートで待ち受け、 -a オプションのポートを使ってgRPCリクエストを待ち受けます。(デフォルトはTCP/13009)

製品版と制限版

製品版を契約頂いた際に、プロダクトキーをお渡ししています。 masterの -license オプションで、プロダクトキーを保存したファイルへのパスを与えると、 製品版として制限なく動作するようになります。 -license なし、または無効なファイルの場合は機能制限版として動作します。

制限版の制限は以下の通りです。

• 複数サーバーを使った分散構成ができません
• CPU稼働状況に制限が入ります
• 1秒あたりの配信数を10端末までに制限します

slaveサブコマンド

boltz slaveはmasterからのメッセージリクエストを待ち、 具体的にAPNs/GCM/FCM/WebPushへメッセージを送信します。 ひとつのリクエストに複数のメッセージを含めます。 masterからのメッセージは -addr で指定したaddressで待ち受けます。

slaveはmasterからのリクエストを並行して処理します。 並行する最大リクエスト数は、-n オプションで指定します(デフォルトは30)。 もし最大リクエスト数を超えた場合、超えた部分は待ち状態になり、 先行して処理していたリクエストが完了し次第、待ち状態のリクエストを実行に移します。 このとき、一定時間以上、待ち状態になったリクエストはタイムアウトになります。

statusサブコマンド

boltz statusは -addr オプションでmasterが待ち受けるアドレスを指定し、 masterと、それが管理しているslaveの状態を取得します。

config

boltz configは -addr オプションでmasterが待ち受けるアドレスを指定し、 対象となるmasterの設定を変更します。command は以下が使えます。

• debugon: 標準エラー出力へのデバッグ出力を有効にします
• debugoff: デバッグ出力を無効にします

halt

boltz haltは -addr オプションでmasterが待ち受けるアドレスを指定し、 対象のmasterをシャットダウン状態へ遷移させます。 このコマンドは、別のリクエストが実行中であれば終わるまで待ちます。 そのため、コマンドを抜けた時点で何もリクエストを処理していないことを保証します。

シャットダウン状態で新たにリクエストが届いた場合は、 masterはシャットダウン中を示すエラーを返します。

実行例

以下の例では、slaveを2つ起動し、masterから2つのslaveを利用するように実行しています。

1$ boltz slave -addr localhost:13007 -n 30 &
2$ boltz slave -addr localhost:13008 -n 30 &
3$ boltz master -addr localhost:13010 -slave localhost:13007,localhost:13008 &
4$ sleep 1 # masterの起動を待つ
5$ boltz status -addr localhost:13010

ログ

boltz masterとboltz slaveはどちらも、-logオプションでログの出力先を変更できます。標準エラー出力、テキストファイル、syslogに対応しています。

テキストファイルに書き込む場合

1$ boltz master -log 'file:///var/log/boltz-master.log'

ローカルのsyslogにunixソケットで送る場合

1$ boltz master -log 'net:///?facility=(facility)&tag=(tag)'

TCPで送る場合

1$ boltz slave -log 'tcp://localhost:<port>/?facility=(facility)&tag=(tag)'

facilityの種類

tag

-log オプションのURLに含まれるタグはどのような文字列であっても構いません。