ls-trace 0.1.1

data/lib/ddtrace/contrib/grape/ext.rb

@@ -0,0 +1,19 @@
+module Datadog
+  module Contrib
+    module Grape
+      # Grape integration constants
+      module Ext
+        APP = 'grape'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_GRAPE_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_GRAPE_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'grape'.freeze
+        SPAN_ENDPOINT_RENDER = 'grape.endpoint_render'.freeze
+        SPAN_ENDPOINT_RUN = 'grape.endpoint_run'.freeze
+        SPAN_ENDPOINT_RUN_FILTERS = 'grape.endpoint_run_filters'.freeze
+        TAG_FILTER_TYPE = 'grape.filter.type'.freeze
+        TAG_ROUTE_ENDPOINT = 'grape.route.endpoint'.freeze
+        TAG_ROUTE_PATH = 'grape.route.path'.freeze
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/grape/instrumentation.rb

@@ -0,0 +1,33 @@
+module Datadog
+  module Contrib
+    module Grape
+      # Instrumentation for Grape::Endpoint
+      module Instrumentation
+        def self.included(base)
+          base.singleton_class.send(:prepend, ClassMethods)
+          base.send(:prepend, InstanceMethods)
+        end
+
+        # ClassMethods - implementing instrumentation
+        module ClassMethods
+          def generate_api_method(*params, &block)
+            method_api = super
+
+            proc do |*args|
+              ::ActiveSupport::Notifications.instrument('endpoint_render.grape.start_render')
+              method_api.call(*args)
+            end
+          end
+        end
+
+        # InstanceMethods - implementing instrumentation
+        module InstanceMethods
+          def run(*args)
+            ::ActiveSupport::Notifications.instrument('endpoint_run.grape.start_process')
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/grape/integration.rb

@@ -0,0 +1,36 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/grape/configuration/settings'
+require 'ddtrace/contrib/grape/patcher'
+
+module Datadog
+  module Contrib
+    module Grape
+      # Description of Grape integration
+      class Integration
+        include Contrib::Integration
+
+        register_as :grape, auto_patch: true
+
+        def self.version
+          Gem.loaded_specs['grape'] && Gem.loaded_specs['grape'].version
+        end
+
+        def self.present?
+          super && defined?(::Grape)
+        end
+
+        def self.compatible?
+          super && defined?(::ActiveSupport::Notifications)
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/grape/patcher.rb

@@ -0,0 +1,79 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/ext/app_types'
+
+require 'ddtrace/contrib/grape/ext'
+require 'ddtrace/contrib/grape/endpoint'
+require 'ddtrace/contrib/grape/instrumentation'
+
+module Datadog
+  module Contrib
+    module Grape
+      # Patcher enables patching of 'grape' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def patched?
+          done?(:grape)
+        end
+
+        def patch
+          do_once(:grape) do
+            begin
+              # Patch endpoints
+              ::Grape::Endpoint.send(:include, Instrumentation)
+
+              add_pin!
+
+              # Subscribe to ActiveSupport events
+              Datadog::Contrib::Grape::Endpoint.subscribe
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply Grape integration: #{e}")
+            end
+          end
+        end
+
+        def add_pin!
+          # Attach a Pin object globally and set the service once
+          pin = DeprecatedPin.new(
+            get_option(:service_name),
+            app: Ext::APP,
+            app_type: Datadog::Ext::AppTypes::WEB,
+            tracer: get_option(:tracer)
+          )
+          pin.onto(::Grape)
+        end
+
+        def get_option(option)
+          Datadog.configuration[:grape].get_option(option)
+        end
+
+        # Implementation of deprecated Pin, which raises warnings when accessed.
+        # To be removed when support for Datadog::Pin with Grape is removed.
+        class DeprecatedPin < Datadog::Pin
+          include Datadog::DeprecatedPin
+
+          DEPRECATION_WARNING = %(
+            Use of Datadog::Pin with Grape is DEPRECATED.
+            Upgrade to the configuration API using the migration guide here:
+            https://github.com/DataDog/dd-trace-rb/releases/tag/v0.11.0).freeze
+
+          def tracer=(tracer)
+            Datadog.configuration[:grape][:tracer] = tracer
+          end
+
+          def service_name=(service_name)
+            Datadog.configuration[:grape][:service_name] = service_name
+          end
+
+          def log_deprecation_warning(method_name)
+            do_once(method_name) do
+              Datadog::Tracer.log.warn("#{method_name}:#{DEPRECATION_WARNING}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/graphql/configuration/settings.rb

@@ -0,0 +1,27 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/graphql/ext'
+
+module Datadog
+  module Contrib
+    module GraphQL
+      module Configuration
+        # Custom settings for the GraphQL integration
+        class Settings < Contrib::Configuration::Settings
+          option :analytics_enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, nil) }
+            o.lazy
+          end
+
+          option :analytics_sample_rate do |o|
+            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.lazy
+          end
+
+          option :schemas
+          option :service_name, default: Ext::SERVICE_NAME
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/graphql/ext.rb

@@ -0,0 +1,13 @@
+module Datadog
+  module Contrib
+    module GraphQL
+      # GraphQL integration constants
+      module Ext
+        APP = 'ruby-graphql'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_GRAPHQL_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_GRAPHQL_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'ruby-graphql'.freeze
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/graphql/integration.rb

@@ -0,0 +1,38 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/graphql/configuration/settings'
+require 'ddtrace/contrib/graphql/patcher'
+
+module Datadog
+  module Contrib
+    module GraphQL
+      # Description of GraphQL integration
+      class Integration
+        include Contrib::Integration
+
+        register_as :graphql, auto_patch: true
+
+        def self.version
+          Gem.loaded_specs['graphql'] && Gem.loaded_specs['graphql'].version
+        end
+
+        def self.present?
+          super && defined?(::GraphQL)
+        end
+
+        def self.compatible?
+          super \
+            && defined?(::GraphQL::Tracing::DataDogTracing) \
+            && version >= Gem::Version.new('1.7.9')
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/graphql/patcher.rb

@@ -0,0 +1,63 @@
+require 'ddtrace/contrib/patcher'
+
+module Datadog
+  module Contrib
+    module GraphQL
+      # Provides instrumentation for `graphql` through the GraphQL tracing framework
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def patched?
+          done?(:graphql)
+        end
+
+        def patch
+          return if get_option(:schemas).nil?
+
+          do_once(:graphql) do
+            begin
+              require 'ddtrace/ext/app_types'
+              require 'ddtrace/ext/http'
+              get_option(:schemas).each { |s| patch_schema!(s) }
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply GraphQL integration: #{e}")
+            end
+          end
+        end
+
+        def patch_schema!(schema)
+          tracer = get_option(:tracer)
+          service_name = get_option(:service_name)
+          analytics_enabled = Contrib::Analytics.enabled?(get_option(:analytics_enabled))
+          analytics_sample_rate = get_option(:analytics_sample_rate)
+
+          if schema.respond_to?(:use)
+            schema.use(
+              ::GraphQL::Tracing::DataDogTracing,
+              tracer: tracer,
+              service: service_name,
+              analytics_enabled: analytics_enabled,
+              analytics_sample_rate: analytics_sample_rate
+            )
+          else
+            schema.define do
+              use(
+                ::GraphQL::Tracing::DataDogTracing,
+                tracer: tracer,
+                service: service_name,
+                analytics_enabled: analytics_enabled,
+                analytics_sample_rate: analytics_sample_rate
+              )
+            end
+          end
+        end
+
+        def get_option(option)
+          Datadog.configuration[:graphql].get_option(option)
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/grpc/configuration/settings.rb

@@ -0,0 +1,25 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/grpc/ext'
+
+module Datadog
+  module Contrib
+    module GRPC
+      module Configuration
+        # Custom settings for the gRPC integration
+        class Settings < Contrib::Configuration::Settings
+          option :analytics_enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+            o.lazy
+          end
+
+          option :analytics_sample_rate do |o|
+            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.lazy
+          end
+
+          option :service_name, default: Ext::SERVICE_NAME
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/grpc/datadog_interceptor.rb

@@ -0,0 +1,74 @@
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/grpc/ext'
+
+module Datadog
+  module Contrib
+    module GRPC
+      # :nodoc:
+      module DatadogInterceptor
+        # :nodoc:
+        class Base < ::GRPC::Interceptor
+          attr_accessor :datadog_pin
+
+          def initialize(options = {})
+            add_datadog_pin! { |c| yield(c) if block_given? }
+          end
+
+          def request_response(**keywords)
+            trace(keywords) { yield }
+          end
+
+          def client_streamer(**keywords)
+            trace(keywords) { yield }
+          end
+
+          def server_streamer(**keywords)
+            trace(keywords) { yield }
+          end
+
+          def bidi_streamer(**keywords)
+            trace(keywords) { yield }
+          end
+
+          private
+
+          def add_datadog_pin!
+            Pin.new(
+              service_name,
+              app: Ext::APP,
+              app_type: Datadog::Ext::AppTypes::WEB,
+              tracer: tracer
+            ).tap do |pin|
+              yield(pin) if block_given?
+              pin.onto(self)
+            end
+          end
+
+          def datadog_configuration
+            Datadog.configuration[:grpc]
+          end
+
+          def tracer
+            (datadog_pin && datadog_pin.tracer) || datadog_configuration[:tracer]
+          end
+
+          def service_name
+            (datadog_pin && datadog_pin.service_name) || datadog_configuration[:service_name]
+          end
+
+          def analytics_enabled?
+            Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+          end
+
+          def analytics_sample_rate
+            datadog_configuration[:analytics_sample_rate]
+          end
+        end
+
+        require_relative 'datadog_interceptor/client'
+        require_relative 'datadog_interceptor/server'
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/grpc/datadog_interceptor/client.rb

@@ -0,0 +1,56 @@
+require 'ddtrace/ext/http'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/grpc/ext'
+
+module Datadog
+  module Contrib
+    module GRPC
+      module DatadogInterceptor
+        # The DatadogInterceptor::Client implements the tracing strategy
+        # for gRPC client-side endpoitns. This middleware compoent will
+        # inject trace context information into gRPC metadata prior to
+        # sending the request to the server.
+        class Client < Base
+          def trace(keywords)
+            keywords[:metadata] ||= {}
+
+            options = {
+              span_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
+              service: service_name,
+              resource: format_resource(keywords[:method])
+            }
+
+            tracer.trace(Ext::SPAN_CLIENT, options) do |span|
+              annotate!(span, keywords[:metadata])
+
+              yield
+            end
+          end
+
+          private
+
+          def annotate!(span, metadata)
+            metadata.each do |header, value|
+              span.set_tag(header, value)
+            end
+
+            # Set analytics sample rate
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
+            Datadog::GRPCPropagator
+              .inject!(span.context, metadata)
+          rescue StandardError => e
+            Datadog::Tracer.log.debug("GRPC client trace failed: #{e}")
+          end
+
+          def format_resource(proto_method)
+            proto_method.downcase
+                        .split('/')
+                        .reject(&:empty?)
+                        .join('.')
+          end
+        end
+      end
+    end
+  end
+end