appoptics_apm 4.3.1 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 460a1905104ca068b80627a06b31c7c7aeae3e1da872a97c261aa86e675ae7b2
-  data.tar.gz: 4810bf515e2af6c0f685061b34574ef0ba223e79eeae8b99d0f9697e3399b522
+  metadata.gz: f55957c02fb447084c8430a6dff438ce8ff3725f1eaf755e1c0f9092f94360b0
+  data.tar.gz: 02a24b754db042ec253cefb0160217bb9d136a2ad360916630bc4413007b3786
 SHA512:
-  metadata.gz: 4e6fa6323f8b61c4bf2f294858c749585ba02c22d991bc042f9b3c9047f77b4df78027f575408c2cba917921d6bba9e809374ca8bad66da3ef0bfa4e3279003c
-  data.tar.gz: 4b6f2524b9ac853bf3e36f926409bea3966e6501340de454a471f60d6a3159d2df0e481ff2c9eb03f68c3b59d2ed4b270003b7576e5b81b17733adb020995582
+  metadata.gz: ed5020f576a5ebc447bdfad639140373670cdc30ff50e5c8b379bdd3c1fab74b764eea21ef3f0e3a5670152f64daa07db6b08bf291bb0468ece448fc4f7f1399
+  data.tar.gz: f0d5f73b872b8d869b3308aff1180447f2a46f48039afa84f0ce8a43a2e06bdcaeb13fbca95453c9cc80988f93a85c1c534882b963e528ed0904195b6d75edb0

data/.yardopts

@@ -1,3 +1,4 @@
 --no-private
 --readme yardoc_frontpage.md
-lib/appoptics_apm/sdk.rb
+lib/appoptics_apm/sdk/tracing.rb
+lib/appoptics_apm/sdk/custom_metrics.rb

data/README.md

@@ -61,10 +61,10 @@ The appoptics_apm gem provides a Rails generator used to seed an initializer whe
 To run the install generator run:
 
 ```bash
-bundle exec rails generate appoptics:install
+bundle exec rails generate appoptics_apm:install
 ```
 
-After the prompts, this will create an initializer: `config/initializers/appoptics.rb`.
+After the prompts, this will create an initializer: `config/initializers/appoptics_apm.rb`.
 
 ## Sinatra
 

data/appoptics_apm.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{https://www.appoptics.com/}
   s.summary = %q{AppOptics APM performance instrumentation gem for Ruby}
   s.description = <<-EOF
-     The appoptics_apm gem provides automatic tracing and metrics for Ruby applications. Get started at appoptics.com. @AppOptics
+Automatic tracing and metrics for Ruby applications. Get started at appoptics.com. @AppOptics
   EOF
 
   s.metadata = {

data/ext/oboe_metal/src/VERSION

@@ -1 +1 @@
-3.2.0
+3.3.0

data/lib/appoptics_apm/api.rb

@@ -10,9 +10,11 @@ module AppOpticsAPM
     extend AppOpticsAPM::API::LayerInit
     extend AppOpticsAPM::API::Util
 
-    require_relative './sdk'
+    require_relative './sdk/tracing'
+    require_relative './sdk/custom_metrics'
 
     extend AppOpticsAPM::SDK::Tracing
+    extend AppOpticsAPM::SDK::CustomMetrics
     extend AppOpticsAPM::API::Tracing
   end
 end

data/lib/appoptics_apm/config.rb

@@ -71,12 +71,19 @@ module AppOpticsAPM
     # Oboe will override vars passed in if it finds an environment variable
     # :debug_level and :verbose need special consideration, because they are used in Ruby
     def self.check_env_vars
-      unless (0..6).include?(AppOpticsAPM::Config[:debug_level])
-        AppOpticsAPM::Config[:debug_level] = nil
+      unless (-1..6).include?(AppOpticsAPM::Config[:debug_level])
+        AppOpticsAPM::Config[:debug_level] = 3
+      end
+
+      # let's find and use the  equivalent debug level for ruby
+      debug_level = ENV['APPOPTICS_DEBUG_LEVEL'] ? ENV['APPOPTICS_DEBUG_LEVEL'].to_i : AppOpticsAPM::Config[:debug_level]
+      if debug_level < 0
+        # there should be no logging if APPOPTICS_DEBUG_LEVEL == -1
+        # In Ruby level 5 is UNKNOWN and it can log, but level 6 is quiet
+        AppOpticsAPM.logger.level = 6
+      else
+        AppOpticsAPM.logger.level = [4 - debug_level, 0].max
       end
-      # let's use the same debug level for ruby as well
-      debug_level = ENV['APPOPTICS_DEBUG_LEVEL'] || AppOpticsAPM::Config[:debug_level] || 3
-      AppOpticsAPM.logger.level = [4 - debug_level.to_i, 0].max
 
       # the verbose setting is only relevant for ruby, ENV['APPOPTICS_GEM_VERBOSE'] overrides
       if ENV.key?('APPOPTICS_GEM_VERBOSE')

data/lib/appoptics_apm/inst/grpc_client.rb

@@ -37,7 +37,7 @@ module AppOpticsAPM
 
       def server_streamer_with_appoptics(req, metadata: {}, &blk)
         @tags = grpc_tags('SERVER_STREAMING', metadata[:method] || metadata_to_send[:method])
-        AppOpticsAPM::API.log_entry('grpc_client', @tags)
+        AppOpticsAPM::API.log_entry('grpc-client', @tags)
         metadata['x-trace'] = AppOpticsAPM::Context.toString if AppOpticsAPM::Context.isValid
         AppOpticsAPM::SDK.set_transaction_name(metadata[:method]) if AppOpticsAPM.transaction_name.nil?
 
@@ -49,15 +49,15 @@ module AppOpticsAPM
         # this check is needed because the exception may have been logged in patch_receive_and_check_status
         unless e.instance_variable_get(:@exn_logged)
           context_from_incoming
-          AppOpticsAPM::API.log_exception('grpc_client', e)
-          AppOpticsAPM::API.log_exit('grpc_client', exit_tags(@tags))
+          AppOpticsAPM::API.log_exception('grpc-client', e)
+          AppOpticsAPM::API.log_exit('grpc-client', exit_tags(@tags))
         end
         raise e
       end
 
       def bidi_streamer_with_appoptics(req, metadata: {}, &blk)
         @tags = grpc_tags('BIDI_STREAMING', metadata[:method] || metadata_to_send[:method])
-        AppOpticsAPM::API.log_entry('grpc_client', @tags)
+        AppOpticsAPM::API.log_entry('grpc-client', @tags)
         metadata['x-trace'] = AppOpticsAPM::Context.toString if AppOpticsAPM::Context.isValid
         AppOpticsAPM::SDK.set_transaction_name(metadata[:method]) if AppOpticsAPM.transaction_name.nil?
 
@@ -68,8 +68,8 @@ module AppOpticsAPM
       rescue => e
         unless e.instance_variable_get(:@exn_logged)
           context_from_incoming
-          AppOpticsAPM::API.log_exception('grpc_client', e)
-          AppOpticsAPM::API.log_exit('grpc_client', exit_tags(@tags))
+          AppOpticsAPM::API.log_exception('grpc-client', e)
+          AppOpticsAPM::API.log_exit('grpc-client', exit_tags(@tags))
         end
         raise e
       end
@@ -78,7 +78,7 @@ module AppOpticsAPM
 
       def unary_response(req, type: , metadata: , without:)
         tags = grpc_tags(type, metadata[:method] || metadata_to_send[:method])
-        AppOpticsAPM::SDK.trace('grpc_client', tags) do
+        AppOpticsAPM::SDK.trace('grpc-client', tags) do
           metadata['x-trace'] = AppOpticsAPM::Context.toString  if AppOpticsAPM::Context.isValid
           AppOpticsAPM::SDK.set_transaction_name(metadata[:method]) if AppOpticsAPM.transaction_name.nil?
           begin
@@ -96,10 +96,10 @@ module AppOpticsAPM
           context_from_incoming
         rescue => e
           context_from_incoming
-          AppOpticsAPM::API.log_exception('grpc_client', e)
+          AppOpticsAPM::API.log_exception('grpc-client', e)
           raise e
         ensure
-          AppOpticsAPM::API.log_exit('grpc_client', exit_tags(@tags))
+          AppOpticsAPM::API.log_exit('grpc-client', exit_tags(@tags))
         end
       end
 
@@ -109,9 +109,9 @@ module AppOpticsAPM
           return if status.nil?
           context_from_incoming
           if status.code > 0
-            AppOpticsAPM::API.log_exception('grpc_client', $!)
+            AppOpticsAPM::API.log_exception('grpc-client', $!)
           end
-          AppOpticsAPM::API.log_exit('grpc_client', exit_tags(@tags))
+          AppOpticsAPM::API.log_exit('grpc-client', exit_tags(@tags))
           super
         end
       end

data/lib/appoptics_apm/sdk/custom_metrics.rb

@@ -0,0 +1,92 @@
+#--
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+#++
+
+module AppOpticsAPM
+  module SDK
+
+    module CustomMetrics
+
+      # Send counts
+      #
+      # Use this method to report the number of times an action occurs. The metric counts reported are summed and flushed every 60 seconds.
+      #
+      # === Arguments:
+      #
+      # * +name+          (String) Name to be used for the metric. Must be 255 or fewer characters and consist only of A-Za-z0-9.:-*
+      # * +count+         (Integer, optional, default = 1): Count of actions being reported
+      # * +with_hostname+ (Boolean, optional, default = false): Indicates if the host name should be included as a tag for the metric
+      # * +tags_kvs+      (Hash, optional): List of key/value pairs to describe the metric. The key must be <= 64 characters, the value must be <= 255 characters, allowed characters: A-Za-z0-9.:-_
+      #
+      # === Example:
+      #
+      #   class WorkTracker
+      #     def counting(name, tags = {})
+      #       yield # yield to where work is done
+      #       AppOpticsAPM::SDK.increment_metric(name, 1, false, tags)
+      #     end
+      #   end
+      #
+      # === Returns:
+      # * true on success, false on failure
+      #
+      def increment_metric(name, count = 1, with_hostname = false, tags_kvs = {})
+        with_hostname = with_hostname ? 1 : 0
+        tags, tags_count = make_tags(tags_kvs)
+        AppOpticsAPM::CustomMetrics.increment(name.to_s, count, with_hostname, nil, tags, tags_count) == 1
+      end
+
+      # Send values with counts
+      #
+      # Use this method to report a value for each or multiple counts. The metric values reported are aggregated and flushed every 60 seconds. The dashboard displays the average value per count.
+      #
+      # === Arguments:
+      #
+      # * +name+          (String) Name to be used for the metric. Must be 255 or fewer characters and consist only of A-Za-z0-9.:-*
+      # * +value+         (Numeric) Value to be added to the current sum
+      # * +count+         (Integer, optional, default = 1): Count of actions being reported
+      # * +with_hostname+ (Boolean, optional, default = false): Indicates if the host name should be included as a tag for the metric
+      # * +tags_kvs+      (Hash, optional): List of key/value pairs to describe the metric. The key must be <= 64 characters, the value must be <= 255 characters, allowed characters: A-Za-z0-9.:-_
+      #
+      # === Example:
+      #
+      #   class WorkTracker
+      #     def timing(name, tags = {})
+      #       start = Time.now
+      #       yield # yield to where work is done
+      #       duration = Time.now - start
+      #       AppOpticsAPM::SDK.increment_metric(name, duration, 1, false, tags)
+      #     end
+      #   end
+      #
+      # === Returns:
+      # * true on success, false on failure
+      #
+      def summary_metric(name, value, count = 1, with_hostname = false, tags_kvs = {})
+        with_hostname = with_hostname ? 1 : 0
+        tags, tags_count = make_tags(tags_kvs)
+        AppOpticsAPM::CustomMetrics.summary(name.to_s, value, count, with_hostname, nil, tags, tags_count) == 1
+      end
+
+      private
+
+      def make_tags(tags_kvs)
+        unless tags_kvs.is_a?(Hash)
+          AppOpticsAPM.logger.warn("[appoptics_apm/metrics] CustomMetrics received tags_kvs that are not a Hash (found #{tags_kvs.class}), setting tags_kvs = {}")
+          tags_kvs = {}
+        end
+        count = tags_kvs.size
+        tags = AppOpticsAPM::MetricTags.new(count)
+
+        tags_kvs.each_with_index do |(k, v), i|
+          tags.add(i, k.to_s, v.to_s)
+        end
+
+        [tags, count]
+      end
+    end
+
+    extend CustomMetrics
+  end
+end

data/lib/appoptics_apm/{sdk.rb → sdk/tracing.rb}

@@ -127,7 +127,7 @@ module AppOpticsAPM
       #   end
       #
       #   def handle_request_with_appoptics(request, response)
-      #     start_trace('custom_trace', nil, :TransactionName => 'handle_request') do
+      #     AppOpticsAPM::SDK.start_trace('custom_trace', nil, :TransactionName => 'handle_request') do
       #       handle_request(request, response)
       #     end
       #   end
@@ -161,7 +161,7 @@ module AppOpticsAPM
       #   end
       #
       #   def handle_request_with_appoptics(request, response)
-      #     start_trace_with_target('rails', request['X-Trace'], response) do
+      #     AppOpticsAPM::SDK.start_trace_with_target('rails', request['X-Trace'], response) do
       #       handle_request(request, response)
       #     end
       #   end
@@ -307,5 +307,6 @@ module AppOpticsAPM
     end
 
     extend Tracing
+
   end
 end

data/lib/appoptics_apm/version.rb

@@ -7,8 +7,8 @@ module AppOpticsAPM
   # appoptics_apm.gemspec during gem build process
   module Version
     MAJOR = 4
-    MINOR = 3
-    PATCH = 1
+    MINOR = 4
+    PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

data/lib/rails/generators/appoptics_apm/templates/appoptics_apm_initializer.rb

@@ -27,17 +27,17 @@ if defined?(AppOpticsAPM::Config)
 
   #
   # Set APPOPTICS_DEBUG_LEVEL
-  # This Setting will be overridden if APPOPTICS_DEBUG_LEVEL is set as an environment variable
+  # This setting will be overridden if APPOPTICS_DEBUG_LEVEL is set as an environment variable.
   #
   # It sets the log level and takes the following values:
-  ## 0 fatal, 1 error, 2 warning, 3 info (the default), 4 debug low, 5 debug medium, 6 debug high.
-  #
+  # -1 disabled, 0 fatal, 1 error, 2 warning, 3 info (the default), 4 debug low, 5 debug medium, 6 debug high.
+  # Values < -1 or > 6 will set the log level to the default (info).
   #
   AppOpticsAPM::Config[:debug_level] = 3
   #
   # :debug_level will be used in the c-extension of the gem and also mapped to the
-  # Ruby logger as FATAL, ERROR, WARN, INFO, or DEBUG
-  # The Ruby logger can afterwards be changed to a different level as follows:
+  # Ruby logger as DISABLED, FATAL, ERROR, WARN, INFO, or DEBUG
+  # The Ruby logger can afterwards be changed to a different level, e.g:
   # AppOpticsAPM.logger.level = Logger::INFO
 
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appoptics_apm
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 4.4.0
 platform: ruby
 authors:
 - Maia Engeli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2018-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -116,8 +116,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
-description: "     The appoptics_apm gem provides automatic tracing and metrics for
-  Ruby applications. Get started at appoptics.com. @AppOptics\n"
+description: 'Automatic tracing and metrics for Ruby applications. Get started at
+  appoptics.com. @AppOptics
+
+'
 email: support@appoptics.com
 executables:
 - appoptics_apm_config
@@ -216,7 +218,8 @@ files:
 - lib/appoptics_apm/noop/README.md
 - lib/appoptics_apm/noop/context.rb
 - lib/appoptics_apm/ruby.rb
-- lib/appoptics_apm/sdk.rb
+- lib/appoptics_apm/sdk/custom_metrics.rb
+- lib/appoptics_apm/sdk/tracing.rb
 - lib/appoptics_apm/support.rb
 - lib/appoptics_apm/test.rb
 - lib/appoptics_apm/thread_local.rb