hephaestus 0.8.7.5 → 0.8.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c17f79baf188c20673d1d1c59299f22b36a4378d42546cda2d8b4aeddcb9e5c7
-  data.tar.gz: bfd2576c4e5652ee59215ba39d2e5f0afb80134e94502b5b3669dfd3f4baf903
+  metadata.gz: d2ce525aec1a0e799119c58576c0620f33b61d6c4ec2e3eb720fb731fffe9f25
+  data.tar.gz: 73b98f732bce7334868f7f7e2cdccc67ee84df2ffd58a34140504414846b2240
 SHA512:
-  metadata.gz: b3d0d5d1ddb364b1fbf4fffa76cd43e8a5eb51586512b9d27edd883107fcf3a056cd248185955b1dd1ea6e8cd90dd9a2c777fd25d6ed62c85c75e9d03ea55837
-  data.tar.gz: 7f54fec794443f83bda7367a31296edcb519a0c32a54fa0a6bee250ef764db587edfb2c481d98612272827d21c1a14bdae05c1d049d8cff1588f84f89e0b5b70
+  metadata.gz: '0874dddeb9a33837aede0dbf639ebfe7c94bc58daa24c1b16207ab6705e1f56d029c8230a8eec02f21c9a78217fcd60e12f2f534876de2a081b28e0b868e6bf8'
+  data.tar.gz: 5eac3b041ec6ea3ac7f2263c764b279f9aa7998e662e3f437084a383e801e812592c67561526f3afcfc8da9131feea6a1e77300ac4472bc255def552fa6e69fe

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [v0.8.9] - 10-12-2024
+## What's Changed
+* Point OpenTelemetry to internal service by @gjtorikian in https://github.com/yettoapp/hephaestus/pull/86
+
+
+**Full Changelog**: https://github.com/yettoapp/hephaestus/compare/v0.8.8...v0.8.9
+# [v0.8.8] - 09-12-2024
+## What's Changed
+* Filter parameter logging in jobs by @gjtorikian in https://github.com/yettoapp/hephaestus/pull/84
+
+
+**Full Changelog**: https://github.com/yettoapp/hephaestus/compare/v0.8.7.5...v0.8.8
 # [v0.8.7.5] - 05-12-2024
 **Full Changelog**: https://github.com/yettoapp/hephaestus/compare/v0.8.7.4...v0.8.7.5
 # [v0.8.7.4] - 05-12-2024

data/config/initializers/environment.rb

@@ -106,6 +106,8 @@ module Hephaestus
     ["Common"].each do |section_label|
       res["fields"].select { |f| f["section"] && f["section"]["label"] }.each do |field|
         next unless field["section"]["label"] == section_label
+        # exclude DATABASE_URL because it's been retrieved already in the plug boot up
+        next if field["label"].include?("DATABASE_URL")
 
         load_infra_secret(field)
       end

data/config/initializers/filter_job_params.rb

@@ -0,0 +1,22 @@
+# typed: false
+# frozen_string_literal: true
+
+# ActiveJob logs the arguments passed to the job. This initializer filters out sensitive information from the logs.
+# cf. https://github.com/rails/rails/pull/34438#issuecomment-2336749226
+Rails.application.config.after_initialize do
+  require "active_job/log_subscriber"
+  module ActiveJob
+    class LogSubscriber < ActiveSupport::LogSubscriber
+      alias_method :original_format, :format
+
+      private def format(arg)
+        if arg.is_a?(Hash)
+          parameter_filter = ActiveSupport::ParameterFilter.new(Rails.application.config.filter_parameters)
+          parameter_filter.filter(arg.transform_values { |value| original_format(value) })
+        else
+          original_format(arg)
+        end
+      end
+    end
+  end
+end

data/config/initializers/opentelemetry.rb

@@ -1,41 +1,53 @@
 # typed: false
 # frozen_string_literal: true
 
-unless Rails.env.development?
-  # establish the environment for OTEL
-  ENV["OTEL_EXPORTER_OTLP_ENDPOINT"] = "https://api.honeycomb.io"
+# development is intentionally disabled
+return if Rails.env.development?
+return if defined?(Rails::Console)
 
-  ENV["OTEL_EXPORTER_OTLP_HEADERS"] = fetch_infra_secret(
-    label: "OTEL_EXPORTER_OTLP_HEADERS",
-    default: "x-honeycomb-team=your-api-key",
-  )
+# establish the environment for OTEL
+ENV["OTEL_EXPORTER_OTLP_ENDPOINT"] = "http://service-otelcol-#{Rails.env}.internal:4318"
+ENV["OTEL_SERVICE_NAME"] = "plug-#{plug_shortname}-#{Rails.env}"
 
-  ENV["OTEL_SERVICE_NAME"] = "plug-#{plug_shortname}-#{Rails.env}"
+require "opentelemetry/sdk"
+require "opentelemetry/instrumentation/all"
+require "opentelemetry/exporter/otlp"
+require "opentelemetry/semantic_conventions"
 
-  require "opentelemetry/sdk"
-  require "opentelemetry/exporter/otlp"
-  require "opentelemetry/semantic_conventions"
+OpenTelemetry::SDK.configure do |c|
+  c.logger = Rails.logger
 
-  OpenTelemetry::SDK.configure do |c|
-    c.logger = Rails.logger
+  ##### Instruments
+  c.use("OpenTelemetry::Instrumentation::Rack", { use_rack_events: false })
+  c.use("OpenTelemetry::Instrumentation::ActionPack")
+  c.use("OpenTelemetry::Instrumentation::ActionView")
+  c.use("OpenTelemetry::Instrumentation::ActiveJob")
+  c.use("OpenTelemetry::Instrumentation::ActiveRecord")
+  c.use("OpenTelemetry::Instrumentation::AwsSdk")
+  c.use("OpenTelemetry::Instrumentation::ConcurrentRuby")
+  c.use("OpenTelemetry::Instrumentation::Faraday")
+  c.use("OpenTelemetry::Instrumentation::HttpClient")
+  c.use("OpenTelemetry::Instrumentation::Net::HTTP")
+  c.use("OpenTelemetry::Instrumentation::PG", {
+    # By default, this instrumentation includes the executed SQL as the `db.statement`
+    # semantic attribute. Optionally, you may disable the inclusion of this attribute entirely by
+    # setting this option to :omit or sanitize the attribute by setting to :obfuscate
+    db_statement: :obfuscate,
+  })
+  c.use("OpenTelemetry::Instrumentation::Rails")
+  c.use("OpenTelemetry::Instrumentation::RestClient")
 
-    c.use_all(
-      "OpenTelemetry::Instrumentation::PG" => { db_statement: :obfuscate },
-      "OpenTelemetry::Instrumentation::Rack" => { use_rack_events: false },
+  if !productionish?
+    c.add_span_processor(
+      OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
+        OpenTelemetry::Exporter::OTLP::Exporter.new,
+      ),
+    )
+  else # useful for testing instrumentation
+    c.add_span_processor(
+      OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(
+        OpenTelemetry::SDK::Trace::Export::SpanExporter.new,
+      ),
     )
-
-    if productionish?
-      c.add_span_processor(
-        OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
-          OpenTelemetry::Exporter::OTLP::Exporter.new,
-        ),
-      )
-    else # useful for testing instrumentation
-      c.add_span_processor(
-        OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(
-          OpenTelemetry::SDK::Trace::Export::SpanExporter.new,
-        ),
-      )
-    end # development is intentionally disabled
   end
 end

data/lib/hephaestus/version.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Hephaestus
-  VERSION = "0.8.7.5"
+  VERSION = "0.8.9"
   RAILS_VERSION = ">= 8.0"
   RUBY_VERSION = File
     .read("#{File.dirname(__FILE__)}/../../.ruby-version")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hephaestus
 version: !ruby/object:Gem::Version
-  version: 0.8.7.5
+  version: 0.8.9
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-05 00:00:00.000000000 Z
+date: 2024-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootsnap
@@ -436,6 +436,7 @@ files:
 - config/initializers/application.rb
 - config/initializers/cors.rb
 - config/initializers/environment.rb
+- config/initializers/filter_job_params.rb
 - config/initializers/filter_parameter_logging.rb
 - config/initializers/inflections.rb
 - config/initializers/lograge.rb