minato-trace 0.1.6.pre.2 → 0.1.6.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f684163e7a5fa25682ee75132b4fed0f45893f6c30c9d0676562841e0046af5
-  data.tar.gz: 01b19897590f665373abbc108c35f002f45bf91a8a4c08407c742176881face1
+  metadata.gz: 67494dc73f9479f8f0960880825e85f916cbb9497c47b573a6a93b5929cec8a5
+  data.tar.gz: 157a7f9a964934f6545dafdc1cd3b8e93e11970222621b81e846fe40b5305d3d
 SHA512:
-  metadata.gz: 7f8b0515d2442eb9c44a8d06f46e6f5cf728f41a3a682cb760d537275a4ffeb2a776167cffe6cf1417fee713a726f2b6f9bfb6a8ab9460a1fc61ba4668a401cb
-  data.tar.gz: 4c6baec516cfdf7a7e44d03f8d58b22cf0d9689962c42a525fcc9025813bba34408e722813e092a17f798c35b0d1d664197dca3c08eccc7e6a54f3d61c83808a
+  metadata.gz: da50ee9d96d081f2e61f66fe0afac5d32b27ceb7d40e5255db5bfa6c9e8d083367c6a357f9b2659fbeca2d3204929baa81f4acb740695cebf7cf95324d9c3a2d
+  data.tar.gz: '018586efc6c8f5a8a6488d25e67914bd23ffc53ff248a031d4a45a7ad05bc79e94c83994c49b5096f0cd368d59513d83a4dbf712cfbaf1598df2ea6776a92067'

data/README.md

@@ -33,6 +33,8 @@ config/initializers/{service_name}.rb
   config.use Minato::Trace::Middleware::DistributedTraceContext
 end
 ```
+## Disable trace
+Trace is enabled by default. If you want to disable trace, set an environment variable `MINATO_TRACE_DISABLE=true` in your app.
 
 ## Changelog
 Changelog information could be found [here](CHANGELOG.md).

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

@@ -19,7 +19,7 @@ module Minato
         private
 
         def add_trace_context_header(env)
-          return unless Rails.env.production?
+          return unless Rails.env.production? && Minato::Trace.enabled?
 
           env.request_headers.merge!({ "#{TRACE_HEADER_KEY}": "#{current_cloud_trace.trace.trace_id};o=1" })
         end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Minato
+  module Trace
+    module Middleware
+      class IntegrateWithCloudLogging
+        def call(log)
+          return log unless ::Rails.env.production? && Minato::Trace.enabled?
+
+          add_trace_to_logs(log)
+        end
+
+        private
+
+        def add_trace_to_logs(log)
+          trace_log = "projects/#{current_cloud_trace.trace.project_id}/traces/#{current_cloud_trace.trace.trace_id}"
+
+          log.merge({ "logging.googleapis.com/trace": trace_log,
+                      "logging.googleapis.com/spanId": current_cloud_trace.span_id.to_s })
+        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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "minato/trace/middleware/distributed_trace_context"
+require "minato/trace/middleware/integrate_with_cloud_logging"
 
 module Minato
   module Trace

data/lib/minato/trace/railtie.rb

@@ -4,8 +4,8 @@ module Minato
   module Trace
     class Railtie < ::Rails::Railtie
       initializer "minato_trace_setup",
-                  before: "load_environment_config" do
-        Minato::Trace.init
+                  before: "load_environment_config" do |app|
+        Minato::Trace.init(app)
       end
     end
   end

data/lib/minato/trace/version.rb

@@ -2,6 +2,6 @@
 
 module Minato
   module Trace
-    VERSION = "0.1.6-2"
+    VERSION = "0.1.6-3"
   end
 end

data/lib/minato/trace.rb

@@ -9,11 +9,30 @@ 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)
+    def self.init(app)
+      if Minato::Trace.enabled?
+        Minato::Trance.configure_loggging(app)
+        Minato::Trace.configure_trace(app)
+      end
+
+      app
+    end
+
+    def self.enabled?
+      ENV["MINATO_TRACE_DISABLED"] != "true"
+    end
+
+    def self.configure_trace(app)
+      app.configure do
+        config.google_cloud.use_trace = true
+        config.google_cloud.trace.sampler = Google::Cloud::Trace::TimeSampler.new(path_blacklist: BLACKLIST_PATHS.dup)
+        config.minato_logger.trace_logs = Minato::Trace::Middleware::IntegrateWithCloudLogging.new
+      end
+    end
+
+    def self.configure_loggging(app)
+      app.configure do
+        config.google_cloud.use_logging = false
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minato-trace
 version: !ruby/object:Gem::Version
-  version: 0.1.6.pre.2
+  version: 0.1.6.pre.3
 platform: ruby
 authors:
 - Ferreri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-trace
@@ -51,6 +51,7 @@ files:
 - lib/minato/trace.rb
 - lib/minato/trace/middleware.rb
 - lib/minato/trace/middleware/distributed_trace_context.rb
+- lib/minato/trace/middleware/integrate_with_cloud_logging.rb
 - lib/minato/trace/railtie.rb
 - lib/minato/trace/version.rb
 - lib/tasks/minato/trace_tasks.rake