opentelemetry-instrumentation-faraday 0.13.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8a236bc8e651202a0ba61d6ff2a446df18c98a69ea6f4bb70cb8d96aa18114a
-  data.tar.gz: a388bbaa8b358608f3ae1e23ece5710fb8f22b3af751b20a0b42b83f9e80c479
+  metadata.gz: 1fc8cb22e262347bddd7169254357b2be3a1cf068156cdd2036b50bf4d14a2fa
+  data.tar.gz: b7055bd7f941783a377d0bb16782013756163bd6e02d9e05b56960f92f2faf00
 SHA512:
-  metadata.gz: b958c8095d852077ee57691e9326b7fe40db95b6334279e7b03762f682bb75a57e31d73035bdb0869d47285a208cf0f77f77a5832f0bbf9484b17d4c2b355c16
-  data.tar.gz: b767f78423709ca34d6ba9e9e3ed9f940f1ba742accb89eda0b67588aba1afb4a5f5046f3b6602f8eb847524039eb685fd2fe82dbfb129734cc040bc616fa220
+  metadata.gz: ce82235f722fbf3ee5e0d491080cfc78e1b16ea6ff078dd9a7a89ab63d2e53ed5a51885b849b9ef624bed2b044a8e7c31be59864a6687f708224158a8758f213
+  data.tar.gz: ab6e6d6933bb6bbb644f43004f03bab33c8e660e419a0438aa98b02fc27cfd6fd224ffaf43596e4adbe932309028f8d2a7bb70026d08a4c19f2b271910dbbdbd

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Release History: opentelemetry-instrumentation-faraday
 
+### v0.18.0 / 2021-05-21
+
+* ADDED: Updated API depedency for 1.0.0.rc1
+* FIXED: Removed http.status_text attribute #750
+
+### v0.17.0 / 2021-04-22
+
+* FIXED: Fix Faraday gem dependencies.
+* FIXED: Refactor propagators to add #fields
+
+### v0.16.0 / 2021-03-17
+
+* FIXED: Remove passwords from http.url
+* FIXED: Example scripts now reference local common lib
+* DOCS: Replace Gitter with GitHub Discussions
+
+### v0.15.0 / 2021-02-18
+
+* FIXED: Include http.status_text only if reason_phrase is in the response
+
+### v0.14.0 / 2021-02-03
+
+* BREAKING CHANGE: Replace getter and setter callables and remove rack specific propagators
+
+* ADDED: Replace getter and setter callables and remove rack specific propagators
+
 ### v0.13.0 / 2021-01-29
 
 * (No significant changes)
@@ -10,7 +36,7 @@
 
 ### v0.11.0 / 2020-12-11
 
-* FIXED: Copyright comments to not reference year 
+* FIXED: Copyright comments to not reference year
 
 ### v0.10.0 / 2020-12-03
 
@@ -18,9 +44,9 @@
 
 ### v0.9.0 / 2020-11-27
 
-* BREAKING CHANGE: Add timeout for force_flush and shutdown 
+* BREAKING CHANGE: Add timeout for force_flush and shutdown
 
-* ADDED: Add timeout for force_flush and shutdown 
+* ADDED: Add timeout for force_flush and shutdown
 
 ### v0.8.0 / 2020-10-27
 
@@ -28,8 +54,8 @@
 
 ### v0.7.0 / 2020-10-07
 
-* DOCS: Faraday documentation 
-* DOCS: Standardize toplevel docs structure and readme 
+* DOCS: Faraday documentation
+* DOCS: Standardize toplevel docs structure and readme
 
 ### v0.6.0 / 2020-09-10
 

data/README.md

@@ -38,7 +38,7 @@ Example usage of faraday can be seen in the `./example/faraday.rb` file [here](h
 
 The `opentelemetry-instrumentation-faraday` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
 
-The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
 
 ## License
 
@@ -50,4 +50,4 @@ Apache 2.0 license. See [LICENSE][license-github] for more information.
 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
-[ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

data/lib/opentelemetry/instrumentation/faraday.rb

@@ -5,6 +5,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 require 'opentelemetry'
+require 'opentelemetry-instrumentation-base'
 
 module OpenTelemetry
   module Instrumentation

data/lib/opentelemetry/instrumentation/faraday/instrumentation.rb

@@ -20,6 +20,8 @@ module OpenTelemetry
           defined?(::Faraday)
         end
 
+        option :peer_service, default: nil, validate: :string
+
         private
 
         def require_dependencies

data/lib/opentelemetry/instrumentation/faraday/middlewares/tracer_middleware.rb

@@ -25,16 +25,13 @@ module OpenTelemetry
 
           def call(env)
             http_method = HTTP_METHODS_SYMBOL_TO_STRING[env.method]
-
+            attributes = span_creation_attributes(
+              http_method: http_method, url: env.url
+            )
             tracer.in_span(
-              "HTTP #{http_method}",
-              attributes: {
-                'http.method' => http_method,
-                'http.url' => env.url.to_s
-              },
-              kind: :client
+              "HTTP #{http_method}", attributes: attributes, kind: :client
             ) do |span|
-              OpenTelemetry.propagation.http.inject(env.request_headers)
+              OpenTelemetry.propagation.inject(env.request_headers)
 
               app.call(env).on_complete { |resp| trace_response(span, resp) }
             end
@@ -44,13 +41,23 @@ module OpenTelemetry
 
           attr_reader :app
 
+          def span_creation_attributes(http_method:, url:)
+            instrumentation_attrs = {
+              'http.method' => http_method, 'http.url' => url.to_s
+            }
+            config = Faraday::Instrumentation.instance.config
+            instrumentation_attrs['peer.service'] = config[:peer_service] if config[:peer_service]
+            instrumentation_attrs.merge(
+              OpenTelemetry::Common::HTTP::ClientContext.attributes
+            )
+          end
+
           def tracer
             Faraday::Instrumentation.instance.tracer
           end
 
           def trace_response(span, response)
             span.set_attribute('http.status_code', response.status)
-            span.set_attribute('http.status_text', response.reason_phrase)
             span.status = OpenTelemetry::Trace::Status.http_to_status(
               response.status
             )

data/lib/opentelemetry/instrumentation/faraday/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Faraday
-      VERSION = '0.13.0'
+      VERSION = '0.18.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-faraday
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.18.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-30 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 1.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 1.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 1.0.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -186,10 +214,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-faraday/v0.13.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-faraday/v0.18.0/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/faraday
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-faraday/v0.13.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-faraday/v0.18.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -205,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Faraday instrumentation for the OpenTelemetry framework