yabeda-http_requests 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f5c7fa7bfe5b47c64c40b7fcee8ebd9d35358a0c6f5b6dced6b5ed255282ab7
-  data.tar.gz: 2a771d809057200cad55ffd88aa1d0f4183016c316d9c6836d7d6465b9163f5e
+  metadata.gz: b8f271bf0386cf54dbf378d7332235480aaac16b2739370314ae8bca7c1135ff
+  data.tar.gz: fc92f8a329aae59608dad648e97a5bc44cfbbe4aa38b480c9ee2573a96115410
 SHA512:
-  metadata.gz: fd615c28e1a2bd5ab02974fc6fd3e69114717d450d02453f2fdeb3748d47125c8c2a2cc2b488cd98afbf0803c6c39df7b3f86461d56273530c8ddccef02142ac
-  data.tar.gz: 6a410a70d61d54a26eeb3efa91b69aae96e30e6beccaac3ca14c0d7022c702eeb9ac6db9d43cbb642e3792ffe0a9a32d6051ec264123a2b768c2136bc83e5fe8
+  metadata.gz: 1f14ef60785c76dc6d1f1dd7129f5ef6cbbab2a7d07e19d2c6bda8968b3012314db9a067131bb75feade1fc93e5c0cf09b5247c70ebddc03476567267939cf40
+  data.tar.gz: a80a022901a4e7c6696f3aeb7aa4e5b5697c921bddb04420f6ae11bcdd2dac70e3280cfa86654ba673b36597ee4e42a4f92952cad9d8bba58fccf938f053b4d0

data/.github/workflows/build-release.yml

@@ -8,13 +8,17 @@ on:
 jobs:
   release:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+      packages: write
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0 # Fetch current tag as annotated. See https://github.com/actions/checkout/issues/290
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: "3.4"
       - name: "Extract data from tag: version, message, body"
         id: tag
         run: |
@@ -75,8 +79,8 @@ jobs:
           GEM_HOST_API_KEY: Bearer ${{ secrets.GITHUB_TOKEN }}
         run: |
           gem push yabeda-http_requests-${{ steps.tag.outputs.version }}.gem --host https://rubygems.pkg.github.com/${{ github.repository_owner }}
+      - name: Configure RubyGems Credentials
+        uses: rubygems/configure-rubygems-credentials@main
       - name: Publish to RubyGems
-        env:
-          GEM_HOST_API_KEY: "${{ secrets.RUBYGEMS_API_KEY }}"
         run: |
           gem push yabeda-http_requests-${{ steps.tag.outputs.version }}.gem

data/.github/workflows/lint.yaml

@@ -0,0 +1,33 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - "gemfiles/*"
+      - "Gemfile"
+      - "**/*.rb"
+      - "**/*.gemspec"
+      - ".github/workflows/lint.yml"
+  pull_request:
+    paths:
+      - "gemfiles/*"
+      - "Gemfile"
+      - "**/*.rb"
+      - "**/*.gemspec"
+      - ".github/workflows/lint.yml"
+
+jobs:
+  rubocop:
+    name: "RuboCop"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+          bundler-cache: true
+      - name: Lint Ruby code with RuboCop
+        run: |
+          bundle exec rubocop

data/.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Run tests
+name: Tests
 
 on:
   pull_request:
@@ -10,38 +10,29 @@ on:
 
 jobs:
   test:
-    name: "Run tests"
-    if: "! contains(toJSON(github.event.commits.latest.message), '[ci skip]')"
+    # Skip running tests for local pull requests (use push event instead), run only for foreign ones
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.owner.login != github.event.pull_request.base.repo.owner.login
+    name: 'Ruby ${{ matrix.ruby }}'
     runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.optional || false }}
     strategy:
       fail-fast: false
       matrix:
+        ruby:
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+          - '3.4'
         include:
-          - ruby: 3.0
-          - ruby: 2.7
-          - ruby: 2.6
-          - ruby: 2.5
-    container:
-      image: ruby:${{ matrix.ruby }}
-      env:
-        CI: true
+          - ruby: head
+          - optional: true
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/cache@v2
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
         with:
-          path: vendor/bundle
-          key: bundle-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}-${{ hashFiles('**/Gemfile') }}
-          restore-keys: |
-            bundle-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}-${{ hashFiles('**/Gemfile') }}
-            bundle-${{ matrix.ruby }}-
-      - name: Upgrade Bundler to 2.0 (for older Rubies)
-        run: gem install bundler -v '~> 2.0'
-      - name: Bundle install
-        run: |
-          bundle config path vendor/bundle
-          bundle install
-          bundle update
-      - name: Run Rubocop
-        run: bundle exec rubocop
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
       - name: Run RSpec
         run: bundle exec rspec

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AllCops:
+  TargetRubyVersion: "2.5"
+
 Style/Documentation:
   Exclude:
     - 'example/**/*'

data/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 0.3.0 - 2025-10-20
+
+### Added
+
+- Ability to configure histogram bucket sizes for the `response_duration` metric. [#10](https://github.com/yabeda-rb/yabeda-http_requests/pull/10) by [@ryan-dyer-sp][]
+
+## 0.2.1 - 2023-12-14
+
+### Fixed
+
+- Ensure http method is always uppercase. [@webmat], [#6](https://github.com/yabeda-rb/yabeda-http_requests/pull/6)
+
 ## 0.2.0 - 2021-01-25
 
 ### Fixed
@@ -36,3 +48,5 @@ Initial release.
 [@dreikanter]: https://github.com/dreikanter "Alex Musayev"
 [@danmarcab]: https://github.com/danmarcab "Daniel Marín"
 [@Envek]: https://github.com/Envek "Andrey Novikov"
+[@webmat]: https://github.com/webmat "Mathieu Martin"
+[@ryan-dyer-sp]: https://github.com/ryan-dyer-sp "Ryan"

data/Gemfile

@@ -4,6 +4,8 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'yabeda', '>= 0.13.0'
+
 gem 'byebug'
 gem 'rake', '~> 12.0'
 gem 'rspec', '~> 3.0'

data/README.md

@@ -3,7 +3,7 @@
     alt="Sponsored by Amplifr" src="https://amplifr-direct.s3-eu-west-1.amazonaws.com/social_images/image/37b580d9-3668-4005-8d5a-137de3a3e77c.png" />
 </a>
 
-# Yabeda::HttpRequests
+# ![Yabeda::HttpRequests](./yabeda-http_requests-logo.png)
 
 Built-in metrics for external services HTTP calls! This gem is a Part of the [yabeda](https://github.com/yabeda-rb/yabeda) suite.
 
@@ -67,6 +67,14 @@ Follow the [yabeda-external-http-requests](http://localhost:3000/d/OGd-oEXWz/yab
 Finally, after a couple of minutes when data collected you will see the following:
 ![Monitor external HTTP calls with Grafana](docs/dashboard.png)
 
+## Configuration
+
+Configuration is handled by [anyway_config] gem. With it you can load settings from environment variables (upcased and prefixed with `YABEDA_HTTP_REQUESTS_`), YAML files, and other sources. See [anyway_config] docs for details.
+
+| Config key | Type  | Default | Description                                 |
+| -----------| ----- | ------- | ------------------------------------------- |
+| `buckets`  | array | []      | Set buckets to be used by histogram metrics |
+
 ## Development with Docker
 
 Get local development environment working and tests running is very easy with docker-compose:

data/lib/yabeda/http_requests/config.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'anyway'
+
+module Yabeda
+  module HttpRequests
+    # yabeda-http-requests configuration
+    class Config < ::Anyway::Config
+      config_name :yabeda_http_requests
+
+      attr_config :buckets
+    end
+  end
+end

data/lib/yabeda/http_requests/sniffer.rb

@@ -10,7 +10,7 @@ module Yabeda
           {
             host: data_item.request.host,
             port: data_item.request.port,
-            method: data_item.request.method
+            method: data_item.request.method.upcase
           }
         )
       end
@@ -28,7 +28,7 @@ module Yabeda
           {
             host: data_item.request.host,
             port: data_item.request.port,
-            method: data_item.request.method,
+            method: data_item.request.method.upcase,
             status: data_item.response.status
           }
         )
@@ -38,7 +38,7 @@ module Yabeda
         labels = {
           host: data_item.request.host,
           port: data_item.request.port,
-          method: data_item.request.method,
+          method: data_item.request.method.upcase,
           status: data_item.response.status
         }
 

data/lib/yabeda/http_requests/version.rb

@@ -2,6 +2,6 @@
 
 module Yabeda
   module HttpRequests
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/yabeda/http_requests.rb

@@ -2,6 +2,7 @@
 
 require 'yabeda/http_requests/version'
 require 'yabeda/http_requests/sniffer'
+require 'yabeda/http_requests/config'
 require 'yabeda'
 require 'sniffer'
 
@@ -16,22 +17,22 @@ module Yabeda
     ].freeze
 
     Yabeda.configure do
+      config = ::Yabeda::HttpRequests::Config.new
+      buckets = config.buckets || LONG_RUNNING_REQUEST_BUCKETS
+
       group :http
 
       counter :request_total,
-              comment: 'A counter of the total number of external HTTP \
-                         requests.',
+              comment: 'A counter of the total number of external HTTP requests.',
               tags: %i[host port method]
       counter :response_total,
-              comment: 'A counter of the total number of external HTTP \
-                         responses.',
+              comment: 'A counter of the total number of external HTTP responses.',
               tags: %i[host port method status]
 
       histogram :response_duration, tags: %i[host port method status],
                                     unit: :milliseconds,
-                                    buckets: LONG_RUNNING_REQUEST_BUCKETS,
-                                    comment: "A histogram of the response \
-                                               duration (milliseconds)."
+                                    buckets: buckets,
+                                    comment: 'A histogram of the response duration (milliseconds).'
 
       ::Sniffer.config do |c|
         c.enabled = true

data/yabeda-http_requests.gemspec

@@ -26,6 +26,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'anyway_config', '>= 1.3', '< 3.0'
+
   spec.add_runtime_dependency 'sniffer'
   spec.add_runtime_dependency 'yabeda'
 end

metadata

@@ -1,15 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-http_requests
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Dmitry Salahutdinov
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: anyway_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: sniffer
   requirement: !ruby/object:Gem::Requirement
@@ -46,6 +65,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/build-release.yml"
+- ".github/workflows/lint.yaml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
@@ -59,8 +79,10 @@ files:
 - bin/setup
 - docker-compose.yml
 - lib/yabeda/http_requests.rb
+- lib/yabeda/http_requests/config.rb
 - lib/yabeda/http_requests/sniffer.rb
 - lib/yabeda/http_requests/version.rb
+- yabeda-http_requests-logo.png
 - yabeda-http_requests.gemspec
 homepage: https://github.com/yabeda-rb/yabeda-http_requests
 licenses:
@@ -68,7 +90,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/yabeda-rb/yabeda-http_requests
   source_code_uri: https://github.com/yabeda-rb/yabeda-http_requests
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -83,8 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Monitoring of external services HTTP/HTTPS calls
 test_files: []