スポンサーリンク

2016年3月8日

Using OTP with Elixir (Part2)

とある錬金術師の万能薬(Elixir)

Goal

  • ElixirからOTPを利用したサンプルを作成する
  • OTPを利用したシステムの基本的なアーキテクチャを習得する
  • OTPを使うとはどういうことなのか疑問を解消する

Dev-Environment

  • OS: Windows8.1
  • Erlang: Eshell V7.2.1, OTP-Version 18.1
  • Elixir: v1.2.0

Using OTP with Elixir (Part2)

  • 汎用イベントハンドラで使われる考え方
  • エラーロガーの仕組み (いまここ！)
  • アラーム管理
  • アプリケーションサーバの構築
  • 監視ツリーの作成とサーバの追加(Supervisor)
  • アプリケーションのパッケージ化(これはやるか分からない…)
前回はイベントハンドラについてやりました。
今日からは、エラーロガーについてやります。
OTPシステムには、カスタマイズ可能なエラーロガーがあるそうな。
んで、これには3つの視点があります。
  • プログラマの視点: エラーログを取るためにコードに追加する関数呼び出しが問題になる
  • 構成面での視点: エラーロガーがデータをどこにどのように格納するのかが問題になる
  • レポート面での視点: エラー発生後の解析が問題になる
それぞれを順番にやっていく。

プログラマの視点

まず、プログラマの視点から。
さっそく、Loggerを使ってエラーログを取ってみる。
LoggerはElixirでerror_loggerをラップしたものになります。
(ドキュメントに書いてあります)
参考: Elixir v1.2.3 - Logger

Example:

## Loggerからエラーメッセージを送ってみる
iex> require Logger
nil
iex> Logger.error "An error has occurred\n"
:ok

21:25:30.633 [error] An error has occurred

## error_loggerを使い、エラーメッセージをエラーロガーへ送ってみる
iex> :error_logger.error_msg("An error has occurred\n")
:ok
iex>
21:22:55.497 [error] An error has occurred

iex> :error_logger.error_msg("~s, an error has occurred\n", ["darui"])
:ok
iex>
21:37:14.947 [error] darui, an error has occurred

iex> :error_logger.error_report([{:tag1, :data1}, :a_term, {:tag2, :data2}])
:ok
iex>
21:35:38.495 [error] [{:tag1, :data1}, :a_term, {:tag2, :data2}]
一応、error_loggerも使って出力してみました。
(error_reportに相当するものが分からなかった…orz)

構成面での視点とレポートの視点

Erlangのデフォルトの設定だと全てのエラーがErlangシェルに表示される。
シェルに出力されるエラーを整形して1つのファイルに書き込むこともできる。
ついでに、循環ログも作れるそうです。
(循環ログ…ちょっと作りたい…どうせ車輪の再開発になるのでしょうが(笑))
SASL(= System Architecture Support Libraries)を使うようにコンフィグに設定を書きます。
(このオプションはデフォルトではfalseです)

File: config/config.exs

use Mix.Config

config :logger,
  handle_sasl_reports: true
最初に書いておきます…実行するとめっちゃ出力されます。

Example:

>iex --erl "-boot start_sasl" -S mix

=PROGRESS REPORT==== 8-Mar-2016::22:19:26 ===
          supervisor: {local,sasl_safe_sup}
             started: [{pid,<0.34.0>},
                       {id,alarm_handler},
                       {mfargs,{alarm_handler,start_link,[]}},
                       {restart_type,permanent},
                       {shutdown,2000},
                       {child_type,worker}]

...大量にあるので削除(見たい人は実行してみよう！)

22:19:27.148 [info]  Application otp_system_sample started at :nonode@nohost
Interactive Elixir (1.2.0) - press Ctrl+C to exit (type h() ENTER for help)
iex> require Logger
nil
iex> Logger.error("This is an error")
:ok

22:19:47.189 [error] This is an error
まずは、付けたオプション何って話ですね。
Erlangには、実稼働システムを動作させるのに適した環境を作るというオプションがある。
これを付けるとエラーログや過負荷保護など面倒なところをSASLが見てくれるようになる。
erl -boot start_sasl
参考までに…逆に、簡単な形のエラーログしか提供しないようにするプログラム環境に適した環境を作ることもできる。
erl -boot start_clean
今度は、SASLをなしで起動しましょう。
(出力は変わらないのですが…)

File: config/config.exs

use Mix.Config

config :logger,
  handle_sasl_reports: false

Example:

>iex --erl "-boot start_sasl" -S mix

=PROGRESS REPORT==== 8-Mar-2016::22:26:23 ===
          supervisor: {local,sasl_safe_sup}
             started: [{pid,<0.34.0>},
                       {id,alarm_handler},
                       {mfargs,{alarm_handler,start_link,[]}},
                       {restart_type,permanent},
                       {shutdown,2000},
                       {child_type,worker}]

...

=PROGRESS REPORT==== 8-Mar-2016::22:26:24 ===
         application: otp_system_sample
          started_at: nonode@nohost
Interactive Elixir (1.2.0) - press Ctrl+C to exit (type h() ENTER for help)
iex> require Logger
nil
iex> Logger.error("This is an error")
:ok

22:26:29.025 [error] This is an error
出力が変わらないけど、何が変わったのか？
エラーレポートだけ出力されるようになっただけです。
(進捗レポートなどが出力されなくなったとも言います)
とっても、いまいち実感が分かりませんが…
現状、深い所まで分かってないのでとりあえず進みます。
ファイルへログの出力をしたいのですが、Loggerだけだと出力方法が分からないので、
error_loggerを使っていきます。(ライブラリ使えばいけるんですが…)

File: elog.config

[{sasl, [
  {sasl_error_logger, {file, "./log/error.log"}}
]}].
logディレクトリとerror.logファイルは作成してください。

Example:

>iex --erl "-boot start_sasl -config elog" -S mix
log/error.logを開いて確認してみましょう。
最初の方だけですが、こんな感じに出力されていれば大丈夫。
=PROGRESS REPORT==== 8-Mar-2016::23:23:07 ===
          supervisor: {local,sasl_safe_sup}
             started: [{pid,<0.35.0>},
                       {id,alarm_handler},
                       {mfargs,{alarm_handler,start_link,[]}},
                       {restart_type,permanent},
                       {shutdown,2000},
                       {child_type,worker}]

...
コンフィグを設定して、循環ログを作ってみる。

File: elog.config

[{sasl, [
  {sasl_error_logger, false},
  {error_logger_mf_dir, "./log/error_logs"},
  {error_logger_mf_maxbytes, 10485760},
  {error_logger_mf_maxfiles, 10}
]}].
error_logger_mf_dir: 出力先ディレクトリ
error_logger_mf_maxbytes: ログファイル1あたりのバイト数(今回は10MB)
error_logger_mf_maxfiles: ログファイルの最大数

Example:

>iex --erl "-boot start_sasl -config elog" -S mix

iex> :error_logger.error_msg("This is an error\n")
:ok
iex>
23:30:04.800 [error] This is an error
ディレクトリを確認に行くと、1とindexと言うファイルができている。(取り出し方は後ほど…)
正直、こうやってやるならErlang使えよ…と言うのは言ってはいけない(笑)

Note:

実環境では、進捗レポートと情報レポートは不要。
必要なのはエラーレポートのみなので、以下のように設定するとよい。
(設定しないと、進捗レポートと情報レポートでログがあふれるらしい...)

[{sasl, [
  {sasl_error_logger, false},
  {errlog_type, error},
  {error_logger_mf_dir, "./log/error_logs"},
  {error_logger_mf_maxbytes, 10485760},
  {error_logger_mf_maxfiles, 10}
]}].

errlog_typeでエラーのみ出力するように指定している。
さっき出したログのエラーを解析してみる。

Example:

iex> :rb.help()
...長いので割愛

iex> :rb.start([{:max, 20}])
rb: reading report...done.
{:ok, #PID<0.101.0>}
iex> :rb.list
  No                Type   Process       Date     Time
  ==                ====   =======       ====     ====
  20            progress  <0.23.0> 2016-03-08 23:29:46
  19            progress  <0.51.0> 2016-03-08 23:29:46
  18            progress  <0.23.0> 2016-03-08 23:29:46
  17            progress  <0.57.0> 2016-03-08 23:29:46
  16            progress  <0.57.0> 2016-03-08 23:29:46
  15            progress  <0.57.0> 2016-03-08 23:29:46
  14            progress  <0.57.0> 2016-03-08 23:29:46
  13            progress  <0.23.0> 2016-03-08 23:29:46
  12            progress  <0.69.0> 2016-03-08 23:29:47
  11            progress  <0.69.0> 2016-03-08 23:29:47
  10            progress  <0.69.0> 2016-03-08 23:29:47
   9            progress  <0.23.0> 2016-03-08 23:29:47
   8         info_report  <0.23.0> 2016-03-08 23:29:47
   7            progress  <0.85.0> 2016-03-08 23:29:47
   6            progress  <0.85.0> 2016-03-08 23:29:47
   5            progress  <0.85.0> 2016-03-08 23:29:47
   4            progress  <0.85.0> 2016-03-08 23:29:47
   3            progress  <0.23.0> 2016-03-08 23:29:47
   2            progress  <0.23.0> 2016-03-08 23:29:47
   1               error   <0.9.0> 2016-03-08 23:30:04
:ok
iex> :rb.show(1)

ERROR REPORT  <0.94.0>                                      2016-03-08 23:30:04
===============================================================================

This is an error
:ok
数ページ進むのに3時間も掛かった…中々、ぱねぇっす…
いつのまにかエラーロガーのページが終わってたので、次からはアラーム管理に移ります。
詳しく調べたいが…いかんせん実力が足りない…
もう少し深くやりたいが先に進むことを優先します。
まぁ、そのうち分かるでしょう！(楽観)

Bibliography

​
ラベル: , ,

人気の投稿

  • [Elixir]Proxy環境下でElixirを無理やり動かす！
    Proxy環境下でElixirを動かすまでにやったこと 社内の環境だとProxyがあるためうまく動かないことはわかっていた。 時間ができたので、突貫でElixirの仮環境を作成しました。 突貫で作業したので、内容に不備があるかもしれません。 もし問題が発生しましたら、...
  • Rubyのエンコーディングについて
    タイトル：Rubyのエンコーディングについて 目的：Rubyのエンコーディングについての備忘録を作成すること 以下の環境により実施 OS：Windows8.1 Ruby：v2.2.2 x64 ディレクトリ構造： 作業ディレクトリ |-encoding-test....
  • Sinatraで入力フォームのデータを取得する。
    タイトル：Sinatraで入力フォームのデータを取得する。 目的：htmlのinputタグ(テキストボックス)で入力されたデータを取得し表示する。 実施環境： OS：Windows8.1 Ruby：v2.2.2 Sinatra：v1.4.6 Haml：v4.0.6...
  • [Elixir]Streamの使い方を習得する
    Goal Streamの使い方を習得する。 Dev-Environment OS: Windows8.1 Erlang: Eshell V6.4, OTP-Version 17.5 Elixir: v1.0.5 Wait a minute 今回はStr...
  • Sinatraで掲示板を作ってみた！！
    タイトル：Sinatraで掲示板を作ってみた！！ 目的：Sinatraを使って掲示板を作成してみる。 実施環境： OS：Windows8.1 Ruby：v2.2.2 Sinatra：v1.4.6 Haml：v4.0.6 ディレクトリ構造： 作業ディレクトリ ...
  • [Elixir]Cowboy基礎の基礎
    Cowboy基礎の基礎 Goal Elixir+Cowboy(2系)でHello World(text/plain)を表示する PlugからCowboyを使って、起動からリクエストを処理するまでのフローを眺める (Code Reading) Foreword ...
  • [Elixir]マップを引数で使う時のパターンマッチの応用
    Goal 関数の引数でマップを使う時、パターンマッチを利用する。 Dev-Environment OS: Windows8.1 Erlang: Eshell V6.4, OTP-Version 17.5 Elixir: v1.0.5 Wait a minu...
  • [Elixir]ファイルの自動生成を行うカスタムタスクを作成する
    Goal ファイルの自動生成を行うカスタムタスクを作成する。 Dev-Environment OS: Windows8.1 Erlang: Eshell V6.4, OTP-Version 17.5 Elixir: v1.0.4 Wait a minute...
  • [Elixir]GenServerの基本を習得する
    Goal GenServerの基本を習得する。 Dev-Environment OS: Windows8.1 Erlang: Eshell V6.4, OTP-Version 17.5 Elixir: v1.0.5 Wait a minute プロセス...
  • Dark-Elixir = NeoVim |> dein.vim(Dark power) |> Mix |> Elixir
    Get Dark-Elixir 期待した人には申し訳ないですが、掲題で書いているほどちゃんとした内容ではありません。 簡単に説明しますと、NeoVim+dein.vim+elixirの開発環境がほしいなーって思ったので、環境構築するだけの記事です。 それと最初に言って...