2.3.2.1 Ruby

Loggerの組み込み手順は、以下のGithubのリポジトリをご参照ください。

https://github.com/mxload/mxload_rb/blob/main/README.md

Loggerが組み込まれた状態で、アプリケーションにリクエストを投げると、リクエストログがMx.Load に送信されるようになります。 このログをもとにシナリオを生成します。

1. ログを取得したいRailsのGemfileにmxloadを追加します。

gem 'mxload', github: 'mxload/mxload_rb' , tag: 'v0.2.3'

2. gemをインストールします。

$ bundle install

3. 下記2行を config/application.rb または config/environments/{RAILS_ENV}.rb に追加します。

require "mxload/collector"

config.middleware.insert_before(0, Mxload::Collector)

• config/application.rbに追加する場合の例

  ... 略
  
  require "mxload/collector"
  
  ... 略
  
  module TodoApiMock
    class Application < Rails::Application
      ... 略
  
      config.middleware.insert_before(0, Mxload::Collector)
    end
  end
  

• config/environments/{RAILS_ENV}.rbに追加する場合の例

  ... 略
  
  require "mxload/collector"
  
  Rails.application.configure do
    ... 略
  
    config.middleware.insert_before(0, Mxload::Collector)
  end
  

4. config/initializers/mxload.rb ファイルを作成し、以下の内容を追加します。

Mxload.configure do |config|
    config.enable        = true
    config.project_id    = 1
    config.service_key   = 'servicekey'
    config.custom_header = %w[Content-Type]
    config.ignore_paths  = %w[/health]
end

主な設定パラメータは以下になります。

• enable
  • このgemの有効/無効を切り替えます。デフォルトは false です。
• project_id
  • 作成したprojectのidを設定します。project_id はホーム・またはプロジェクト詳細から確認できます。

    

• service_key
  • # サービスキーの発行 で作成したサービスキーを設定します。
• cunstom_header (オプション)
  • ヘッダーの内容を記録する際に必要です。 例: "Content-Type": "application/json" を含めたい場合、config.custom_header の値を %w[Content-Type] に設定します。
• ignore_paths (オプション)
  • リクエストパスが ignore_paths 内にある場合、リクエストログの送信を無視します。 /health など、ヘルスチェックのパスを無効にしたい場合に設定します。

Mx.Loadに送信されるログパラメータは以下になります。

• メソッド
• リクエストパス
• リクエストボディ
• クエリパラメーター
• リクエストヘッダ
• クッキー