apia-yabeda 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 617d2053859bdaf2e40d00f3f057c1e1c978f5e47542703f5fcbb83a15d293c5
+  data.tar.gz: eebd3879a098c2fe79498f2f053566fd76665585f929a5fbe8dd627fc585c808
+SHA512:
+  metadata.gz: 406fea75bac88d35c34f58a01799eefe5b33e249e5ea1996e3599d0065f6a206232b41b2004aeca0b657fa4c55c15611cf901ee2df3a86e55d4f77422d20fd3f
+  data.tar.gz: 86dcb9d2c1bd68ec80d8fc75c3c03691104e3491e54e1964574baac4191c372a403540531daf10b7d8d9982bcb32db6339a9ed50254ab56ef4cbca75bd4a3565

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in apia-yabeda.gemspec
+gemspec
+
+gem "apia"
+gem "rake", "~> 13.1"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-rspec"
+
+group :test do
+  gem "pry"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Krystal Hosting Ltd
+
+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,49 @@
+# Apia::Yabeda
+
+This gem collects [Prometheus](https://prometheus.io/) metrics for applications that use [Apia](https://github.com/krystal/apia) for their API and [Yabeda](https://github.com/yabeda-rb/yabeda) for their metrics.
+
+It records:
+
+- The total number of requests handled by Apia (as a counter)
+- Time spent in Apia requests in seconds (as a histogram)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apia-yabeda'
+```
+
+## Usage in Ruby on Rails
+
+In an initializer, Hook into Apia's notifications by adding a handler that instruments the event with [ActiveSupport::Notifications](https://api.rubyonrails.org/classes/ActiveSupport/Notifications.html).
+
+```ruby
+Apia::Notifications.add_handler do |event, args|
+  ActiveSupport::Notifications.instrument("#{event}.apia", args)
+end
+```
+
+Rails automatically requires `apia/yabeda` which triggers the Yabeda configuration. `Apia::Yabeda` will then listen for these events and record metrics for them.
+
+## Tests and Linting
+
+- `bin/rspec`
+- `bin/rubocop`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/krystal/apia-yabeda.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/apia-yabeda.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "apia/yabeda/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "apia-yabeda"
+  spec.version       = Apia::Yabeda::VERSION
+  spec.authors       = ["Paul Sturgess"]
+
+  spec.summary       = "Apia Yabeda integration"
+  spec.homepage      = "https://github.com/krystal/apia-yabeda"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/krystal/apia-yabeda"
+  spec.metadata["changelog_uri"] = "https://github.com/krystal/apia-yabeda/changelog.md"
+
+  spec.metadata["rubygems_mfa_required"] = "false" # rubocop:disable Gemspec/RequireMFA (enabling MFA means we cannot auto publish via the CI)
+
+  spec.files = Dir[File.join("lib", "**", "*.rb")] +
+               Dir["{*.gemspec,Gemfile,Rakefile,README.*,LICENSE*}"]
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(/^exe\//) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 6"
+  spec.add_dependency "yabeda", ">= 0.12"
+  spec.add_dependency "yabeda-rails", ">= 0.9.0"
+end

data/lib/apia/yabeda/prometheus_collector.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "yabeda"
+require "yabeda/rails"
+
+module Apia
+  module Yabeda
+    class PrometheusCollector
+
+      def start
+        register_metrics
+        ActiveSupport::Notifications.subscribe(/(request(_error)?)\.apia/) do |*args|
+          event = ActiveSupport::Notifications::Event.new(*args)
+
+          increment_request_total_metric(event)
+          observe_endpoint_duration_metric(event)
+        end
+      end
+
+      def register_metrics
+        ::Yabeda.configure do
+          group :apia do
+            counter :requests_total do
+              comment "The total number of requests handled by Apia"
+              tags([:method, :route, :status, :api, :endpoint, :authenticator, :error_code])
+            end
+            histogram :endpoint_duration do
+              comment "Time spent in Apia requests in seconds"
+              unit :seconds
+              tags([:status, :endpoint])
+              buckets ::Yabeda::Rails::LONG_RUNNING_REQUEST_BUCKETS
+            end
+          end
+        end
+      end
+
+      private
+
+      def increment_request_total_metric(event)
+        tags = {
+          endpoint: event.payload[:request]&.endpoint&.name,
+          status: event.payload[:response]&.status,
+          api: event.payload[:request]&.api&.name,
+          route: "/#{event.payload[:request]&.route&.path}",
+          method: event.payload[:request]&.route&.request_method,
+          authenticator: event.payload[:request]&.authenticator&.name,
+          error_code: extract_error_code_from_response_body(event.payload[:response]&.body)
+        }
+        ::Yabeda.apia.requests_total.increment(tags, by: 1)
+      end
+
+      def extract_error_code_from_response_body(body)
+        return "" unless body.is_a?(Hash)
+
+        body.dig(:error, :code).to_s
+      end
+
+      def observe_endpoint_duration_metric(event)
+        return if event.payload[:time].nil?
+
+        tags = {
+          endpoint: event.payload[:request]&.endpoint&.name,
+          status: event.payload[:response]&.status
+        }
+        ::Yabeda.apia.endpoint_duration.measure(tags, event.payload[:time])
+      end
+
+    end
+  end
+end

data/lib/apia/yabeda/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Apia
+  module Yabeda
+
+    VERSION = "0.0.1"
+
+  end
+end

data/lib/apia/yabeda.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "apia/yabeda/prometheus_collector"
+require "apia/yabeda/version"
+
+module Apia
+  module Yabeda
+  end
+end
+
+collector = Apia::Yabeda::PrometheusCollector.new
+collector.start

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: apia-yabeda
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paul Sturgess
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !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: yabeda-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- apia-yabeda.gemspec
+- lib/apia/yabeda.rb
+- lib/apia/yabeda/prometheus_collector.rb
+- lib/apia/yabeda/version.rb
+homepage: https://github.com/krystal/apia-yabeda
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/krystal/apia-yabeda
+  source_code_uri: https://github.com/krystal/apia-yabeda
+  changelog_uri: https://github.com/krystal/apia-yabeda/changelog.md
+  rubygems_mfa_required: 'false'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key: 
+specification_version: 4
+summary: Apia Yabeda integration
+test_files: []