access_watch_rails 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec42186c8a728f3a04d8fa0b85fdb4df23f27892
-  data.tar.gz: 9118ed191885c051045da51a7be4548a1bd690ca
+  metadata.gz: 0c771a0d72ea5fd1d9abef9afa700e8fd2d0ca14
+  data.tar.gz: 2508fb05f8192b23daeba64d5ec79c0836462cc7
 SHA512:
-  metadata.gz: 3c40c872317c68826f764175e11d4f423b51e5d74997bed979a76cccdbe817a136a8d01e682a39b859e416a7f6870829abd56709db414fb92946f2e1fb1dcb7c
-  data.tar.gz: b6848a5bfe04c744fa5cbd2ea47f27971f5804bb0caa1b56c16c04e7593cc3aed0a3574ddf3495786f868a1b1d9ec4535d529cf33b0cf57930539416f8ebae38
+  metadata.gz: 4bc134a59d2196038d4a2c6818832f6d7635f63943870e60ded809a54ab7f9a2d868af031ecc204de7a6a639275ad967127fe8eee331ba77df0ac0b520a6c9a8
+  data.tar.gz: 5a933d609219a04bb6c605972b24b92e61d1120298e6b18140338706b51fd402d67e4a9c18cab38c49a202571f978f1975022f09c169fd1d011395277821ee93

data/README.md

@@ -14,12 +14,20 @@ You will need an API key.
 
 To get an API key, send us an email at api@access.watch and we will come back to you.
 
-Then add the following `after_action` callback in your `ApplicationController`.
+Then create the following file `config/access_watch.yml` and restart/deploy your app.
+
+```yaml
+development:
+  api_key: API_KEY
+
+production:
+  api_key: API_KEY
+```
+
+Or if you prefere add the following line in `config/application.rb` and restart/deploy your app.
 
 ```ruby
-class ApplicationController < ActionController::Base
-  after_action { AccessWatch::Logger.new(api_key: API_KEY).record(request, response) }
-end
+config.middleware.use "AccessWatch::RackLogger", api_key: API_KEY
 ```
 
 API documentation is here: https://access.watch/api-documentation/#request-logging

data/access_watch_rails.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_dependency "access_watch", ">= 0.0.3"
+  spec.add_dependency "access_watch", ">= 0.0.5"
 end

data/lib/access_watch/logger.rb

@@ -10,7 +10,6 @@ module AccessWatch
       post_request(
         time: Time.now.utc,
         address: request.remote_ip,
-        host: request.host,
         request: {
           protocol: request.headers["Version"],
           method: request.method,
@@ -21,6 +20,7 @@ module AccessWatch
           headers: extract_http_headers(request.headers)
         },
         response: {status: response.status},
+        context: {memory_usage: memory_usage_in_bytes},
       )
     end
 
@@ -50,5 +50,27 @@ module AccessWatch
     def post_async(path, data)
       Thread.new { client.post(path, data) }
     end
+
+    def memory_usage_in_bytes
+      linux_process_memory_usage_in_bytes(Process.pid)
+    end
+
+    def linux_process_status(pid)
+      path = "/proc/#{pid}/status"
+      return unless File.readable?(path)
+      File.read(path).split("\n").reduce({}) do |hash, line|
+        name, value = line.split(":")
+        hash[name] = value.strip
+        hash
+      end
+    end
+
+    MEMORY_CONVERSIONS = {"kb" => 1024, "mb" => 1024 * 1024, "gb" => 1024 * 1024 * 1024}
+
+    def linux_process_memory_usage_in_bytes(pid)
+      return unless status = linux_process_status(pid)
+      value, unit = status["VmRSS"].split
+      value.to_i * MEMORY_CONVERSIONS[unit.downcase]
+    end
   end
 end

data/lib/access_watch/rack_logger.rb

@@ -0,0 +1,86 @@
+module AccessWatch
+  class RackLogger
+    attr_reader :app, :client
+
+    def initialize(app, config)
+      @app, @client = app, AccessWatch::Client.new(config)
+    end
+
+    def call(env)
+      started_at = Time.now.utc
+      status, headers, body = app.call(env)
+      record(env, status, started_at, Time.now.utc)
+      [status, headers, body]
+    end
+
+    def record(env, status, started_at, finished_at)
+      post_request(
+        time: started_at.iso8601(3),
+        address: env["REMOTE_ADDR"],
+        request: {
+          protocol: env["HTTP_VERSION"],
+          method: env["REQUEST_METHOD"],
+          scheme: env["rack.url_scheme"],
+          host: env["HTTP_HOST"],
+          port: env["SERVER_PORT"],
+          url: env["ORIGINAL_FULLPATH"],
+          headers: extract_http_headers(env),
+        },
+        response: {status: status},
+        context: {
+          execution_time: finished_at - started_at,
+          memory_usage: memory_usage_in_bytes,
+        },
+      )
+    end
+
+    #######################
+    ### Private methods ###
+    #######################
+
+    private
+
+    def extract_http_headers(headers)
+      headers.reduce({}) do |hash, (name, value)|
+        if name.index("HTTP_") == 0 && name != "HTTP_COOKIE"
+          hash[format_header_name(name)] = value
+        end
+        hash
+      end
+    end
+
+    def format_header_name(name)
+      name.sub(/^HTTP_/, '').sub("_", " ").titleize.sub(" ", "-")
+    end
+
+    def post_request(data)
+      post_async("log".freeze, data)
+    end
+
+    def post_async(path, data)
+      Thread.new { client.post(path, data) }
+    end
+
+    def memory_usage_in_bytes
+      linux_process_memory_usage_in_bytes(Process.pid)
+    end
+
+    def linux_process_status(pid)
+      path = "/proc/#{pid}/status"
+      return unless File.readable?(path)
+      File.read(path).split("\n").reduce({}) do |hash, line|
+        name, value = line.split(":")
+        hash[name] = value.strip
+        hash
+      end
+    end
+
+    MEMORY_CONVERSIONS = {"kb" => 1024, "mb" => 1024 * 1024, "gb" => 1024 * 1024 * 1024}
+
+    def linux_process_memory_usage_in_bytes(pid)
+      return unless status = linux_process_status(pid)
+      value, unit = status["VmRSS"].split
+      value.to_i * MEMORY_CONVERSIONS[unit.downcase]
+    end
+  end
+end

data/lib/access_watch/rails_loader.rb

@@ -0,0 +1,18 @@
+module AccessWacth
+  class RailsLoader
+    def self.start
+      return if !defined?(Rails)
+      Rails::Railtie.initializer "access_watch.detect_config_file" do
+        if (path = Rails.root.join("config/access_watch.yml")).exist?
+          if config = AccessWacth::RailsLoader.load_config_file(path)[Rails.env]
+            Rails.application.config.middleware.use(AccessWatch::RackLogger, config.symbolize_keys)
+          end
+        end
+      end
+    end
+
+    def self.load_config_file(path)
+      YAML.load(ERB.new(path.read).result)
+    end
+  end
+end

data/lib/access_watch/rails_version.rb

@@ -1,3 +1,3 @@
 module AccessWatch
-  RAILS_VERSION = "0.0.6"
+  RAILS_VERSION = "0.1.0"
 end

data/lib/access_watch_rails.rb

@@ -3,4 +3,10 @@ end
 
 require "access_watch"
 require "access_watch/logger"
+require "access_watch/rack_logger"
 require "access_watch/rails_version"
+
+if defined?(Rails)
+  require "access_watch/rails_loader"
+  AccessWacth::RailsLoader.start
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: access_watch_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Alexis Bernard
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.5
 description: A Rails library to log and analyse Rails HTTP requests using the Access
   Watch cloud service.
 email:
@@ -64,6 +64,8 @@ files:
 - README.md
 - access_watch_rails.gemspec
 - lib/access_watch/logger.rb
+- lib/access_watch/rack_logger.rb
+- lib/access_watch/rails_loader.rb
 - lib/access_watch/rails_version.rb
 - lib/access_watch_rails.rb
 homepage: https://access.watch/