atatus 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2602d9c1f9bd2eb164f36638cc774cbad5618f362a342be4f33b04c33b83b848
-  data.tar.gz: 20446fd8e0a732c8361a523d84ad3af68f4ae0a93e177773bd8f20350a58a2d0
+  metadata.gz: 651694b5c78acd1f1582c30f1b28715b6a653c2b125a75613a19b7ae86361d9b
+  data.tar.gz: 4a8e5ee631f32b09942bb6ae53a72531c4e7ffe2677194ee7f19f81dfd4c9eeb
 SHA512:
-  metadata.gz: 2d0f3386ee29b3785096f9832bbae6a4d73e374cc1c5b181a98baafc3f12a52bb67ab82d1d183850459ac8b67f96250a3cba3475ca1fd6527f6f176d44091f41
-  data.tar.gz: 446edc9f0c6bf1c636592bc256807aea85261be9ec53008657df658ca3a5d7d179b0731cf74462ec4e0b0a29562dc878bfda84b0e7587ba84ea4babff48cc97b
+  metadata.gz: 0400c2f1f8bdd57366d49d5a05f8d4dc49bc804e5dc263cfe9771043a021a47c08d7544af1adb9408a2c517c7839d20e6e7bb48329038e684c35a61bbf0db210
+  data.tar.gz: 76eb02d1bf4cebf184ff8df44f71d553f64fe9e9dfb75aeb4c3e214a97a3dbc6efc7797a34321f019a0fc15be06800ef575efae6dc580aa1061037aeb1c13f4d

data/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 
+## 1.4.0 (Tue, 15 Sept 2020)
+
+- Added histogram support.
+- Fixed Ruby 2.7.0 warning messages.
+
+
 ## 1.3.0 (Wed, 18 Mar 2020)
 
 - Added custom instrumentation via annotate method.

data/Gemfile

@@ -1,57 +1,107 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gemspec
-
+# Tools
+gem 'bootsnap', require: false
+gem 'cucumber', require: false
+gem 'pry'
 gem 'rack-test'
-gem 'rspec'
+gem 'rspec', '~> 3'
 gem 'rspec-its'
 gem 'rubocop', require: nil
+gem 'rubocop-performance', require: nil
 gem 'timecop'
 gem 'webmock'
 
+# Integrations
+gem 'aws-sdk-dynamodb', require: nil
+gem 'aws-sdk-sqs', require: nil
 gem 'elasticsearch', require: nil
 gem 'fakeredis', require: nil
 gem 'faraday', require: nil
+gem 'graphql', require: nil
+gem 'google-protobuf', '< 3.12' if !defined?(JRUBY_VERSION) && RUBY_VERSION < '2.5'
+gem 'grpc' if !defined?(JRUBY_VERSION)
+gem 'json'
 gem 'json-schema', require: nil
 gem 'mongo', require: nil
 gem 'opentracing', require: nil
 gem 'rake', require: nil
+gem 'resque', require: nil
 gem 'sequel', require: nil
+gem 'shoryuken', require: nil
 gem 'sidekiq', require: nil
-gem 'simplecov', require: false, group: :test
-gem 'simplecov-cobertura', require: false, group: :test
+gem 'simplecov', require: false
+gem 'simplecov-cobertura', require: false
+gem 'sneakers', '~> 2.12', require: nil
+gem 'sucker_punch', '~> 2.0', require: nil
 gem 'yard', require: nil
 gem 'yarjuf'
 
-if RUBY_PLATFORM == 'java'
-  gem 'jdbc-sqlite3'
-else
-  gem 'sqlite3'
-end
+## Install Framework
+GITHUB_REPOS = {
+  'grape' => 'ruby-grape/grape',
+  'rails' => 'rails/rails',
+  'sinatra' => 'sinatra/sinatra'
+}.freeze
 
-framework, *version = ENV.fetch('FRAMEWORK', 'rails').split('-')
-version = version.join('-')
+#                new               || legacy           || default
+env_frameworks = ENV['FRAMEWORKS'] || ENV['FRAMEWORK'] || ''
+parsed_frameworks = env_frameworks.split(',')
+frameworks_versions = parsed_frameworks.inject({}) do |frameworks, str|
+  framework, *version = str.split('-')
+  frameworks.merge(framework => version.join('-'))
+end
 
-case version
-when 'master'
-  gem framework, github: "#{framework}/#{framework}"
-when /.+/
-  gem framework, "~> #{version}.0"
-else
-  gem framework
+frameworks_versions.each do |framework, version|
+  case version
+  when 'master'
+    gem framework, github: GITHUB_REPOS.fetch(framework)
+  when /.+/
+    gem framework, "~> #{version}.0"
+  else
+    gem framework
+  end
 end
 
-gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
+if frameworks_versions.key?('rails')
+  unless frameworks_versions['rails'] =~ /^(master|6)/
+    gem 'delayed_job', require: nil
+  end
+end
 
-unless version =~ /^(master|6)/
-  gem 'delayed_job', require: nil
+if RUBY_PLATFORM == 'java'
+  gem 'activerecord-jdbcsqlite3-adapter'
+  gem 'jdbc-sqlite3'
+elsif frameworks_versions['rails'] =~ /^(4|5)/
+  gem 'sqlite3', '~> 1.3.6'
+else
+  gem 'sqlite3' # rubocop:disable Bundler/DuplicatedGem
 end
 
 group :bench do
   gem 'ruby-prof', require: nil, platforms: %i[ruby]
   gem 'stackprof', require: nil, platforms: %i[ruby]
 end
+
+gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-All components of this product are Copyright (c) 2019 Atatus. All rights reserved.
+All components of this product are Copyright (c) 2020 Atatus. All rights reserved.
 
 Except as otherwise expressly provided in this Agreement,
 End User shall not (and shall not permit any third party to):

data/atatus.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://www.atatus.com'
   spec.metadata      = {
     'changelog_uri' => 'https://docs.atatus.com/docs/release-notes/ruby.html',
-    'documentation_uri' => 'https://docs.atatus.com/docs/application-monitoring/ruby-agent/rails.html',
+    'documentation_uri' => 'https://docs.atatus.com/docs/application-monitoring/ruby-agent/overview.html',
   }
   spec.date = Time.now.strftime('%Y-%m-%d')
   spec.licenses       = ['Atatus']
@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   ]
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features|docs|releases)/}) || f.match(%r{^(CONTRIBUTING.md|RELEASE.md)})
+    f.match(%r{^(bench|bin|test|spec|features|docs|releases)/}) || f.match(%r{^(CONTRIBUTING.md|RELEASE.md|Rakefile|docker-compose.yml|Dockerfile)})
   end
 
   spec.add_dependency('concurrent-ruby', '~> 1.0')

data/lib/atatus.rb

@@ -1,5 +1,32 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
+require 'erb'
+require 'http'
+require 'json'
+require 'yaml'
+require 'zlib'
+require 'logger'
+require 'concurrent'
+require 'forwardable'
+require 'securerandom'
+
 require 'atatus/version'
 require 'atatus/internal_error'
 require 'atatus/logging'
@@ -12,11 +39,15 @@ require 'atatus/instrumenter'
 require 'atatus/util'
 
 require 'atatus/middleware'
+require 'atatus/graphql'
 
-require 'atatus/railtie' if defined?(::Rails::Railtie)
+require 'atatus/rails' if defined?(::Rails::Railtie)
+require 'atatus/sinatra' if defined?(::Sinatra)
+require 'atatus/grape' if defined?(::Grape)
+require 'atatus/grpc' if defined?(::GRPC)
 
 # Atatus
-module Atatus # rubocop:disable Metrics/ModuleLength
+module Atatus
   class << self
     ### Life cycle
 
@@ -33,6 +64,16 @@ module Atatus # rubocop:disable Metrics/ModuleLength
       Agent.stop
     end
 
+    # Restarts the Atatus Agent using the same config or a new
+    # one, if it is provided.
+    # Starts the agent if it is not running.
+    # Stops and starts the agent if it is running.
+    def restart(config = nil)
+      config ||= agent&.config
+      stop if running?
+      start(config)
+    end
+
     # @return [Boolean] Whether there's an [Agent] running
     def running?
       Agent.running?
@@ -59,7 +100,6 @@ module Atatus # rubocop:disable Metrics/ModuleLength
       agent&.current_span
     end
 
-    # rubocop:disable Metrics/AbcSize
     # Get a formatted string containing transaction, span, and trace ids.
     # If a block is provided, the ids are yielded.
     #
@@ -78,9 +118,7 @@ module Atatus # rubocop:disable Metrics/ModuleLength
       ids << "trace.id=#{trace_id}" if trace_id
       ids.join(' ')
     end
-    # rubocop:enable Metrics/AbcSize
 
-    # rubocop:disable Metrics/MethodLength
     # Start a new transaction
     #
     # @param name [String] A description of the transaction, eg
@@ -88,6 +126,8 @@ module Atatus # rubocop:disable Metrics/ModuleLength
     # @param type [String] The kind of the transaction, eg `app.request.get` or
     # `db.mysql2.query`
     # @param context [Context] An optional [Context]
+    # @param trace_context [TraceContext] An optional [TraceContext] object for
+    #   Distributed Tracing.
     # @return [Transaction]
     def start_transaction(
       name = nil,
@@ -102,7 +142,6 @@ module Atatus # rubocop:disable Metrics/ModuleLength
         trace_context: trace_context
       )
     end
-    # rubocop:enable Metrics/MethodLength
 
     # Ends the current transaction with `result`
     #
@@ -112,7 +151,6 @@ module Atatus # rubocop:disable Metrics/ModuleLength
       agent&.end_transaction(result)
     end
 
-    # rubocop:disable Metrics/MethodLength
     # Wrap a block in a Transaction, ending it after the block
     #
     # @param name [String] A description of the transaction, eg
@@ -120,6 +158,8 @@ module Atatus # rubocop:disable Metrics/ModuleLength
     # @param type [String] The kind of the transaction, eg `app.request.get` or
     # `db.mysql2.query`
     # @param context [Context] An optional [Context]
+    # @param trace_context [TraceContext] An optional [TraceContext] object for
+    #   Distributed Tracing.
     # @yield [Transaction]
     # @return result of block
     def with_transaction(
@@ -148,8 +188,8 @@ module Atatus # rubocop:disable Metrics/ModuleLength
         end_transaction
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
+    # rubocop:disable Metrics/ParameterLists
     # Start a new span
     #
     # @param name [String] A description of the span, eq `SELECT FROM "users"`
@@ -158,6 +198,11 @@ module Atatus # rubocop:disable Metrics/ModuleLength
     # @param action [String] The span action type, eq `connect` or `query`
     # @param context [Span::Context] Context information about the span
     # @param include_stacktrace [Boolean] Whether or not to capture a stacktrace
+    # @param trace_context [TraceContext] An optional [TraceContext] object for
+    #   Distributed Tracing.
+    # @param parent [Transaction,Span] The parent transaction or span.
+    #   Relevant when the span is created in another thread.
+    # @param sync [Boolean] Whether the span is created synchronously or not.
     # @return [Span]
     def start_span(
       name,
@@ -166,7 +211,9 @@ module Atatus # rubocop:disable Metrics/ModuleLength
       action: nil,
       context: nil,
       include_stacktrace: true,
-      trace_context: nil
+      trace_context: nil,
+      parent: nil,
+      sync: nil
     )
       agent&.start_span(
         name,
@@ -174,7 +221,9 @@ module Atatus # rubocop:disable Metrics/ModuleLength
         subtype: subtype,
         action: action,
         context: context,
-        trace_context: trace_context
+        trace_context: trace_context,
+        parent: parent,
+        sync: sync
       ).tap do |span|
         break unless span && include_stacktrace
         break unless agent.config.span_frames_min_duration?
@@ -182,7 +231,7 @@ module Atatus # rubocop:disable Metrics/ModuleLength
         span.original_backtrace ||= caller
       end
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
+    # rubocop:enable Metrics/ParameterLists
 
     # Ends the current span
     #
@@ -191,13 +240,20 @@ module Atatus # rubocop:disable Metrics/ModuleLength
       agent&.end_span
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
+    # rubocop:disable Metrics/ParameterLists
     # Wrap a block in a Span, ending it after the block
     #
     # @param name [String] A description of the span, eq `SELECT FROM "users"`
-    # @param type [String] The kind of span, eq `db.mysql2.query`
+    # @param type [String] The kind of span, eq `db`
+    # @param subtype [String] The subtype of span eg. `postgresql`.
+    # @param action [String] The action type of span eg. `connect` or `query`.
     # @param context [Span::Context] Context information about the span
     # @param include_stacktrace [Boolean] Whether or not to capture a stacktrace
+    # @param trace_context [TraceContext] An optional [TraceContext] object for
+    #   Distributed Tracing.
+    # @param parent [Transaction,Span] The parent transaction or span.
+    #   Relevant when the span is created in another thread.
+    # @param sync [Boolean] Whether the span is created synchronously or not.
     # @yield [Span]
     # @return Result of block
     def with_span(
@@ -207,7 +263,9 @@ module Atatus # rubocop:disable Metrics/ModuleLength
       action: nil,
       context: nil,
       include_stacktrace: true,
-      trace_context: nil
+      trace_context: nil,
+      parent: nil,
+      sync: nil
     )
       unless block_given?
         raise ArgumentError,
@@ -225,14 +283,16 @@ module Atatus # rubocop:disable Metrics/ModuleLength
             action: action,
             context: context,
             include_stacktrace: include_stacktrace,
-            trace_context: trace_context
+            trace_context: trace_context,
+            parent: parent,
+            sync: sync
           )
         yield span
       ensure
         end_span
       end
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
+    # rubocop:enable Metrics/ParameterLists
 
     # Build a [Context] from a Rack `env`. The context may include information
     # about the request, response, current user and more

data/lib/atatus/agent.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 require 'atatus/error'
@@ -5,19 +22,18 @@ require 'atatus/error'
 require 'atatus/context_builder'
 require 'atatus/error_builder'
 require 'atatus/stacktrace_builder'
-require 'atatus/collector/base'
 
 require 'atatus/central_config'
-# require 'atatus/transport/base'
+require 'atatus/collector/base'
 require 'atatus/metrics'
 
 require 'atatus/spies'
 
 module Atatus
-  # rubocop:disable Metrics/ClassLength
   # @api private
   class Agent
     include Logging
+    extend Forwardable
 
     LOCK = Mutex.new
 
@@ -27,7 +43,6 @@ module Atatus
       @instance
     end
 
-    # rubocop:disable Metrics/MethodLength
     def self.start(config)
       return @instance if @instance
 
@@ -36,9 +51,9 @@ module Atatus
       LOCK.synchronize do
         return @instance if @instance
 
-        unless config.active?
+        unless config.enabled?
           config.logger.debug format(
-            "%sAgent disabled with `active: false'",
+            "%sAgent disabled with `enabled: false'",
             Logging::PREFIX
           )
           return
@@ -47,7 +62,6 @@ module Atatus
         @instance = new(config).start
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
     def self.stop
       LOCK.synchronize do
@@ -62,24 +76,21 @@ module Atatus
       !!@instance
     end
 
-    # rubocop:disable Metrics/MethodLength
     def initialize(config)
-      @config = config
-
       @stacktrace_builder = StacktraceBuilder.new(config)
       @context_builder = ContextBuilder.new(config)
       @error_builder = ErrorBuilder.new(self)
 
       @central_config = CentralConfig.new(config)
-      # @transport = Transport::Base.new(config)
+      @collector = Collector::Base.new(config)
+      @metrics = Metrics.new(config) { |event| enqueue event }
       @instrumenter = Instrumenter.new(
         config,
+        metrics: metrics,
         stacktrace_builder: stacktrace_builder
       ) { |event| enqueue event }
-      @metrics = Metrics.new(config) { |event| enqueue event }
-      @collector = Collector::Base.new(config)
+      @pid = Process.pid
     end
-    # rubocop:enable Metrics/MethodLength
 
     attr_reader(
       :central_config,
@@ -89,29 +100,31 @@ module Atatus
       :instrumenter,
       :metrics,
       :stacktrace_builder,
-      # :transport,
       :collector
     )
 
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def_delegator :@central_config, :config
+
     def start
-      unless config.disable_start_message
-        info '[%s] Starting atatus ruby agent', VERSION
+      unless config.disable_start_message?
+        config.logger.info format(
+          '[%s] Starting atatus ruby agent',
+          VERSION
+        )
       end
 
-      if @config.license_key.nil? || @config.app_name.nil?
-        if @config.license_key.nil? && @config.app_name.nil?
+      if config.license_key.nil? || config.app_name.nil?
+        if config.license_key.nil? && config.app_name.nil?
           error 'Atatus configuration license_key and app_name are missing'
-        elsif @config.license_key.nil?
+        elsif config.license_key.nil?
           error 'Atatus configuration license_key is missing'
-        elsif @config.app_name.nil?
+        elsif config.app_name.nil?
           error 'Atatus configuration app_name is missing'
         end
       end
 
-      collector.start
       central_config.start
-      # transport.start
+      collector.start
       instrumenter.start
       metrics.start
 
@@ -122,7 +135,6 @@ module Atatus
 
       self
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     def stop
       debug 'Stopping agent'
@@ -131,7 +143,6 @@ module Atatus
       metrics.stop
       instrumenter.stop
       collector.stop
-      # transport.stop
 
       self
     end
@@ -172,9 +183,13 @@ module Atatus
       context: nil,
       trace_context: nil
     )
+      return unless config.recording?
+      detect_forking!
+
       instrumenter.start_transaction(
         name,
         type,
+        config: config,
         context: context,
         trace_context: trace_context
       )
@@ -192,8 +207,16 @@ module Atatus
       action: nil,
       backtrace: nil,
       context: nil,
-      trace_context: nil
+      trace_context: nil,
+      parent: nil,
+      sync: nil
     )
+      detect_forking!
+
+      # We don't check config.recording? because the span
+      # will not be created if there's no transaction.
+      # We want to use the recording value from the config
+      # that existed when start_transaction was called. ~estolfo
       instrumenter.start_span(
         name,
         type,
@@ -201,7 +224,9 @@ module Atatus
         action: action,
         backtrace: backtrace,
         context: context,
-        trace_context: trace_context
+        trace_context: trace_context,
+        parent: parent,
+        sync: sync
       )
     end
     # rubocop:enable Metrics/ParameterLists
@@ -229,6 +254,8 @@ module Atatus
     # errors
 
     def report(exception, context: nil, handled: true)
+      return unless config.recording?
+      detect_forking!
       return if config.filter_exception_types.include?(exception.class.to_s)
 
       error = @error_builder.build_exception(
@@ -241,6 +268,9 @@ module Atatus
     end
 
     def report_message(message, context: nil, backtrace: nil, **attrs)
+      return unless config.recording?
+      detect_forking!
+
       error = @error_builder.build_log(
         message,
         context: context,
@@ -256,6 +286,25 @@ module Atatus
     def add_filter(key, callback)
       # transport.add_filter(key, callback)
     end
+
+    # misc
+
+    def inspect
+      super.split.first + '>'
+    end
+
+    def detect_forking!
+      return if @pid == Process.pid
+
+      config.logger.debug "Detected forking,
+        restarting threads in process [PID:#{Process.pid}]"
+
+      central_config.handle_forking!
+      collector.handle_forking!
+      instrumenter.handle_forking!
+      metrics.handle_forking!
+
+      @pid = Process.pid
+    end
   end
-  # rubocop:enable Metrics/ClassLength
 end