newrelic-manticore 0.1.1.rc1-java → 1.0.2.pre-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b38c4ab104bc852c4ed3577ef140bb789d94b2c90dbc5eff9731f02b53c9b5c
-  data.tar.gz: fdc50f491ff45a927dd4f7e6c9de73082abcea07499924de32a254d12bbacbd7
+  metadata.gz: 1bf33579cc4d71ac85bdf3d6f36bc7cfc97891ebb4f2d55a1ad7c1c0a95d6fde
+  data.tar.gz: cbef564cdce00a60bb2fd6cd708335da9521ee6581733fa1bde75aaa1a5545b2
 SHA512:
-  metadata.gz: 73aad16695870625c6fe3d73264abe1e84c7d9b23d49bf6707bc20e4ec4d2a6f0fbcd2ba95cea354aeb790c7f23e3a9e8a2f7aaff33a78dd6e205716f362fbf8
-  data.tar.gz: ec437b319a31643f9851a1b27f79744cc74942deea6bf203fa07a2708c715c86c6fccf65abc4332db2c67412200bf4d41fd4b8f42e56108aed6cce5cb9cf4bd9
+  metadata.gz: 14e02510cd18b6a1f031a2617b1d8a5be2ea2c0bc49814f94f4cc033c7c174708bdc7614c6396eebbf8b8ad98bacd029d1651bd5c413330be87f4ee11cc0b3e9
+  data.tar.gz: 4c15d9b9d71de09831cf057e98e28c9e4e7a3776a53c5b5a578bd063db9c15b639a8fc6b0a7f92529cbab724c939a8bf9ef85008d4618b4bc075788e8e4e4e7b

data/.rubocop.yml

@@ -1,9 +1,12 @@
 require: rt_rubocop_defaults
 
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.4
 
 Metrics/BlockLength:
   Exclude:
     - test/**/*
 
+Metrics/ClassLength:
+  Exclude:
+    - test/**/*

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - jruby-9.1.17.0 # ruby 2.3
   - jruby-9.2.0.0 # ruby 2.5
 jobs:
   include:

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,69 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Changelog.md

@@ -4,6 +4,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+### Fixed
+- Added manticore as dependency
+
+## [1.0.1] - 2020-04-30
+### Added
+- Compatibility with agent versions ~> 6.10
+
+## [1.0.0] - 2019-03-12
+### Changed
+- Update newrelic agent dependency to major version 6.
+- Replace deprecated calls to internal agent API.
+
+## [0.1.2] - 2018-10-11
+### Fixed
+Detection whether manticore is used inside a database segment was not reliable and is now more robust
+
+## [0.1.1] - 2018-10-09
+### Fixed
+- Time spent inside Manticore requests inside database calls where not included in the exclusive time stats of the database request.
+- Fixed instrumentation when using manticore with faraday adapter.
+
 ## [0.1.0] - 2018-10-09
 ### Added
-Basic manticore instrumentation
+- Basic manticore instrumentation.

data/README.md

@@ -1,33 +1,54 @@
-[travis]: https://travis-ci.org/runtastic/newrelic-manticore
-[rubygems]: https://rubygems.org/gems/newrelic-manticore
-[manticore]: https://gitlab.com/cheald/manticore
-[mit]: http://opensource.org/licenses/MIT
-[cc]: http://contributor-covenant.org
-
-# NewrelicManticore
+# Newrelic-Manticore
 
-[![Build Status](https://travis-ci.org/runtastic/newrelic-manticore.svg?branch=master)][travis] [![Gem Version](https://badge.fury.io/rb/newrelic-manticore.svg)][rubygems]
+[![Build Status](https://travis-ci.org/runtastic/newrelic-manticore.svg?branch=master)][travis]
+[![Gem Version](https://badge.fury.io/rb/newrelic-manticore.svg)][rubygems]
 
 Adds NewRelic instrumentation for the [Manticore JRuby HTTP client][manticore].
 
 ## Installation
 Add this line to your application's Gemfile:
 
-`$ gem 'newrelic-manticore'`
+```ruby
+gem 'newrelic-manticore'
+```
 
 And then execute:
 
-`$ bundle`
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install newrelic-manticore
+
+## Usage
 
-## How it works
 When `newrelic/manticore` is required (e.g. automatically by Bundler), the gem becomes active.
-It hooks itself into `Manticore::Client#request` and traces your HTTP calls as external requests,
+It wraps `Manticore::Response#call` and traces your HTTP calls as external requests,
 adding also the necessary headers for cross application tracing.
 
+### What about parallel requests?
+The NewRelic agent is currently not set up to support multithreaded requests. As [any of the other client integrations](https://docs.newrelic.com/docs/agents/ruby-agent/features/http-client-tracing-ruby#typhoeus),
+_newrelic-manticore_ will trace all parallel requests as [one external service call](https://github.com/runtastic/newrelic-manticore/blob/master/test/new_relic/manticore/instrumentation_test.rb#L50).
+
+### What about async "background" requests?
+Those are traced normally as any other request would be.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
 ## Contributing
 Bug reports and pull requests are welcome on GitHub at https://github.com/runtastic/newrelic-manticore.
-This project is intended to be a safe, welcoming space for collaboration, and contributors are expected
-to adhere to the [Contributor Covenant code of conduct][cc].
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [code of conduct][cc].
 
 ## License
 The gem is available as open source under [the terms of the MIT License][mit].
+
+[travis]: https://travis-ci.org/runtastic/newrelic-manticore
+[rubygems]: https://rubygems.org/gems/newrelic-manticore
+[manticore]: https://gitlab.com/cheald/manticore
+[mit]: http://opensource.org/licenses/MIT
+[cc]: ../CODE_OF_CONDUCT.md

data/lib/new_relic/manticore/instrumentation.rb

@@ -3,13 +3,30 @@
 require "ostruct"
 
 require "new_relic/agent/method_tracer"
-require "new_relic/agent/http_clients/abstract_request"
 
 require "new_relic/manticore/wrapped_request"
 require "new_relic/manticore/wrapped_response"
 
 module NewRelic
   module Manticore
+    # We do not want to create a segment if there is no newrelic
+    # transaction or if we are inside a database segment.
+    #
+    # An external call segment inside a database segment would
+    # deduct the time needed in manticore from the database call,
+    # which we want to be the total time needed for the database
+    # operation
+    def self.create_segment?
+      state = NewRelic::Agent::TransactionState.tl_get
+      return false unless state&.current_transaction
+
+      return true unless state.current_transaction.current_segment
+
+      !state.current_transaction.current_segment.is_a?(
+        ::NewRelic::Agent::Transaction::DatastoreSegment
+      )
+    end
+
     # rubocop:disable Metrics/BlockLength
     DependencyDetection.defer do
       @name = :manticore
@@ -31,38 +48,49 @@ module NewRelic
         )
 
         ::Manticore::Client.class_eval do
+          # This is called for parallel requests that are executed in
+          # a batch
+          #
+          # rubocop:disable Metrics/MethodLength
           def execute_with_newrelic_trace!
-            segment = NewRelic::Agent::External.start_segment(
-              library: "Manticore",
-              uri: @async_requests.first.request.uri.to_s,
-              procedure: "Parallel batch"
-            )
-            segment.add_request_headers(PARALLEL_REQUEST_DUMMY)
+            if NewRelic::Manticore.create_segment?
+              segment = NewRelic::Agent::External.start_segment(
+                library:   "Manticore",
+                uri:       @async_requests.first.request.uri.to_s,
+                procedure: "Parallel batch"
+              )
+              segment.add_request_headers(PARALLEL_REQUEST_DUMMY)
+            end
             execute_without_newrelic_trace!
           ensure
-            segment.finish if segment
+            segment.finish if defined?(segment) && segment
           end
+          # rubocop:enable Metrics/MethodLength
 
           alias_method :execute_without_newrelic_trace!, :execute!
           alias_method :execute!, :execute_with_newrelic_trace!
         end
 
         ::Manticore::Response.class_eval do
+          # This is called for every request, also parallel and async
+          # requests.
+          #
           # rubocop:disable Metrics/MethodLength
           def call_with_newrelic_trace
-            segment = create_newrelic_segment
-
-            segment.add_request_headers(WrappedRequest.new(@request))
-            on_complete do |response|
-              begin
-                segment.read_response_headers(WrappedResponse.new(response))
-              ensure
-                segment.finish
+            if NewRelic::Manticore.create_segment?
+              segment = create_newrelic_segment
+              segment.add_request_headers(WrappedRequest.new(@request))
+              on_complete do |response|
+                begin
+                  segment.read_response_headers(WrappedResponse.new(response))
+                ensure
+                  segment.finish
+                end
               end
             end
             call_without_newrelic_trace
           rescue StandardError => e
-            segment.finish if segment
+            segment.finish if defined?(segment) && segment
             raise e
           end
           # rubocop:enable Metrics/MethodLength
@@ -71,9 +99,9 @@ module NewRelic
           alias_method :call, :call_with_newrelic_trace
 
           def create_newrelic_segment
-            NewRelic::Agent::External.start_segment(
-              library: "Manticore",
-              uri: @request.uri.to_s,
+            NewRelic::Agent::Tracer.start_external_request_segment(
+              library:   "Manticore",
+              uri:       @request.uri.to_s,
               procedure: @request.method
             ).tap do |segment|
               segment.record_metrics = false if segment.parent.is_a?(::NewRelic::Agent::Transaction::DatastoreSegment)

data/lib/new_relic/manticore/wrapped_request.rb

@@ -1,3 +1,14 @@
+# frozen_string_literal: true
+
+# Check version to account for a breaking path change
+# introduced in 6.10
+#
+if NewRelic::VERSION::MAJOR == 6 && NewRelic::VERSION::MINOR < 10
+  require "new_relic/agent/http_clients/abstract_request"
+else
+  require "new_relic/agent/http_clients/abstract"
+end
+
 module NewRelic
   module Manticore
     class WrappedRequest < Agent::HTTPClients::AbstractRequest

data/lib/new_relic/manticore/wrapped_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NewRelic
   module Manticore
     class WrappedResponse

data/lib/newrelic/manticore.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 # Necessary for bundler auto require (as gem name does not match namespace)
 require "new_relic/manticore"

data/lib/newrelic/manticore/version.rb

@@ -2,6 +2,6 @@
 
 module Newrelic
   module Manticore
-    VERSION = "0.1.1.rc1".freeze
+    VERSION = "1.0.2.pre"
   end
 end

data/newrelic-manticore.gemspec

@@ -27,9 +27,10 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^exe/}) { |f| File.basename(f) }
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency     "newrelic_rpm", "~> 5"
+  gem.add_runtime_dependency     "newrelic_rpm", "~> 6"
+  gem.add_runtime_dependency     "manticore", "~> 0.6", ">= 0.6.4"
 
-  gem.add_development_dependency "bundler", "~> 1.13"
+  gem.add_development_dependency "bundler"
   gem.add_development_dependency "faraday", "~> 0"
   gem.add_development_dependency "manticore", "~> 0"
   gem.add_development_dependency "minitest"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newrelic-manticore
 version: !ruby/object:Gem::Version
-  version: 0.1.1.rc1
+  version: 1.0.2.pre
 platform: java
 authors:
 - Dominik Goltermann
@@ -9,36 +9,56 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-10-11 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   name: newrelic_rpm
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
-  name: bundler
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+  name: manticore
+  type: :runtime
   prerelease: false
-  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: bundler
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -46,8 +66,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: faraday
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -60,8 +80,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: manticore
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -74,8 +94,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: minitest
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -88,8 +108,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: pry
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -102,8 +122,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
   name: rake
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -116,8 +136,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
   name: rspec
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -130,8 +150,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
   name: rt_rubocop_defaults
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -144,8 +164,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2'
   name: rubocop_runner
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -163,6 +183,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CODE_OF_CONDUCT.md
 - Changelog.md
 - Gemfile
 - LICENSE
@@ -196,8 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.13
+rubygems_version: 3.0.6
 signing_key:
 specification_version: 4
 summary: Newrelic support for manticore