faraday-aws-xray 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ebb77f5272e90edc60a5d0845c4f1b0ca43ec2b190083f017947c45ed898b2fa
+  data.tar.gz: 2021b7a4e9302c4f63d8cef8ecb0e5efeecd55b4fe85f3b767cf68b4e48adc5a
+SHA512:
+  metadata.gz: b44716e1b2e184167a4d3f80b1a6a2c9a34eb5f8f16ee8cdc4b330efd9385b0f33e311f61332dba4f8c57c8ce15617a24c385c8c4cc5ed6cb453bae29faca5ca
+  data.tar.gz: 65a1744144bc36b8f18276a09868d776b5a6a8653012cdd6254933f27587fffa921568ee1bc63081db5be4f8e92f6189aa08ce865eb8e1154238b73db6ed6b5a

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## Unreleased
+
+*   Initial release.

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jay Zeschin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Faraday AWS X-Ray Middleware
+
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/jayzes/faraday-aws-xray/ci)](https://github.com/jayzes/faraday-aws-xray/actions?query=branch%3Amain)
+[![Gem](https://img.shields.io/gem/v/faraday-aws-xray.svg?style=flat-square)](https://rubygems.org/gems/faraday-aws-xray)
+[![License](https://img.shields.io/github/license/jayzes/faraday-aws-xray.svg?style=flat-square)](LICENSE.md)
+
+Faraday 2+ middleware to instrument spans for [AWS X-Ray](https://aws.amazon.com/xray/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday-aws-xray'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install faraday-aws-xray
+```
+
+## Usage
+
+```ruby
+require 'faraday/aws/xray'
+```
+
+Then wherever you configure your Faraday connection, add the middleware:
+
+```ruby
+Faraday.new(...) do |conn|
+  conn.use Faraday::Aws::XRay::Middleware
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+Then, run `bin/test` to run the tests.
+
+To install this gem onto your local machine, run `rake build`.
+
+To release a new version, make a commit with a message such as "Bumped to 0.0.2" and then run `rake release`.
+See how it works [here](https://bundler.io/guides/creating_gem.html#releasing-the-gem).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/ajayzes/faraday-aws-xray/faraday-aws-xray).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/faraday/aws/xray/middleware.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faraday
+  module Aws
+    module XRay
+      class Middleware < Faraday::Middleware
+        def initialize(app, options = {})
+          super(app)
+          @name = options[:name] || 'external_http_request'
+        end
+
+        def call(env)
+          ::XRay.recorder.capture(@name) do |_segment|
+            ::XRay.recorder.capture(env.url.to_s) do |subsegment|
+              add_request_data(subsegment, env)
+
+              response = @app.call(env)
+
+              add_response_data(subsegment, response)
+              response
+            end
+          end
+        end
+
+        private
+
+        def add_request_data(subsegment, env)
+          subsegment.merge_http_request(
+            request: {
+              method: env.method.to_s.upcase,
+              url: env.url.to_s,
+              user_agent: env.request_headers['User-Agent']
+            }
+          )
+        end
+
+        def add_response_data(subsegment, response)
+          subsegment.merge_http_response(
+            response: {
+              status: response.status,
+              content_length: response.headers['Content-Length']
+            }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/faraday/aws/xray/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Faraday
+  module Aws
+    module XRay
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/faraday/aws/xray.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'aws-xray-sdk'
+require_relative 'xray/middleware'
+require_relative 'xray/version'
+
+module Faraday
+  # This will be your middleware main module, though the actual middleware implementation will go
+  # into Faraday::Aws::Xray::Middleware for the correct namespacing.
+  module Aws
+    module XRay
+      # Faraday allows you to register your middleware for easier configuration.
+      # This step is totally optional, but it basically allows users to use a
+      # custom symbol (in this case, `:xray`), to use your middleware in their connections.
+      # After calling this line, the following are both valid ways to set the middleware in a connection:
+      # * conn.use Faraday::Aws::Xray::Middleware
+      # * conn.use :xray
+      # Without this line, only the former method is valid.
+      Faraday::Middleware.register_middleware(xray: Faraday::Aws::XRay::Middleware)
+
+      # Alternatively, you can register your middleware under Faraday::Request or Faraday::Response.
+      # This will allow to load your middleware using the `request` or `response` methods respectively.
+      #
+      # Load middleware with conn.request :xray
+      # Faraday::Request.register_middleware(xray: Faraday::Aws::Xray::Middleware)
+      #
+      # Load middleware with conn.response :xray
+      # Faraday::Response.register_middleware(xray: Faraday::Aws::Xray::Middleware)
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: faraday-aws-xray
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jay Zeschin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-xray-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: 'Faraday middleware to instrument spans for AWS X-Ray.
+
+  '
+email:
+- jay@zeschin.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/faraday/aws/xray.rb
+- lib/faraday/aws/xray/middleware.rb
+- lib/faraday/aws/xray/version.rb
+homepage: https://github.com/ajayzes/faraday-aws-xray/faraday-aws-xray
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/ajayzes/faraday-aws-xray/faraday-aws-xray/issues
+  changelog_uri: https://github.com/ajayzes/faraday-aws-xray/faraday-aws-xray/blob/v0.1.0/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-aws-xray/0.1.0
+  homepage_uri: https://github.com/ajayzes/faraday-aws-xray/faraday-aws-xray
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/ajayzes/faraday-aws-xray/faraday-aws-xray
+  wiki_uri: https://github.com/ajayzes/faraday-aws-xray/faraday-aws-xray/wiki
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Faraday middleware to instrument spans for AWS X-Ray
+test_files: []