yabeda-hanami 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1406f7e10b7a1f5b792b5b6ef97e5d6315a6f8fb09e29d5bc6b9950e11bda9c
+  data.tar.gz: 63555bfe70adb4acf5a750b9ee5f3e99743945050068b05e62a0ad7ab549bcc7
+SHA512:
+  metadata.gz: dcacad87df056d8471f9f9667b219a33802d6d6de44388fdc631be3686e158aff9f87ba67fd2708fcdad7505956e9e2acb616c12e591c3639f3e3169e44f02fd
+  data.tar.gz: 49ae81d3d62e3aaaedcab7134701a58546d882de5760fef579173cf9dd473a99ef0efdbe4dc0420ddd533036d0f3dbbf84b5a5996a6f6ced8a9ef65ac3ebee39

data/lib/yabeda/hanami/config.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "anyway"
+
+module Yabeda
+  module Hanami
+    # yabeda-hanami configuration
+    class Config < ::Anyway::Config
+      config_name :yabeda_hanami
+
+      attr_accessor :notifications
+    end
+  end
+end

data/lib/yabeda/hanami/event.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "dry/events"
+
+module Yabeda
+  module Hanami
+    # Dry::Events::Event with added logic for Yabeda tags formatting
+    class Event < ::Dry::Events::Event
+      def labels
+        @labels ||= begin
+          labels = {
+            method: method,
+            path: path,
+            status: status,
+            remote_ip: remote_ip
+          }
+          labels.merge(payload.slice(*Yabeda.default_tags.keys - labels.keys))
+        end
+      end
+
+      def duration
+        ms2s payload[:time]
+      end
+
+      private
+
+      def remote_ip
+        payload[:env]["REMOTE_ADDR"]
+      end
+
+      def method
+        payload[:env]["REQUEST_METHOD"]
+      end
+
+      def path
+        payload[:env]["PATH_INFO"]
+      end
+
+      def status
+        payload[:status]
+      end
+
+      def ms2s(milliseconds)
+        (milliseconds.to_f / 1000).round(3)
+      end
+    end
+  end
+end

data/lib/yabeda/hanami/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module Hanami
+    VERSION = "0.1.0"
+  end
+end

data/lib/yabeda/hanami.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "yabeda"
+require "yabeda/hanami/config"
+require "yabeda/hanami/event"
+require "yabeda/hanami/version"
+
+module Yabeda
+  module Hanami
+    class Error < StandardError; end
+
+    LONG_RUNNING_REQUEST_BUCKETS = [
+      0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, # standard
+      30, 60, 120, 300, 600 # Sometimes requests may be really long-running
+    ].freeze
+
+    class << self
+      # Declare and install metrics
+      def install!
+        Yabeda.configure do
+          _yabeda_hanami_config = ::Yabeda::Hanami.config
+
+          group :hanami do
+            counter :requests_total,
+              comment: "A counter of the total number of HTTP requests hanami processed.",
+              tags: %i[method path remote_ip]
+
+            counter :responses_total,
+              comment: "A counter of the total number of HTTP requests hanami processed.",
+              tags: %i[method path remote_ip status]
+
+            histogram :processing_duration,
+              unit: :seconds,
+              buckets: LONG_RUNNING_REQUEST_BUCKETS,
+              comment: "A histogram of the processing duration.",
+              tags: %i[method path remote_ip status]
+
+            counter :rack_errors_total,
+              comment: "A counter of the total number of rack errors.",
+              tags: %i[method path remote_ip status]
+          end
+        end
+      end
+
+      # Subscribe to events
+      def subscribe!
+        yabeda_hanami_config = ::Yabeda::Hanami.config
+
+        yabeda_hanami_config.notifications.subscribe(:"rack.request.start") do |event|
+          event = Yabeda::Hanami::Event.new(event.id, event.payload)
+
+          Yabeda.hanami_requests_total.increment(event.labels)
+        end
+
+        yabeda_hanami_config.notifications.subscribe(:"rack.request.stop") do |event|
+          event = Yabeda::Hanami::Event.new(event.id, event.payload)
+
+          Yabeda.hanami_responses_total.increment(event.labels)
+          Yabeda.hanami_processing_duration.measure(event.labels, event.duration)
+        end
+
+        yabeda_hanami_config.notifications.subscribe(:"rack.request.error") do |event|
+          event = Yabeda::Hanami::Event.new(event.id, event.payload)
+
+          Yabeda.hanami_rack_errors_total.increment(event.labels)
+        end
+      end
+
+      def config
+        @config ||= Config.new
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: yabeda-hanami
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Greg Kostin
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hanami
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Easy collecting your Hanami apps metrics
+email:
+- gkostin@umich.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/yabeda/hanami.rb
+- lib/yabeda/hanami/config.rb
+- lib/yabeda/hanami/event.rb
+- lib/yabeda/hanami/version.rb
+homepage: https://github.com/mlibrary/yabeda-hanami
+licenses:
+- Apache-2.0
+metadata:
+  changelog_uri: https://github.com/mlibrary/yabeda-hanami/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/mlibrary/yabeda-hanami
+  source_code_uri: https://github.com/mlibrary/yabeda-hanami
+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: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Extensible metrics for monitoring a Hanami application
+test_files: []