yabeda-httpx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0053b46b3ddf877d33cad27da037a9a5d63ce664da42484715f00e690b9b5130
+  data.tar.gz: 5d77497eea67f1f996176769fc02ae423601e409b9b36b38c10ac02e7dd9a64f
+SHA512:
+  metadata.gz: 810e68f8e512bae0287c9508967bfaa79afbd8d8518892baaaf78cc447a312ff766b5ab7dbb74b5cdc9d4a3db9dc8152bd5ce7ea1c18dac7b663fc90e9ca571d
+  data.tar.gz: a8d28764d57170b6f22e19eae1360b8abfe2f9fc8a7c149c2acfc0ce6c6e1dde5a8a1c80b39dc39d9636271468d187d70c8e3b6b813e9e1b2e4896936d762b1c

data/.github/workflows/gem-push.yml

@@ -0,0 +1,36 @@
+name: Ruby Gem
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+        bundler-cache: true
+
+    - name: Build gem
+      run: gem build yabeda-httpx.gemspec
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.GEM_HOST_API_KEY}}"

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor
+*.gem
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2024-02-05
+
+### Added
+
+- Initial release
+- `Yabeda::Httpx.instrument` method to add metrics to HTTPX sessions
+- `httpx_requests_total` counter for tracking request counts
+- `httpx_responses_total` counter for tracking responses by status
+- `httpx_errors_total` counter for tracking request errors
+- `httpx_request_duration` histogram for tracking request latency
+- Support for HTTPX callbacks plugin (requires HTTPX >= 1.2.0)

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in yabeda-httpx.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jon David Schober
+
+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,201 @@
+# Yabeda::Httpx
+
+[![Gem Version](https://badge.fury.io/rb/yabeda-httpx.svg)](https://badge.fury.io/rb/yabeda-httpx)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
+
+A [Yabeda](https://github.com/yabeda-rb/yabeda) plugin for monitoring [HTTPX](https://gitlab.com/os85/httpx) HTTP client requests. This gem provides automatic instrumentation for external HTTP calls made with HTTPX, exposing metrics for request counts, response times, and errors.
+
+## Why Use This Gem?
+
+HTTPX is a modern, feature-rich HTTP client for Ruby. When making external API calls, it's crucial to monitor:
+
+- **Request latency**: Track how long external services take to respond
+- **Error rates**: Detect issues with external dependencies
+- **Request volume**: Understand traffic patterns to external services
+- **Status code distribution**: Monitor success vs. failure rates
+
+This gem integrates seamlessly with Yabeda's ecosystem to provide these insights with minimal configuration.
+
+## Requirements
+
+- Ruby 2.7 or higher
+- [HTTPX](https://gitlab.com/os85/httpx) >= 1.2.0 (for callbacks plugin support)
+- [Yabeda](https://github.com/yabeda-rb/yabeda) >= 0.6
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yabeda-httpx'
+gem 'yabeda-prometheus' # or another exporter
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+### Basic Usage
+
+```ruby
+require 'yabeda/httpx'
+
+# Create an HTTPX session and instrument it
+http = HTTPX.plugin(:persistent)
+http = Yabeda::Httpx.instrument(http)
+
+# Make requests as normal - metrics are automatically collected
+response = http.get("https://api.example.com/users")
+response = http.post("https://api.example.com/orders", json: { item: "widget" })
+```
+
+### With Rails
+
+In a Rails application, you might create an instrumented client in an initializer or service:
+
+```ruby
+# config/initializers/http_client.rb
+require 'yabeda/httpx'
+
+module HttpClient
+  def self.session
+    @session ||= Yabeda::Httpx.instrument(
+      HTTPX.plugin(:persistent, :follow_redirects).with(
+        timeout: { read_timeout: 30 }
+      )
+    )
+  end
+end
+```
+
+Then use it in your application:
+
+```ruby
+# In a service or controller
+response = HttpClient.session.get("https://api.stripe.com/v1/charges")
+```
+
+### With Additional HTTPX Plugins
+
+The instrumentation works with any HTTPX plugins:
+
+```ruby
+http = HTTPX
+  .plugin(:persistent)
+  .plugin(:proxy)
+  .plugin(:follow_redirects)
+  .with(timeout: { read_timeout: 60 })
+
+http = Yabeda::Httpx.instrument(http)
+```
+
+## Exposed Metrics
+
+| Metric Name | Type | Labels | Description |
+|-------------|------|--------|-------------|
+| `httpx_requests_total` | counter | `host`, `method` | Total number of HTTP requests initiated |
+| `httpx_responses_total` | counter | `host`, `method`, `status` | Total number of HTTP responses received |
+| `httpx_errors_total` | counter | `host`, `method`, `error_class` | Total number of request errors (connection failures, timeouts, etc.) |
+| `httpx_request_duration` | histogram | `host`, `method`, `status` | Request duration in seconds |
+
+### Histogram Buckets
+
+The request duration histogram uses the following buckets (in seconds):
+
+```
+0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, 30, 60, 90
+```
+
+This covers a range from 10ms to 90 seconds, suitable for most external API calls.
+
+## Example Prometheus Queries
+
+### Request Rate by Host
+
+```promql
+sum(rate(httpx_requests_total[5m])) by (host)
+```
+
+### Error Rate
+
+```promql
+sum(rate(httpx_errors_total[5m])) / sum(rate(httpx_requests_total[5m])) * 100
+```
+
+### p95 Latency
+
+```promql
+histogram_quantile(0.95, sum(rate(httpx_request_duration_bucket[5m])) by (le))
+```
+
+### Requests by Status Code
+
+```promql
+sum(rate(httpx_responses_total[5m])) by (status)
+```
+
+## Grafana Dashboard
+
+A sample Grafana dashboard JSON is available in the repository. Import it to visualize:
+
+- Total requests and request rate
+- Error rate percentage
+- Latency percentiles (p50, p90, p99)
+- Requests breakdown by host and HTTP method
+- Error tracking by host and error class
+
+## Configuration
+
+The gem automatically configures metrics when required. No additional configuration is needed.
+
+If you need custom bucket sizes, you can override the `BUCKETS` constant before requiring the gem:
+
+```ruby
+Yabeda::Httpx::BUCKETS = [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5].freeze
+require 'yabeda/httpx'
+```
+
+## How It Works
+
+The gem uses HTTPX's `:callbacks` plugin (introduced in v1.2.0) to hook into the request lifecycle:
+
+1. **`on_request_started`**: Records the start time and increments the request counter
+2. **`on_response_completed`**: Calculates duration and records response metrics
+3. **`on_request_error`**: Captures connection errors, timeouts, and other failures
+
+This approach has minimal overhead and doesn't interfere with HTTPX's normal operation.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jondavidschober/yabeda-httpx.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+Created by [Jon David Schober](https://github.com/jondavidschober) at [Datavine](https://getdatanamic.com).
+
+## See Also
+
+- [Yabeda](https://github.com/yabeda-rb/yabeda) - Extensible framework for collecting metrics
+- [HTTPX](https://gitlab.com/os85/httpx) - A Ruby HTTP library for tomorrow... and beyond!
+- [yabeda-prometheus](https://github.com/yabeda-rb/yabeda-prometheus) - Prometheus exporter for Yabeda
+- [yabeda-http_requests](https://github.com/yabeda-rb/yabeda-http_requests) - Similar gem for Net::HTTP

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "yabeda/httpx"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/yabeda/httpx/version.rb

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

data/lib/yabeda/httpx.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "yabeda"
+require "yabeda/httpx/version"
+
+module Yabeda
+  module Httpx
+    BUCKETS = [0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, 30, 60, 90].freeze
+
+    class << self
+      # Instruments an HTTPX session with Yabeda metrics using the callbacks plugin.
+      #
+      # @param session [HTTPX::Session] The HTTPX session to instrument
+      # @return [HTTPX::Session] The instrumented session with callbacks attached
+      #
+      # @example
+      #   http = HTTPX.plugin(:persistent)
+      #   http = Yabeda::Httpx.instrument(http)
+      #   response = http.get("https://example.com")
+      #
+      def instrument(session)
+        session
+          .plugin(:callbacks)
+          .on_request_started do |request|
+            request.instance_variable_set(:@yabeda_start_time, Process.clock_gettime(Process::CLOCK_MONOTONIC))
+
+            Yabeda.httpx.requests_total.increment(
+              host: request.uri.host,
+              method: request.verb.to_s.upcase
+            )
+          end
+          .on_response_completed do |request, response|
+            start_time = request.instance_variable_get(:@yabeda_start_time)
+            duration = start_time ? Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time : 0
+
+            tags = {
+              host: request.uri.host,
+              method: request.verb.to_s.upcase,
+              status: response.status.to_s
+            }
+
+            Yabeda.httpx.responses_total.increment(tags)
+            Yabeda.httpx.request_duration.measure(tags, duration)
+          end
+          .on_request_error do |request, error|
+            Yabeda.httpx.errors_total.increment(
+              host: request.uri.host,
+              method: request.verb.to_s.upcase,
+              error_class: error.class.name
+            )
+          end
+      end
+    end
+
+    Yabeda.configure do
+      group :httpx do
+        counter :requests_total,
+                comment: "Total number of HTTPX requests",
+                tags: %i[host method]
+
+        counter :responses_total,
+                comment: "Total number of HTTPX responses",
+                tags: %i[host method status]
+
+        counter :errors_total,
+                comment: "Total number of HTTPX request errors",
+                tags: %i[host method error_class]
+
+        histogram :request_duration,
+                  comment: "HTTPX request duration in seconds",
+                  unit: :seconds,
+                  tags: %i[host method status],
+                  buckets: BUCKETS
+      end
+    end
+  end
+end

data/yabeda-httpx.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yabeda/httpx/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yabeda-httpx"
+  spec.version       = Yabeda::Httpx::VERSION
+  spec.authors       = ["Jon David Schober"]
+  spec.email         = ["jon@getdatanamic.com"]
+
+  spec.summary       = "Yabeda plugin for monitoring HTTPX external HTTP requests"
+  spec.description   = "Yabeda plugin that instruments HTTPX HTTP client with request metrics including duration histograms, request counts, and error tracking"
+  spec.homepage      = "https://github.com/jondavidschober/yabeda-httpx"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.7"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/jondavidschober/yabeda-httpx"
+    spec.metadata["changelog_uri"] = "https://github.com/jondavidschober/yabeda-httpx/blob/main/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "yabeda", "~> 0.6"
+  spec.add_dependency "httpx", ">= 1.2.0"
+
+  spec.add_development_dependency "bundler", ">= 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: yabeda-httpx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon David Schober
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: httpx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !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: 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'
+description: Yabeda plugin that instruments HTTPX HTTP client with request metrics
+  including duration histograms, request counts, and error tracking
+email:
+- jon@getdatanamic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yabeda/httpx.rb
+- lib/yabeda/httpx/version.rb
+- yabeda-httpx.gemspec
+homepage: https://github.com/jondavidschober/yabeda-httpx
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jondavidschober/yabeda-httpx
+  source_code_uri: https://github.com/jondavidschober/yabeda-httpx
+  changelog_uri: https://github.com/jondavidschober/yabeda-httpx/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Yabeda plugin for monitoring HTTPX external HTTP requests
+test_files: []