epsagon 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 036b9458b78db168edb2cb90dd4898f812eaa81a3e057abd69fc073fef9552d2
-  data.tar.gz: 1b2b2dce82f55073377db72400737a1243f8dab08426780d59f6a5faf62a2a13
+  metadata.gz: 87955008fa3a72eef9788a33b27ea5b1b803f05f5b4576980cbfcde82f418b8f
+  data.tar.gz: 8f55c3de860ad268786aac29fc6d132d60aaf3314858de5b7a396700a8e6b57c
 SHA512:
-  metadata.gz: 5bbbc9237c61ad7eb0818803eea213ed8b1003210b199c3c29355f1536b6dc4b7e990b628b92b8c015f4fab1c623eb92f07352d6c6cb5b6a00d0aeb12aa0dfc8
-  data.tar.gz: 81da4b0e55ecd53569564c22cfe1a986dce0835970bf3a522a7bc100e5b5a6c373275c6ac2bccd9d0a4500dddb8c26dca54d402d499116fa90201ba8de5edef5
+  metadata.gz: c75902bf40adc989654cafad809e2cfac0a9dbba506981a3f52be29868fad8ba77691580bbae616fe793a3fb47e0ef4070d822cb659ae186ba1af86016ecd0a8
+  data.tar.gz: 7eaf1f961154c97d106bf0ec95d763bbdb049783bbcafb08abe2ff9f685a4ab17f77282b483e42d2a06bf07ef588ab9d346b66a074355141a1f13f5a6f104190

data/lib/epsagon.rb

@@ -12,31 +12,65 @@ require_relative 'util'
 
 Bundler.require
 
-def metadata_only?
-  ENV['EPSAGON_METADATA']&.to_s&.downcase != 'false'
-end
+# Epsagon tracing main entry point
+module Epsagon
+  module_function
 
-def debug?
-  ENV['EPSAGON_DEBUG']&.to_s&.downcase == 'true'
-end
+  def init(**args)
+    defaults = {
+      metadata_only: ENV['EPSAGON_METADATA']&.to_s&.downcase != 'false',
+      debug: ENV['EPSAGON_DEBUG']&.to_s&.downcase == 'true',
+      token: ENV['EPSAGON_TOKEN'],
+      app_name: ENV['EPSAGON_APP_NAME'],
+      backend: ENV['EPSAGON_BACKEND'] || 'localhost:55681/v1/trace'
+    }
+    @@epsagon_config = defaults.merge(args)
+  end
+
+  def metadata_only?
+    ENV['EPSAGON_METADATA']&.to_s&.downcase != 'false'
+  end
+
+  def debug?
+    ENV['EPSAGON_DEBUG']&.to_s&.downcase == 'true'
+  end
 
-# #config opentelemetry with epsaon extensions:
-OpenTelemetry::SDK.configure do |c|
-  c.use 'EpsagonSinatraInstrumentation'
-  c.use 'EpsagonNetHTTPInstrumentation'
-  c.use 'EpsagonFaradayInstrumentation'
-  if ENV['EPSAGON_BACKEND']
-    c.add_span_processor OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(
-      OpenTelemetry::Exporter::OTLP::Exporter.new(headers: {
-                            epasgon_token: ENV['EPSAGON_TOKEN'],
-                            epasgon_app_name: ENV['EPSAGON_APP_NAME']
-                          },
-                          endpoint: ENV['EPSAGON_BACKEND'],
-                          insecure: false)
+  # config opentelemetry with epsaon extensions:
+
+  def epsagon_confs(configurator)
+    configurator.resource = OpenTelemetry::SDK::Resources::Resource.telemetry_sdk.merge(
+      OpenTelemetry::SDK::Resources::Resource.create({ 'application' => ENV['EPSAGON_APP_NAME'] })
+    )
+    configurator.use 'EpsagonSinatraInstrumentation', { epsagon: @@epsagon_config }
+    configurator.use 'EpsagonNetHTTPInstrumentation', { epsagon: @@epsagon_config }
+    configurator.use 'EpsagonFaradayInstrumentation', { epsagon: @@epsagon_config }
+    # if ENV['EPSAGON_BACKEND']
+    configurator.add_span_processor OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
+      exporter: OpenTelemetry::Exporter::OTLP::Exporter.new(headers: {
+                                                    'x-epsagon-token' => @@epsagon_config[:token]
+                                                  },
+                                                  endpoint: @@epsagon_config[:backend],
+                                                  insecure: @@epsagon_config[:insecure] || false)
     )
-  else
-    c.add_span_processor OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(
+    return unless debug?
+
+    configurator.add_span_processor OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(
       OpenTelemetry::SDK::Trace::Export::ConsoleSpanExporter.new
     )
   end
+
+  OpenTelemetry::SDK.configure
+end
+
+# monkey patch to include epsagon confs
+module OpenTelemetry
+  # monkey patch inner SDK module
+  module SDK
+    def self.configure
+      super do |c|
+        yield c if block_given?
+        Epsagon.epsagon_confs c
+      end
+    end
+  end
 end

data/lib/instrumentation/aws_sdk.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require_relative '../util'
+
+# AWS SDK plugin for epsagon instrumentation
+class EpsagonAwsPlugin < Seahorse::Client::Plugin
+  def add_handlers(handlers, _)
+    handlers.add(EpsagonAwsHandler, step: :validate)
+  end
+end
+
+# Generates Spans for all uses of AWS SDK
+class EpsagonAwsHandler < Seahorse::Client::Handler
+  def call(context)
+    span_name = "AWS #{context[:service_name]}"
+    tracer.in_span(span_name) do |span|
+      @handler.call(context).tap do
+        span.set_attribute('aws.command', context[:command])
+        span.set_attribute('aws.status_code', context[:status_code])
+      end
+    end
+  end
+
+  def tracer
+    EpsagonAwsSdkInstrumentation.instance.tracer
+  end
+end
+
+# AWS SDK epsagon instrumentation
+class EpsagonAwsSdkInstrumentation < OpenTelemetry::Instrumentation::Base
+  VERSION = '0.0.0'
+  SERVICES = %w[
+    ACM
+    APIGateway
+    AppStream
+    ApplicationAutoScaling
+    ApplicationDiscoveryService
+    Athena
+    AutoScaling
+    Batch
+    Budgets
+    CloudDirectory
+    CloudFormation
+    CloudFront
+    CloudHSM
+    CloudHSMV2
+    CloudSearch
+    CloudSearchDomain
+    CloudTrail
+    CloudWatch
+    CloudWatchEvents
+    CloudWatchLogs
+    CodeBuild
+    CodeCommit
+    CodeDeploy
+    CodePipeline
+    CodeStar
+    CognitoIdentity
+    CognitoIdentityProvider
+    CognitoSync
+    ConfigService
+    CostandUsageReportService
+    DAX
+    DataPipeline
+    DatabaseMigrationService
+    DeviceFarm
+    DirectConnect
+    DirectoryService
+    DynamoDB
+    DynamoDBStreams
+    EC2
+    ECR
+    ECS
+    EFS
+    EMR
+    ElastiCache
+    ElasticBeanstalk
+    ElasticLoadBalancing
+    ElasticLoadBalancingV2
+    ElasticTranscoder
+    ElasticsearchService
+    EventBridge
+    Firehose
+    GameLift
+    Glacier
+    Glue
+    Greengrass
+    Health
+    IAM
+    ImportExport
+    Inspector
+    IoT
+    IoTDataPlane
+    KMS
+    Kinesis
+    KinesisAnalytics
+    Lambda
+    LambdaPreview
+    Lex
+    LexModelBuildingService
+    Lightsail
+    MTurk
+    MachineLearning
+    MarketplaceCommerceAnalytics
+    MarketplaceEntitlementService
+    MarketplaceMetering
+    MigrationHub
+    Mobile
+    OpsWorks
+    OpsWorksCM
+    Organizations
+    Pinpoint
+    Polly
+    RDS
+    Redshift
+    Rekognition
+    ResourceGroupsTaggingAPI
+    Route53
+    Route53Domains
+    S3
+    SES
+    SMS
+    SNS
+    SQS
+    SSM
+    STS
+    SWF
+    ServiceCatalog
+    Shield
+    SimpleDB
+    Snowball
+    States
+    StorageGateway
+    Support
+    Textract
+    WAF
+    WAFRegional
+    WorkDocs
+    WorkSpaces
+    XRay
+  ].freeze
+
+  install do |_|
+    ::Seahorse::Client::Base.add_plugin(EpsagonAwsPlugin)
+    loaded_constants.each { |klass| klass.add_plugin(EpsagonAwsPlugin) }
+  end
+
+  present do
+    defined?(::Seahorse::Client::Base)
+  end
+
+  private
+
+  def loaded_constants
+    # Cross-check services against loaded AWS constants
+    # Module#const_get can return a constant from ancestors when there's a miss.
+    # If this conincidentally matches another constant, it will attempt to patch
+    # the wrong constant, resulting in patch failure.
+    available_services = ::Aws.constants & SERVICES.map(&:to_sym)
+
+    available_services.each_with_object([]) do |service, constants|
+      next if ::Aws.autoload?(service)
+
+      begin
+        constants << ::Aws.const_get(service, false).const_get(:Client, false)
+      rescue StandardError
+        next
+      end
+    end
+  end
+end

data/lib/instrumentation/faraday.rb

@@ -3,7 +3,12 @@
 require 'faraday'
 require_relative '../util'
 
+# Faraday middleware for epsagon instrumentaton
 class EpsagonFaradayMiddleware < ::Faraday::Middleware
+  def config
+    EpsagonFaradayInstrumentation.instance.config
+  end
+
   HTTP_METHODS_SYMBOL_TO_STRING = {
     connect: 'CONNECT',
     delete: 'DELETE',
@@ -27,7 +32,7 @@ class EpsagonFaradayMiddleware < ::Faraday::Middleware
       'http.request.path' => path
     }
 
-    unless metadata_only?
+    unless config[:epsagon][:metadata_only]
       attributes.merge!(Util.epsagon_query_attributes(env.url.query))
       attributes.merge!({
                           'http.request.path_params' => path_params,
@@ -59,7 +64,7 @@ class EpsagonFaradayMiddleware < ::Faraday::Middleware
   def trace_response(span, response)
     span.set_attribute('http.status_code', response.status)
 
-    unless metadata_only?
+    unless config[:epsagon][:metadata_only]
       span.set_attribute('http.response.headers', response.headers.to_json)
       span.set_attribute('http.response.body', response.body)
     end
@@ -69,6 +74,7 @@ class EpsagonFaradayMiddleware < ::Faraday::Middleware
   end
 end
 
+# Patch faraday to include middleware
 module EpsagonFaradayPatch
   def adapter(*args)
     use(:epsagon_open_telemetry) unless @handlers.any? do |handler|
@@ -79,12 +85,15 @@ module EpsagonFaradayPatch
   end
 end
 
+# Faraday epsagon instrumentaton
 class EpsagonFaradayInstrumentation < OpenTelemetry::Instrumentation::Base
+  VERSION = '0.0.0'
+
   install do |_config|
     ::Faraday::Middleware.register_middleware(
       epsagon_open_telemetry: EpsagonFaradayMiddleware
     )
-    ::Faraday::RackBuilder.prepend(EpsagonFaradayPatch)
+    ::Faraday::RackBuilder.include(EpsagonFaradayPatch)
   end
 
   present do

data/lib/instrumentation/net_http.rb

@@ -4,10 +4,15 @@ require 'opentelemetry'
 
 require_relative '../util'
 
+# Net::HTTP patch for epsagon instrumentaton
 module EpsagonNetHTTPExtension
   HTTP_METHODS_TO_SPAN_NAMES = Hash.new { |h, k| h[k] = "HTTP #{k}" }
   USE_SSL_TO_SCHEME = { false => 'http', true => 'https' }.freeze
 
+  def config
+    EpsagonNetHTTPInstrumentation.instance.config
+  end
+
   def request(req, body = nil, &block)
     # Do not trace recursive call for starting the connection
     return super(req, body, &block) unless started?
@@ -22,7 +27,7 @@ module EpsagonNetHTTPExtension
                         'http.request.path' => path
                       })
 
-    unless metadata_only?
+    unless config[:epsagon][:metadata_only]
       headers = Hash[req.each_header.to_a]
       attributes.merge!({
                           'http.request.path_params' => path_params,
@@ -53,7 +58,7 @@ module EpsagonNetHTTPExtension
     status_code = response.code.to_i
 
     span.set_attribute('http.status_code', status_code)
-    unless metadata_only?
+    unless config[:epsagon][:metadata_only]
       span.set_attribute('http.response.headers', Hash[response.each_header.to_a].to_json)
       span.set_attribute('http.response.body', response.body)
     end
@@ -67,7 +72,10 @@ module EpsagonNetHTTPExtension
   end
 end
 
+# Net::HTTP epsagon instrumentaton
 class EpsagonNetHTTPInstrumentation < OpenTelemetry::Instrumentation::Base
+  VERSION = '0.0.0'
+
   install do |_|
     ::Net::HTTP.prepend(EpsagonNetHTTPExtension)
   end

data/lib/instrumentation/sinatra.rb

@@ -5,11 +5,16 @@ require 'opentelemetry'
 
 require_relative '../util'
 
+# Sinatra middleware for epsagon instrumentation
 class EpsagonTracerMiddleware
   def initialize(app)
     @app = app
   end
 
+  def config
+    EpsagonSinatraInstrumentation.instance.config
+  end
+
   def call(env)
     request = Rack::Request.new(env)
     path, path_params = request.path.split(';')
@@ -27,7 +32,7 @@ class EpsagonTracerMiddleware
       'http.request.headers' => request_headers
     }
 
-    unless metadata_only?
+    unless config[:epsagon][:metadata_only]
       request.body.rewind
       request_body = request.body.read
       request.body.rewind
@@ -68,7 +73,7 @@ class EpsagonTracerMiddleware
   def trace_response(http_span, framework_span, env, resp)
     status, headers, response_body = resp
 
-    unless metadata_only?
+    unless config[:epsagon][:metadata_only]
       http_span.set_attribute('http.response.headers', JSON.generate(headers))
       http_span.set_attribute('http.response.body', response_body.join)
     end
@@ -79,6 +84,7 @@ class EpsagonTracerMiddleware
   end
 end
 
+# Sinatra extension for epsagon instrumentation
 module EpsagonTracerExtension
   # Sinatra hook after extension is registered
   def self.registered(app)
@@ -100,7 +106,10 @@ module EpsagonTracerExtension
   end
 end
 
+# Sinatra epsagon instrumentation
 class EpsagonSinatraInstrumentation < OpenTelemetry::Instrumentation::Base
+  VERSION = '0.0.0'
+
   install do |_|
     ::Sinatra::Base.register EpsagonTracerExtension
   end

data/lib/util.rb

@@ -2,6 +2,7 @@
 
 require 'cgi'
 
+# Utilities for epsagon opentelemetry solution
 module Util
   def self.epsagon_query_attributes(query_string)
     if query_string&.include? '='

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epsagon
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Assaf Paneth
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-06 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies: []
 description: Epsagon for ruby
 email: assaf.paneth@gmail.com
@@ -18,6 +18,7 @@ extra_rdoc_files: []
 files:
 - lib/epsagon.rb
 - lib/epsagon_opentelemetry.rb
+- lib/instrumentation/aws_sdk.rb
 - lib/instrumentation/faraday.rb
 - lib/instrumentation/net_http.rb
 - lib/instrumentation/sinatra.rb
@@ -32,9 +33,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="