minato-trace 0.1.6.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c5da6d0d800d5e45a03a0f95ae3419aa3aa25a4084429f47066533149981aa96
+  data.tar.gz: 802469a563d427bed67e8d099d6215b2952d731ced4a4f735ec56a36dee3a12b
+SHA512:
+  metadata.gz: 85ebba3c8575ec517768aadce56dce393031f6defb30ef3e7b282ad5529e0c20bf3acc6e44441e329229149a95ab965708f427e5f351aab739d25de48d014669
+  data.tar.gz: eac532b05dc3c7f86e53b6dc4c7f81d1cb23c80537a26b42a2ba8c0b93d0cb6d3cc3fb662d5f16b824b6d593b3f8dfddb0c55c9f3959c0b655e55ef40fb6c7b0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2024 TODO: Write your name
+
+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,41 @@
+# Minato::Trace
+Add support to [Google Cloud Trace](https://cloud.google.com/trace) to your Minato Rails Application.
+
+## Usage
+Install this gem and your application will be abble to send trace information to Google Cloud Trace for any request. To configure distributed trace with other microservices see [Configuring distributed trace](#configuring-distributed-trace)
+
+## Integration with Google Cloud Logging
+For integration with [Google Cloud Logging](https://cloud.google.com/logging?hl=en) you have to install [minato-logger-rails](https://gitlab.com/ferreri/minato/minato-logger-rails) v0.1.12+.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "minato-trace"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install minato-trace
+```
+## Configuring distributed trace
+To configure distributed trace with others services, put this config into the service config file:
+
+Add to service SDK initializer config file:
+config/initializers/{service_name}.rb
+```ruby
+{ServiceClass}.configure do |config|
+  config.use Minato::Trace::Middleware::DistributedTraceContext
+end
+```
+
+## Changelog
+Changelog information could be found [here](CHANGELOG.md).
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/minato/trace/middleware/distributed_trace_context.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Minato
+  module Trace
+    module Middleware
+      class DistributedTraceContext
+        TRACE_HEADER_KEY = "X-Cloud-Trace-Context"
+
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          add_trace_context_header(env)
+
+          @app.call(env)
+        end
+
+        private
+
+        def add_trace_context_header(env)
+          return unless Rails.env.production?
+
+          env.request_headers.merge!({ "#{TRACE_HEADER_KEY}": "#{current_cloud_trace.trace.trace_id};o=1" })
+        end
+
+        def current_cloud_trace
+          @current_cloud_trace ||= current_trace_from_google_cloud
+        end
+
+        def current_trace_from_google_cloud
+          _trace_client = Google::Cloud::Trace.new
+          Google::Cloud::Trace.get
+        end
+      end
+    end
+  end
+end

data/lib/minato/trace/middleware.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "minato/trace/middleware/distributed_trace_context"
+
+module Minato
+  module Trace
+    module Middleware
+    end
+  end
+end

data/lib/minato/trace/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Minato
+  module Trace
+    class Railtie < ::Rails::Railtie
+      initializer "minato_trace_setup",
+                  before: "load_environment_config" do
+        Minato::Trace.init
+      end
+    end
+  end
+end

data/lib/minato/trace/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Minato
+  module Trace
+    VERSION = "0.1.6-1"
+  end
+end

data/lib/minato/trace.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "minato/trace/version"
+require "minato/trace/railtie"
+require "minato/trace/middleware"
+require "stackdriver"
+
+module Minato
+  module Trace
+    BLACKLIST_PATHS = ["/health/alive", "/health/ready"].freeze
+
+    def self.init
+      Google::Cloud.configure do |config|
+        config.use_logging = false
+        config.use_trace = true
+        config.trace.sampler = Google::Cloud::Trace::TimeSampler.new(path_blacklist: BLACKLIST_PATHS.dup)
+      end
+    end
+  end
+end

data/lib/tasks/minato/trace_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :minato_trace do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: minato-trace
+version: !ruby/object:Gem::Version
+  version: 0.1.6.pre.1
+platform: ruby
+authors:
+- Ferreri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: stackdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.1
+description: Default setup of trace gem in Minato Rails Apps.
+email:
+- contato@ferreri.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/minato/trace.rb
+- lib/minato/trace/middleware.rb
+- lib/minato/trace/middleware/distributed_trace_context.rb
+- lib/minato/trace/railtie.rb
+- lib/minato/trace/version.rb
+- lib/tasks/minato/trace_tasks.rake
+homepage: https://gitlab.com/ferreri/minato/minato-trace
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/ferreri/minato/minato-trace
+  source_code_uri: https://gitlab.com/ferreri/minato/minato-trace
+  changelog_uri: https://gitlab.com/ferreri/minato/minato-trace/-/blob/main/CHANGELOG.md?ref_type=heads
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.4.1
+signing_key: 
+specification_version: 4
+summary: trace configuration for Minato Rails Apps.
+test_files: []