signalfx-tracing 1.2.0 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70e37568d76b69c20af72f6e4a439028e568da24
+  data.tar.gz: 0c88d1c7bc2f4c57b1a0f8dca466957015521e2d
+SHA512:
+  metadata.gz: dc46b65b0ed79229223ea58013e2700d7f6b91d16f044812d3fcafb30699f60bc28751a308aa1ea39c4491b93766508a355c3b4b2cf31d777d9b7a1eb32cd951
+  data.tar.gz: 9abac060656963f07e8d6eb83022c429ba86410e7e743418057b967cab5f236f1a595f0e07eb92c66672a3ebfc2c2de5273487a0c58a6ba7e45c347cd711d984

data/README.md

@@ -135,6 +135,7 @@ When interfacing with these web servers as a Rack application, please configure
 | [Mongo](#mongo)                     | >= 2.1.0           |
 | [Mysql2](#mysql2)                   | >= 0.4.0           |
 | [Net::HTTP](#nethttp)               | Ruby >= 2.0        |
+| [Pg](#pg)                           | >= 0.18.0          |
 | [Rack](#rack)                       | >= 0.1             |
 | [Rails](#rails)                     | >= 3.0.0           |
 | [Redis](#redis)                     | >= 4.0.0           |
@@ -330,6 +331,24 @@ end
 
 An optional `tracer` named argument can be provided to use a custom tracer. It will default to `OpenTracing.global_tracer` if not provided.
 
+## Pg
+
+Pg instrumentation traces all queries performed with the pg client.
+
+The source for this instrumentation is located [here](https://github.com/signalfx/ruby-pg-instrumentation)
+
+### Usage
+
+```bash
+$ # install the instrumentation if not done previously
+$ sfx-rb-trace-bootstrap -i pg
+```
+
+```ruby
+SignalFx::Tracing::Instrumenter.configure do |p|
+    p.instrument(:pg)
+end
+```
 ## Rack
 
 Rack spans are created using the `rack-tracer` gem. This is enabled
@@ -512,3 +531,19 @@ SignalFx::Tracing::Instrumenter.configure do |p|
 end
 ```
 
+## Configuring the Logger
+
+The logger, based on the [Ruby Logger](https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html), can be configured by setting the following environment variables:
+
+| Environmental Variable Name   | Description           |  Default             |
+|:------------------------------|:----------------------|:-------------------- |
+| `SIGNALFX_LOG_PATH`           | The path to the desired file where the instrumentation logs will be written. Besides customized paths, output options also include `STDOUT` and `STDERR`.| `/var/log/signalfx/signalfx-ruby-tracing.log` |
+| `SIGNALFX_LOG_SHIFT_AGE`      | The desired number of old log files to keep, or frequency of rotation. Options include: `daily`, `weekly` or `monthly`)  | `0`    |
+| `SIGNALFX_LOG_SHIFT_SIZE`     | The desired maximum size of log files (this only applies when. A new one would be created when the maximum is reached. | `1048576` (1 MB)  |
+| `SIGNALFX_LOG_LEVEL`          | The severity criteria for recording logs (from least to most severe). Options: `debug`, `info`, `warn`, `error`, `fatal`, `unknown`  | `warn` |
+
+More information regarding the logging configuration may be found [here](https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html).
+
+**NB**: 
+- If the default path for `SIGNALFX_LOG_PATH` (that is, `/var/log/signalfx/signalfx-ruby-tracing.log`) is to be used, then please create the directory and or file (if necessary) and grant the relevant access permissions to the instrumentation user process.
+If there are permission issues, the instrumentation will default to logging to the standard error (STDERR) handle, until the path is provided to which logs can be written without any access issues.

data/bin/sfx-rb-trace-bootstrap

@@ -11,6 +11,7 @@ instrumentations = {
   "mongodb" => ["mongodb-instrumentation", "~> 0.1.1"],
   "mysql2" => ["mysql2-instrumentation", "~> 0.2.1"],
   "nethttp" => ["nethttp-instrumentation", "~> 0.1.2"],
+  "pg" => ["pg-instrumentation", "~> 0.1.0"],
   "rack" => ["rack-tracer", { git: 'git://github.com/signalfx/ruby-rack-tracer.git', branch: 'sfx_release' }],
   "rails" => ["rails-instrumentation", "~> 0.1.3"],
   "redis" => ["redis-instrumentation", "~> 0.1.1"],

data/gem.deps.rb

@@ -4,6 +4,7 @@ group :instrumentations do
   gem 'mongodb-instrumentation', '~> 0.1.1'
   gem 'mysql2-instrumentation', '~> 0.2.1'
   gem 'nethttp-instrumentation', '~> 0.1.2'
+  gem 'pg-instrumentation',  '~> 0.1.0'
   gem 'rack-tracer', git: 'git://github.com/signalfx/ruby-rack-tracer.git', branch: 'sfx_release'
   gem 'rails-instrumentation', '0.1.3'
   gem 'redis-instrumentation', '~> 0.1.1'

data/lib/signalfx/tracing/instrumentation/pg.rb

@@ -0,0 +1,41 @@
+require_relative '../sfx_logger'
+
+module SignalFx
+  module Tracing
+    module Instrumenter
+      module PG
+
+        @logger = Logging.logger
+        @logger.debug('SFx pg-instrumentation') { "Initializing instrumentation ..." }
+
+        Register.add_lib :PG, self
+
+        class << self
+
+          def instrument(opts = {})
+            return if @instrumented
+
+            # check for required gems
+            begin
+              require 'pg'
+            rescue LoadError
+              return
+            end
+
+            begin
+              require 'pg/instrumentation'
+            rescue LoadError => e
+              @logger.error { e.message }
+              return
+            end
+
+            tracer = opts.fetch(:tracer, OpenTracing.global_tracer)
+
+            ::PG::Instrumentation.instrument(tracer: tracer) if !@instrumented
+            @instrumented = true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/signalfx/tracing/register.rb

@@ -43,3 +43,4 @@ require 'signalfx/tracing/instrumentation/redis'
 require 'signalfx/tracing/instrumentation/sequel'
 require 'signalfx/tracing/instrumentation/grape'
 require 'signalfx/tracing/instrumentation/sidekiq'
+require 'signalfx/tracing/instrumentation/pg'

data/lib/signalfx/tracing/sfx_logger.rb

@@ -0,0 +1,57 @@
+require 'logger'
+
+module SignalFx
+  module Tracing
+    module Logging
+
+      LOG_LEVELS = {
+          'unknown' => Logger::UNKNOWN,
+          'fatal' => Logger::FATAL,
+          'error' => Logger::ERROR,
+          'warn' => Logger::WARN,
+          'info' => Logger::INFO,
+          'debug' => Logger::DEBUG
+      }.freeze
+
+      DEFAULT_LOG_PATH = '/var/log/signalfx/signalfx-ruby-tracing.log'
+      DEFAULT_SHIFT_AGE = 5
+      DEFAULT_SHIFT_SIZE = 1048576
+
+      def self.create (log_path = ENV['SIGNALFX_LOG_PATH'] || DEFAULT_LOG_PATH,
+                       sfx_shift_age = ENV['SIGNALFX_LOG_SHIFT_AGE'] || DEFAULT_SHIFT_AGE,
+                       sfx_shift_size = ENV['SIGNALFX_LOG_SHIFT_SIZE'] || DEFAULT_SHIFT_SIZE)
+
+        if log_path.upcase == 'STDOUT'
+          @logger = Logger.new(STDOUT)
+        elsif log_path.upcase == 'STDERR'
+          self.create_stderr_logger()
+        else
+          begin
+            @logger = Logger.new("#{log_path}", shift_age = sfx_shift_age, shift_size = sfx_shift_size)
+          rescue Errno::EACCES, Errno::ENOENT => e
+            self.create_stderr_logger(log_path, e)
+          end
+        end
+
+        log_level = ENV['SIGNALFX_LOG_LEVEL'].downcase if ENV['SIGNALFX_LOG_LEVEL']
+        @logger.level = LOG_LEVELS.fetch(log_level, Logger::WARN)
+        @logger.datetime_format = '%Y-%m-%d %H:%M:%S'
+        @logger.formatter = proc do | severity, datetime, progname, msg |
+          "#{datetime}, #{severity}: #{msg} --- #{progname} \n"
+        end
+        @logger
+      end
+
+      def self.logger
+        @logger ||= self.create
+      end
+
+      def self.create_stderr_logger(logpath=nil, error=nil)
+        @logger = Logger.new(STDERR)
+        if error
+          @logger.error { "LOG FILE ACCESS ERROR:\n*** Failed to write to '#{logpath}': #{error.message}\n--> Please manually create the required resources and/or grant relevant access permissions to this user process.\n*** Defaulting to sending log statements to the standard error (STDERR) handle.\n"}
+        end
+      end
+    end
+  end
+end

data/lib/signalfx/tracing/version.rb

@@ -1,5 +1,5 @@
 module Signalfx
   module Tracing
-    VERSION = "1.2.0"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,94 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: signalfx-tracing
 version: !ruby/object:Gem::Version
-  version: 1.2.0
-  prerelease: 
+  version: 1.3.0
 platform: ruby
 authors:
 - SignalFx, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
+date: 2020-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: opentracing
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: jaeger-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: nethttp-instrumentation
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.2
 description: 
@@ -99,7 +88,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -118,6 +107,7 @@ files:
 - lib/signalfx/tracing/instrumentation/mysql2.rb
 - lib/signalfx/tracing/instrumentation/net_http.rb
 - lib/signalfx/tracing/instrumentation/patching-test.rb
+- lib/signalfx/tracing/instrumentation/pg.rb
 - lib/signalfx/tracing/instrumentation/rack.rb
 - lib/signalfx/tracing/instrumentation/rails.rb
 - lib/signalfx/tracing/instrumentation/redis.rb
@@ -127,32 +117,32 @@ files:
 - lib/signalfx/tracing/instrumentation/sinatra.rb
 - lib/signalfx/tracing/register.rb
 - lib/signalfx/tracing/reporter/auto_reviving_async_reporter.rb
+- lib/signalfx/tracing/sfx_logger.rb
 - lib/signalfx/tracing/tracer.rb
 - lib/signalfx/tracing/version.rb
 - signalfx-tracing.gemspec
 homepage: https://github.com/signalfx/signalfx-ruby-tracing
 licenses:
 - Apache-2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.5.2.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Auto-instrumentation framework for Ruby
 test_files: []