atatus 1.3.0 → 1.6.1

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
@@ -292,6 +352,14 @@ module Atatus # rubocop:disable Metrics/ModuleLength
       end
     end
 
+    # Provide further context for the current transaction
+    #
+    # @param custom [Hash] A hash with custom information. Can be nested.
+    # @return [Hash] The current custom context
+    def set_custom_data(custom)
+      agent&.set_custom_context(custom)
+    end
+
     # Provide further context for the current transaction
     #
     # @param custom [Hash] A hash with custom information. Can be nested.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atatus
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Atatus
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2021-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email: success@atatus.com
 executables: []
 extensions: []
@@ -55,25 +55,16 @@ files:
 - LICENSE
 - LICENSE-THIRD-PARTY
 - README.md
-- Rakefile
 - atatus.gemspec
 - atatus.yml
-- bench/.gitignore
-- bench/app.rb
-- bench/benchmark.rb
-- bench/report.rb
-- bench/rubyprof.rb
-- bench/stackprof.rb
-- bin/build_docs
-- bin/console
-- bin/setup
-- bin/with_framework
 - lib/atatus.rb
 - lib/atatus/agent.rb
 - lib/atatus/central_config.rb
 - lib/atatus/central_config/cache_control.rb
+- lib/atatus/child_durations.rb
 - lib/atatus/collector/base.rb
 - lib/atatus/collector/builder.rb
+- lib/atatus/collector/hist.rb
 - lib/atatus/collector/layer.rb
 - lib/atatus/collector/transport.rb
 - lib/atatus/config.rb
@@ -81,6 +72,7 @@ files:
 - lib/atatus/config/duration.rb
 - lib/atatus/config/options.rb
 - lib/atatus/config/regexp_list.rb
+- lib/atatus/config/wildcard_pattern_list.rb
 - lib/atatus/context.rb
 - lib/atatus/context/request.rb
 - lib/atatus/context/request/socket.rb
@@ -93,6 +85,9 @@ files:
 - lib/atatus/error/exception.rb
 - lib/atatus/error/log.rb
 - lib/atatus/error_builder.rb
+- lib/atatus/grape.rb
+- lib/atatus/graphql.rb
+- lib/atatus/grpc.rb
 - lib/atatus/instrumenter.rb
 - lib/atatus/internal_error.rb
 - lib/atatus/logging.rb
@@ -104,25 +99,39 @@ files:
 - lib/atatus/metadata/system_info/hw_info.rb
 - lib/atatus/metadata/system_info/os_info.rb
 - lib/atatus/metrics.rb
-- lib/atatus/metrics/cpu_mem.rb
-- lib/atatus/metrics/vm.rb
+- lib/atatus/metrics/breakdown_set.rb
+- lib/atatus/metrics/cpu_mem_set.rb
+- lib/atatus/metrics/metric.rb
+- lib/atatus/metrics/set.rb
+- lib/atatus/metrics/span_scoped_set.rb
+- lib/atatus/metrics/transaction_set.rb
+- lib/atatus/metrics/vm_set.rb
 - lib/atatus/metricset.rb
 - lib/atatus/middleware.rb
 - lib/atatus/naively_hashable.rb
 - lib/atatus/normalizers.rb
-- lib/atatus/normalizers/action_controller.rb
-- lib/atatus/normalizers/action_mailer.rb
-- lib/atatus/normalizers/action_view.rb
-- lib/atatus/normalizers/active_record.rb
+- lib/atatus/normalizers/grape.rb
+- lib/atatus/normalizers/grape/endpoint_run.rb
+- lib/atatus/normalizers/rails.rb
+- lib/atatus/normalizers/rails/action_controller.rb
+- lib/atatus/normalizers/rails/action_mailer.rb
+- lib/atatus/normalizers/rails/action_view.rb
+- lib/atatus/normalizers/rails/active_record.rb
 - lib/atatus/opentracing.rb
 - lib/atatus/rails.rb
 - lib/atatus/railtie.rb
+- lib/atatus/resque.rb
+- lib/atatus/sinatra.rb
 - lib/atatus/span.rb
 - lib/atatus/span/context.rb
+- lib/atatus/span/context/db.rb
+- lib/atatus/span/context/destination.rb
+- lib/atatus/span/context/http.rb
 - lib/atatus/span_helpers.rb
 - lib/atatus/spies.rb
 - lib/atatus/spies/action_dispatch.rb
 - lib/atatus/spies/delayed_job.rb
+- lib/atatus/spies/dynamo_db.rb
 - lib/atatus/spies/elasticsearch.rb
 - lib/atatus/spies/faraday.rb
 - lib/atatus/spies/http.rb
@@ -131,23 +140,35 @@ files:
 - lib/atatus/spies/net_http.rb
 - lib/atatus/spies/rake.rb
 - lib/atatus/spies/redis.rb
+- lib/atatus/spies/resque.rb
 - lib/atatus/spies/sequel.rb
+- lib/atatus/spies/shoryuken.rb
 - lib/atatus/spies/sidekiq.rb
 - lib/atatus/spies/sinatra.rb
+- lib/atatus/spies/sneakers.rb
+- lib/atatus/spies/sucker_punch.rb
 - lib/atatus/spies/tilt.rb
+- lib/atatus/sql.rb
+- lib/atatus/sql/signature.rb
+- lib/atatus/sql/tokenizer.rb
+- lib/atatus/sql/tokens.rb
 - lib/atatus/sql_summarizer.rb
 - lib/atatus/stacktrace.rb
 - lib/atatus/stacktrace/frame.rb
 - lib/atatus/stacktrace_builder.rb
 - lib/atatus/subscriber.rb
 - lib/atatus/trace_context.rb
+- lib/atatus/trace_context/traceparent.rb
+- lib/atatus/trace_context/tracestate.rb
 - lib/atatus/transaction.rb
 - lib/atatus/transport/base.rb
 - lib/atatus/transport/connection.rb
 - lib/atatus/transport/connection/http.rb
 - lib/atatus/transport/connection/proxy_pipe.rb
 - lib/atatus/transport/filters.rb
+- lib/atatus/transport/filters/hash_sanitizer.rb
 - lib/atatus/transport/filters/secrets_filter.rb
+- lib/atatus/transport/headers.rb
 - lib/atatus/transport/serializers.rb
 - lib/atatus/transport/serializers/context_serializer.rb
 - lib/atatus/transport/serializers/error_serializer.rb
@@ -155,21 +176,20 @@ files:
 - lib/atatus/transport/serializers/metricset_serializer.rb
 - lib/atatus/transport/serializers/span_serializer.rb
 - lib/atatus/transport/serializers/transaction_serializer.rb
+- lib/atatus/transport/user_agent.rb
 - lib/atatus/transport/worker.rb
 - lib/atatus/util.rb
 - lib/atatus/util/inflector.rb
 - lib/atatus/util/lru_cache.rb
-- lib/atatus/util/prefixed_logger.rb
 - lib/atatus/util/throttle.rb
 - lib/atatus/version.rb
-- vendor/.gitkeep
 homepage: https://www.atatus.com
 licenses:
 - Atatus
 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
-post_install_message: 
+  documentation_uri: https://docs.atatus.com/docs/application-monitoring/ruby-agent/overview.html
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -185,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Atatus Ruby Agent
 test_files: []

data/Rakefile

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-
-Rake::Task[:release].enhance do
-  `git checkout 2.x &&
-  git rebase master &&
-  git push origin 2.x &&
-  git checkout master`
-end
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
-require 'yard'
-YARD::Rake::YardocTask.new
-task docs: :yard
-
-task default: :spec

data/bench/.gitignore

@@ -1,2 +0,0 @@
-tmp/*
-db/*

data/bench/app.rb

@@ -1,53 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
-require 'active_record'
-require 'action_controller/railtie'
-require 'atatus'
-require 'atatus/railtie'
-
-$log = Logger.new('/tmp/bench.log')
-
-ActiveRecord::Base.logger = $log
-
-ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: '/tmp/bench.sqlite3')
-
-ActiveRecord::Schema.define do
-  create_table :posts, force: true do |t|
-    t.string :title
-    t.timestamps
-  end
-end
-
-class Post < ActiveRecord::Base
-end
-
-10.times { |i| Post.create! title: "Post #{i}" }
-
-class ApplicationController < ActionController::Base
-  def index
-    render inline: '<%= Post.pluck(:title).join(", ") %>'
-  end
-
-  def favicon
-    render nothing: true
-  end
-end
-
-class App < Rails::Application
-  config.secret_key_base = '__secret'
-  config.logger = $log
-  config.eager_load = false
-
-  config.atatus.disable_send = true
-  config.atatus.logger = $log
-  config.atatus.log_level = Logger::DEBUG
-end
-
-App.initialize!
-
-App.routes.draw do
-  get '/favicon.ico', to: 'application#favicon'
-  root to: 'application#index'
-end

data/bench/benchmark.rb

@@ -1,36 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-ENV['RAILS_ENV'] = 'production'
-
-require 'bundler'
-require 'bundler/setup'
-
-require 'benchmark'
-include Benchmark
-require 'rack/test'
-
-require './bench/app'
-
-def app
-  App
-end
-
-include Rack::Test::Methods
-
-def perform
-  10_000.times do
-    get '/'
-  end
-end
-
-bench = Benchmark.benchmark(CAPTION, 15, FORMAT) do |b|
-  perform # warm up
-
-  b.report('with agent:') { perform }
-
-  Atatus.stop
-  perform # warm up
-
-  b.report('without agent:') { perform }
-end

data/bench/report.rb

@@ -1,55 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'time'
-require 'json'
-
-input = STDIN.read.split("\n")
-
-git_sha, git_msg = `git log -n 1 --pretty="format:%H|||%s"`.split('|||')
-git_date = `git log -n 1 --pretty="format:%ai"`
-platform = Gem::Platform.local
-
-def doc(payload)
-  puts({ index: { _index: "benchmark-ruby", _type: "_doc" } }.to_json)
-  puts(payload.to_json)
-end
-
-meta = {
-  executed_at: Time.new.iso8601,
-  'git.commit' => git_sha,
-  'git.date' => String(git_date).strip != '' && Time.parse(git_date).iso8601,
-  'git.subject' => git_msg,
-  hostname: `hostname`.chomp,
-  engine: RUBY_ENGINE,
-  arch: platform.cpu,
-  os: platform.os,
-  ruby_version: "#{RUBY_ENGINE == 'jruby' ? 'j' : ''}#{RUBY_VERSION}"
-}
-
-results =
-  input
-  .grep(/^with/)
-  .map do |line|
-    title = line.match(/^(.*):/) { |m| m[1] }
-    user, system, total, real = line.scan(/[0-9\.]+/).map(&:to_f)
-    meta.merge(
-      title: title,
-      user: user,
-      system: system,
-      total: total,
-      real: real,
-    )
-  end
-
-results.each { |result| doc result }
-
-overhead =
-  (results[0][:total] - results[1][:total]) *
-  1000 /  # milliseconds
-  10_000     # transactions
-
-doc meta.merge(
-  title: 'overhead',
-  overhead: overhead
-)

data/bench/rubyprof.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require 'ruby-prof'
-require 'rack/test'
-
-$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
-require 'atatus'
-
-require './bench/app'
-include App::Helpers
-
-def perform(app, count: 1000)
-  app.start
-
-  transactions = count.times.map do |i|
-    Atatus.transaction "Transaction##{i}",
-      context: Atatus.build_context(app.mock_env) do
-      Atatus.span('Number one') { 'ok 1' }
-      Atatus.span('Number two') { 'ok 2' }
-      Atatus.span('Number three') { 'ok 3' }
-    end
-  end
-
-  app.stop
-end
-
-def do_bench(transaction_count: 1000, **config)
-  with_app(config) do |app|
-    profile = RubyProf::Profile.new
-    profile.exclude_common_methods!
-    profile.start
-    perform(app, count: transaction_count)
-    profile.stop
-    printer = RubyProf::GraphHtmlPrinter.new(profile)
-    printer.print(File.open('bench/tmp/out.html', 'w'))
-  end
-end
-
-do_bench(transaction_count: 10_000)

data/bench/stackprof.rb

@@ -1,23 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'stackprof'
-require 'rack/test'
-
-require './bench/app'
-
-def app
-  App
-end
-
-include Rack::Test::Methods
-
-puts 'Running '
-profile = StackProf.run(mode: :cpu) do
-  10_000.times do
-    get '/'
-  end
-end
-puts ''
-
-StackProf::Report.new(profile).print_text

data/bin/build_docs

@@ -1,5 +0,0 @@
-#!/bin/bash
-set -ex
-
-# Requires atatus/docs to be checked out at ../docs
-../docs/build_docs.pl --doc docs/index.asciidoc --chunk 1

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'atatus'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/bin/with_framework

@@ -1,7 +0,0 @@
-#!/bin/bash -x
-set -e
-
-framework=$1
-
-FRAMEWORK=$framework bundle update
-FRAMEWORK=$framework ${@:2}