appsignal 2.1.2 → 2.2.0.beta.1

data/lib/appsignal/minutely.rb

@@ -1,4 +1,5 @@
 module Appsignal
+  # @api private
   class Minutely
     class << self
       # List of probes. Probes can be lamdba's or objects that

data/lib/appsignal/rack/generic_instrumentation.rb

@@ -1,6 +1,7 @@
 require "rack"
 
 module Appsignal
+  # @api private
   module Rack
     class GenericInstrumentation
       def initialize(app, options = {})
@@ -33,9 +34,9 @@ module Appsignal
           raise error
         ensure
           if env["appsignal.route"]
-            transaction.set_action(env["appsignal.route"])
+            transaction.set_action_if_nil(env["appsignal.route"])
           else
-            transaction.set_action("unknown")
+            transaction.set_action_if_nil("unknown")
           end
           transaction.set_metadata("path", request.path)
           transaction.set_metadata("method", request.request_method)

data/lib/appsignal/rack/js_exception_catcher.rb

@@ -1,29 +1,69 @@
 module Appsignal
+  # @api private
   module Rack
+    # JavaScript error catching middleware.
+    #
+    # Listens to the endpoint specified in the `frontend_error_catching_path`
+    # configuration option.
+    #
+    # This is automatically included middleware in Rails apps if the
+    # `frontend_error_catching_path` configuration option is active.
+    #
+    # If AppSignal is not active in the current environment, but does have
+    # JavaScript error catching turned on, we assume that a JavaScript script
+    # still sends errors to this endpoint. When AppSignal is not active in this
+    # scenario this middleware still listens to the endpoint, but won't record
+    # the error. It will return HTTP status code 202.
+    #
+    # @example with a Sinatra app
+    #   Sinatra::Application.use(Appsignal::Rack::JSExceptionCatcher)
+    #
+    # @see http://docs.appsignal.com/front-end/error-handling.html
+    # @api private
     class JSExceptionCatcher
-      def initialize(app, options = {})
-        Appsignal.logger.debug "Initializing Appsignal::Rack::JSExceptionCatcher"
+      def initialize(app, _options = nil)
+        Appsignal.logger.debug \
+          "Initializing Appsignal::Rack::JSExceptionCatcher"
         @app = app
-        @options = options
       end
 
       def call(env)
-        if env["PATH_INFO"] == Appsignal.config[:frontend_error_catching_path]
-          body = JSON.parse(env["rack.input"].read)
+        # Ignore other paths than the error catching path.
+        return @app.call(env) unless error_cathing_endpoint?(env)
+
+        # Prevent raising a 404 not found when a non-active environment posts
+        # to this endpoint.
+        unless Appsignal.active?
+          return [
+            202,
+            {},
+            ["AppSignal JavaScript error catching endpoint is not active."]
+          ]
+        end
 
-          if body["name"].is_a?(String) && !body["name"].empty?
-            transaction = JSExceptionTransaction.new(body)
-            transaction.complete!
-            code = 200
-          else
-            Appsignal.logger.debug "JSExceptionCatcher: Could not send exception, 'name' is empty."
-            code = 422
-          end
+        begin
+          body = JSON.parse(env["rack.input"].read)
+        rescue JSON::ParserError
+          return [400, {}, ["Request payload is not valid JSON."]]
+        end
 
-          [code, {}, []]
+        if body["name"].is_a?(String) && !body["name"].empty?
+          transaction = JSExceptionTransaction.new(body)
+          transaction.complete!
+          code = 200
         else
-          @app.call(env)
+          Appsignal.logger.debug \
+            "JSExceptionCatcher: Could not send exception, 'name' is empty."
+          code = 422
         end
+
+        [code, {}, []]
+      end
+
+      private
+
+      def error_cathing_endpoint?(env)
+        env["PATH_INFO"] == Appsignal.config[:frontend_error_catching_path]
       end
     end
   end

data/lib/appsignal/rack/rails_instrumentation.rb

@@ -1,6 +1,7 @@
 require "rack"
 
 module Appsignal
+  # @api private
   module Rack
     class RailsInstrumentation
       def initialize(app, options = {})
@@ -33,7 +34,7 @@ module Appsignal
         ensure
           controller = env["action_controller.instance"]
           if controller
-            transaction.set_action("#{controller.class}##{controller.action_name}")
+            transaction.set_action_if_nil("#{controller.class}##{controller.action_name}")
           end
           transaction.set_http_or_background_queue_start
           transaction.set_metadata("path", request.path)

data/lib/appsignal/rack/sinatra_instrumentation.rb

@@ -7,6 +7,8 @@ module Appsignal
     # `use Appsignal::Rack::SinatraInstrumentation` in their modular Sinatra
     # applications. This is no longer needed. Instead Appsignal now includes
     # `use Appsignal::Rack::SinatraBaseInstrumentation` automatically.
+    #
+    # @api private
     class SinatraInstrumentation
       def initialize(app, options = {})
         @app = app
@@ -63,10 +65,10 @@ module Appsignal
         ensure
           # If raise_error is off versions of Sinatra don't raise errors, but store
           # them in the sinatra.error env var.
-          if !@raise_errors_on && env["sinatra.error"] && !env["sinatra.skip_appsignal_error"]
+          if !raise_errors_on && env["sinatra.error"] && !env["sinatra.skip_appsignal_error"]
             transaction.set_error(env["sinatra.error"])
           end
-          transaction.set_action(action_name(env))
+          transaction.set_action_if_nil(action_name(env))
           transaction.set_metadata("path", request.path)
           transaction.set_metadata("method", request.request_method)
           transaction.set_http_or_background_queue_start

data/lib/appsignal/rack/streaming_listener.rb

@@ -1,6 +1,8 @@
-# Appsignal module that tracks exceptions in Streaming rack responses.
 module Appsignal
   module Rack
+    # Appsignal module that tracks exceptions in Streaming rack responses.
+    #
+    # @api private
     class StreamingListener
       def initialize(app, options = {})
         Appsignal.logger.debug "Initializing Appsignal::Rack::StreamingListener"
@@ -33,7 +35,7 @@ module Appsignal
               transaction.set_error(e)
               raise e
             ensure
-              transaction.set_action(env["appsignal.action"])
+              transaction.set_action_if_nil(env["appsignal.action"])
               transaction.set_metadata("path", request.path)
               transaction.set_metadata("method", request.request_method)
               transaction.set_http_or_background_queue_start

data/lib/appsignal/system.rb

@@ -1,38 +1,12 @@
 module Appsignal
+  # System environment detection module.
+  #
+  # Provides useful methods to find out more about the host system.
+  #
+  # @api private
   module System
-    def self.container?
-      heroku? || Container.id
-    end
-
     def self.heroku?
       ENV.key? "DYNO".freeze
     end
-
-    module Container
-      CGROUP_FILE = "/proc/self/cgroup".freeze
-
-      class << self
-        def id
-          case cgroups
-          when %r{docker[-|/]([0-9a-f]+)}
-            $1
-          when %r{lxc/([0-9a-f-]+)$} # LXC / Heroku
-            $1
-          end
-        end
-
-        private
-
-        def cgroups
-          file = CGROUP_FILE
-          return unless File.exist? file
-
-          File.read(file)
-        rescue SystemCallError => e
-          Appsignal.logger.debug "Unable to read '#{file}' to determine cgroup"
-          Appsignal.logger.debug e
-        end
-      end
-    end
   end
 end

data/lib/appsignal/transaction.rb

@@ -20,7 +20,7 @@ module Appsignal
       HTTP_CACHE_CONTROL HTTP_CONNECTION HTTP_USER_AGENT HTTP_FROM
       HTTP_NEGOTIATE HTTP_PRAGMA HTTP_REFERER HTTP_X_FORWARDED_FOR
       HTTP_CLIENT_IP HTTP_RANGE HTTP_X_AUTH_TOKEN
-    )
+    ).freeze
 
     class << self
       def create(id, namespace, request, options = {})
@@ -59,10 +59,11 @@ module Appsignal
       end
     end
 
-    attr_reader :ext, :transaction_id, :namespace, :request, :paused, :tags, :options, :discarded
+    attr_reader :ext, :transaction_id, :action, :namespace, :request, :paused, :tags, :options, :discarded
 
     def initialize(transaction_id, namespace, request, options = {})
       @transaction_id = transaction_id
+      @action = nil
       @namespace = namespace
       @request = request
       @paused = false
@@ -122,15 +123,78 @@ module Appsignal
       @store[key]
     end
 
+    # Set tags on the transaction.
+    #
+    # @param given_tags [Hash] Collection of tags.
+    # @option given_tags [String, Symbol, Integer] :any
+    #   The name of the tag as a Symbol.
+    # @option given_tags [String, Symbol, Integer] "any"
+    #   The name of the tag as a String.
+    # @return [void]
+    #
+    # @see Appsignal.tag_request
+    # @see http://docs.appsignal.com/ruby/instrumentation/tagging.html
+    #   Tagging guide
     def set_tags(given_tags = {})
       @tags.merge!(given_tags)
     end
 
+    # Set an action name for the transaction.
+    #
+    # An action name is used to identify the location of a certain sample;
+    # error and performance issues.
+    #
+    # @param action [String] the action name to set.
+    # @return [void]
+    # @see Appsignal.set_action
+    # @see #set_action_if_nil
+    # @since 2.2.0
     def set_action(action)
       return unless action
+      @action = action
       @ext.set_action(action)
     end
 
+    # Set an action name only if there is no current action set.
+    #
+    # Commonly used by AppSignal integrations so that they don't override
+    # custom action names.
+    #
+    # @example
+    #   Appsignal.set_action("foo")
+    #   Appsignal.set_action_if_nil("bar")
+    #   # Transaction action will be "foo"
+    #
+    # @param action [String]
+    # @return [void]
+    # @see #set_action
+    # @since 2.2.0
+    def set_action_if_nil(action)
+      return if @action
+      set_action(action)
+    end
+
+    # Set the namespace for this transaction.
+    #
+    # Useful to split up parts of an application into certain namespaces. For
+    # example: http requests, background jobs and administration panel
+    # controllers.
+    #
+    # Note: The "http_request" namespace gets transformed on AppSignal.com to
+    # "Web" and "background_job" gets transformed to "Background".
+    #
+    # @example
+    #   transaction.set_action("admin")
+    #
+    # @param namespace [String] namespace name to use for this transaction.
+    # @return [void]
+    # @since 2.2.0
+    def set_namespace(namespace)
+      return unless namespace
+      @namespace = namespace
+      @ext.set_namespace(namespace)
+    end
+
     def set_http_or_background_action(from = request.params)
       return unless from
       group_and_action = [
@@ -239,7 +303,7 @@ module Appsignal
       end
     end
 
-    protected
+    private
 
     # Returns calculated background queue start time in milliseconds, based on
     # environment values.
@@ -308,7 +372,7 @@ module Appsignal
     # The environment of a transaction can contain a lot of information, not
     # all of it useful for debugging.
     #
-    # Only the values from the keys specified in `ENV_METHODS` are returned.
+    # Only the values from the keys specified in {ENV_METHODS} are returned.
     #
     # @return [nil] if no environment is present.
     # @return [Hash<String, Object>]
@@ -380,8 +444,9 @@ module Appsignal
       end
     end
 
-    # Stub that is returned by `Transaction.current` if there is no current transaction, so
-    # that it's still safe to call methods on it if there is none.
+    # Stub that is returned by {Transaction.current} if there is no current
+    # transaction, so that it's still safe to call methods on it if there is no
+    # current transaction.
     class NilTransaction
       def method_missing(m, *args, &block)
       end

data/lib/appsignal/transmitter.rb

@@ -5,9 +5,9 @@ require "rack/utils"
 require "json"
 
 module Appsignal
+  # @api private
   class Transmitter
     CONTENT_TYPE = "application/json; charset=UTF-8".freeze
-    CONTENT_ENCODING = "gzip".freeze
 
     HTTP_ERRORS = [
       EOFError,
@@ -19,38 +19,49 @@ module Appsignal
       Net::ProtocolError,
       Timeout::Error,
       OpenSSL::SSL::SSLError
-    ]
+    ].freeze
 
-    attr_reader :config, :action
+    attr_reader :config, :base_uri
 
-    def initialize(action, config = Appsignal.config)
-      @action = action
+    # @param base_uri [String] Base URI for the transmitter to use. If a full
+    #   URI is given (including the HTTP protocol) it is used as the full base.
+    #   If only a path is given the `config[:endpoint]` is prefixed along with
+    #   `/1/` (API v1 endpoint).
+    # @param config [Appsignal::Config] AppSignal configuration to use for this
+    #   transmission.
+    def initialize(base_uri, config = Appsignal.config)
+      @base_uri =
+        if base_uri.start_with? "http"
+          base_uri
+        else
+          "#{config[:endpoint]}/1/#{base_uri}"
+        end
       @config = config
     end
 
     def uri
-      @uri ||= URI("#{config[:endpoint]}/1/#{action}").tap do |uri|
-        uri.query = ::Rack::Utils.build_query(:api_key => config[:push_api_key],
+      @uri ||= URI(base_uri).tap do |uri|
+        uri.query = ::Rack::Utils.build_query(
+          :api_key => config[:push_api_key],
           :name => config[:name],
           :environment => config.env,
           :hostname => config[:hostname],
-          :gem_version => Appsignal::VERSION)
+          :gem_version => Appsignal::VERSION
+        )
       end
     end
 
     def transmit(payload)
       config.logger.debug "Transmitting payload to #{uri}"
-      http_client.request(http_post(payload)).code
+      http_client.request(http_post(payload))
     end
 
-    protected
+    private
 
     def http_post(payload)
       Net::HTTP::Post.new(uri.request_uri).tap do |request|
         request["Content-Type"] = CONTENT_TYPE
-        request["Content-Encoding"] = CONTENT_ENCODING
-        request.body = Appsignal::Utils::Gzip.compress \
-          Appsignal::Utils::JSON.generate(payload)
+        request.body = Appsignal::Utils::JSON.generate(payload)
       end
     end
 

data/lib/appsignal/utils.rb

@@ -2,6 +2,7 @@ require "appsignal/utils/params_sanitizer"
 require "appsignal/utils/query_params_sanitizer"
 
 module Appsignal
+  # @api private
   module Utils
     def self.data_generate(body)
       Data.generate(body)
@@ -15,7 +16,7 @@ module Appsignal
           elsif body.is_a?(Array)
             map_array(body)
           else
-            raise TypeError.new("Body of type #{body.class} should be a Hash or Array")
+            raise TypeError, "Body of type #{body.class} should be a Hash or Array"
           end
         end
 
@@ -26,8 +27,14 @@ module Appsignal
             case value
             when String
               map.set_string(key, value)
-            when Fixnum
-              map.set_fixnum(key, value)
+            when Integer
+              # An Integer too big for C-lang longs to fit
+              bigint = 1 << 63
+              if value >= bigint
+                map.set_string(key, "bigint:#{value}")
+              else
+                map.set_integer(key, value)
+              end
             when Float
               map.set_float(key, value)
             when TrueClass, FalseClass
@@ -51,8 +58,14 @@ module Appsignal
             case value
             when String
               array.append_string(value)
-            when Fixnum
-              array.append_fixnum(value)
+            when Integer
+              # An Integer too big for C-lang longs to fit
+              bigint = 1 << 63
+              if value >= bigint
+                array.append_string("bigint:#{value}")
+              else
+                array.append_integer(value)
+              end
             when Float
               array.append_float(value)
             when TrueClass, FalseClass
@@ -108,11 +121,5 @@ module Appsignal
         end
       end
     end
-
-    class Gzip
-      def self.compress(body)
-        Zlib::Deflate.deflate(body, Zlib::BEST_SPEED)
-      end
-    end
   end
 end