card-mod-new_relic 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d5ae87a5aa454d6e841898a99d92e42aac6203e9539b80f9538ee038d42cc3c
+  data.tar.gz: 252bf0a2edb83784da2c1d4d96fd06f83cca84db549b1d870886bdf67d065f14
+SHA512:
+  metadata.gz: cbf91735500f0d5bb74bb81abe50bd15ad42601c88b2a1998a59d9a25cf6849461230761930c8d1ad144b5f76ce4eed1117ad7b98b32404ddce66f6610b839fb
+  data.tar.gz: 2c82dd418cf0caaf9cfd153089ca55e0ad18fe072afb3281658cc4edba5e3582ec13b3131937d83304ce77b29db1045fe217470bb23b01bcd7611f15966b0595

data/README.md

@@ -0,0 +1,20 @@
+<!--
+# @title README - mod: new relic
+-->
+
+# NewRelic mod (experimental)
+
+NewRelic is a sophisticated web-based performance tracking tool.
+
+This mod supports integration with NewRelic by adding tracers for important
+methods like `Card#fetch`, `Format#final_render`, `Card::Query.new`, 
+`Voo.process`, and for action events.
+
+There are also _many_ other tracers not activated but that can easily be
+copied from the source code here and reused in a local mod.
+
+To attach this mod to your NewRelic account, add a `newrelic.yml` file in the
+deck's `config` directory. 
+
+For full documentation of agent configuration options, please refer to
+https://docs.newrelic.com/docs/agents/ruby-agent/installation-configuration/ruby-agent-configuration

data/lib/card/mod/new_relic.rb

@@ -0,0 +1 @@
+require "newrelic_rpm"

data/set/all/cache.rb

@@ -0,0 +1,4 @@
+# module ClassMethods
+#   include ::NewRelic::Agent::MethodTracer
+#   add_method_tracer :write_to_cache, "Custom/Card/write_to_cache"
+# end

data/set/all/fetch.rb

@@ -0,0 +1,4 @@
+module ClassMethods
+  include ::NewRelic::Agent::MethodTracer
+  add_method_tracer :fetch, "Custom/Card/fetch"
+end

data/set/all/initialize.rb

@@ -0,0 +1,2 @@
+# include ::NewRelic::Agent::MethodTracer
+# add_method_tracer :include_set_modules, "Custom/Card/include_set_modules"

data/set/all/new_relic.rb

@@ -0,0 +1,88 @@
+event :new_relic_act_transaction, after: :act, when: :new_relic_tracking? do
+  add_new_relic_card_attributes
+  add_new_relic_act_attributes unless @action == :read
+  name_new_relic_transaction new_relic_transaction_name_parts, category: :controller
+end
+
+event :notify_new_relic, after: :notable_exception_raised, when: :new_relic_tracking? do
+  ::NewRelic::Agent.notice_error Card::Error.current
+end
+
+event :new_relic_act_start, before: :act, when: :new_relic_tracking? do
+  @act_start = Time.now
+end
+
+::Card::Set::Event::IntegrateWithDelayJob.after_perform do |job|
+  Director.contextualize_delayed_event *job.arguments[0..3] do
+    card = job.arguments[1]
+    card&.track_delayed_job job
+  end
+end
+
+# for override. cards with same label are grouped in new relic reporting
+def new_relic_label
+  type_code
+end
+
+def new_relic_tracking?
+  Rails.env.production?
+end
+
+def track_delayed_job job
+  name_new_relic_transaction ["delayed-#{job.queue_name}"]
+  add_new_relic_card_attributes
+  add_new_relic_act_attributes time=false
+end
+
+private
+
+def new_relic_transaction_name_parts
+  controller = Env[:controller]
+  parts = [controller&.action_name, new_relic_label]
+  return parts unless @action == :read
+
+  parts << controller&.response_format
+end
+
+def name_new_relic_transaction name_parts, args={}
+  name = Array.wrap(name_parts).compact.map(&:to_s).join "-"
+  ::NewRelic::Agent.set_transaction_name name, args
+end
+
+def add_new_relic_card_attributes
+  ::NewRelic::Agent.add_custom_attributes(
+    card: { type: type_code, name: name },
+    user: { roles: all_roles.join(", ") }
+  )
+end
+
+def add_new_relic_act_attributes time=true
+  args = { act: { actions: action_names_for_new_relic } }
+  args[:time_from_start] = "#{(Time.now - @act_start) * 1000} ms" if time
+  ::NewRelic::Agent.add_custom_attributes args
+end
+
+def action_names_for_new_relic
+  return unless (actions = Director.act&.actions(false))
+  actions.map(&:card).compact.map &:name
+end
+
+# test new relic custom metrics
+# module ::ActiveRecord::ConnectionAdapters
+#   class AbstractMysqlAdapter
+#     unless method_defined? :new_relic_execute
+#       alias_method :new_relic_execute, :execute
+#       def execute sql, name=nil
+#         result, duration = count_ms { original_execute(sql, name) }
+#         ::NewRelic::Agent.record_metric "Custom/Card/queries", duration
+#         result
+#       end
+#
+#       def count_ms
+#         start = Time.now
+#         result = yield
+#         [result, (Time.now - start) * 1000]
+#       end
+#     end
+#   end
+# end

data/set/all/pattern.rb

@@ -0,0 +1,2 @@
+# include ::NewRelic::Agent::MethodTracer
+# add_method_tracer :set_modules, "Custom/Card/set_modules"

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: card-mod-new_relic
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Philipp Kühl
+- Ethan McCutchen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: card
+  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: decko
+  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: newrelic_rpm
+  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'
+description: handle new relic integration with decko decks
+email:
+- info@decko.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/card/mod/new_relic.rb
+- set/all/cache.rb
+- set/all/fetch.rb
+- set/all/initialize.rb
+- set/all/new_relic.rb
+- set/all/pattern.rb
+homepage: http://decko.org
+licenses:
+- GPL-3.0
+metadata:
+  card-mod: new_relic
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.28
+signing_key:
+specification_version: 4
+summary: new relic support for decko
+test_files: []