yabeda-puma-plugin 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea655ec09c4edd3459d19356df62760dbb70049b24a0e5ccfb69eed7d501ec7d
-  data.tar.gz: 49cab44b0913f02a372473b3e8951a6c880020f3a22970c6f9cdadee7d3935ae
+  metadata.gz: 0e89900f2439ba78c8c813c423c1035133934fd7b727d355fe16be5416b40ef5
+  data.tar.gz: 1b99f6bebac908ad72fd85522b41823a42593262057cea0abb3c2c6dd9768501
 SHA512:
-  metadata.gz: d68acb875bb1d793d0bf6c11f1df91313ec730bcf9984f362829586bdb7810e21b809c60980cf606feec93378957b218d046bb30ced55858f8cc704c3b073380
-  data.tar.gz: e8e0c33afd4c639ef3abb25485bf2fb9a3598a288d07033ad64ebffd354335f17558aef856afc18d439fb03cf0c767026c9e348b31de6d1ff1cc91a653ca1c7e
+  metadata.gz: 2f586fcfa8cef7892afa68690c23cb6c73c70964bed54b0ce65d5434513490b91c133d2ef2e9709ad352dde50f6ebf1dea3c884e67b668737d8cfb0eb783c215
+  data.tar.gz: 97c8662a33acdd7102d90faa8725ee86269587c8c3f104dc49ae0621793c66e6f9f5ddf8660f0dbec11598e700dc97db32dcb51073c96384f4273baa20946ac6

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

@@ -21,16 +21,26 @@ jobs:
           git fetch --tags --force # Really fetch annotated tag. See https://github.com/actions/checkout/issues/290#issuecomment-680260080
           echo ::set-output name=version::${GITHUB_REF#refs/tags/v}
           echo ::set-output name=subject::$(git for-each-ref $GITHUB_REF --format='%(contents:subject)')
+          # Extract changelog entries between this and previous version headers
+          escaped_version=$(echo ${GITHUB_REF#refs/tags/v} | sed -e 's/[]\/$*.^[]/\\&/g')
+          changelog=$(awk "BEGIN{inrelease=0} /## ${escaped_version}/{inrelease=1;next} /## [0-9]+\.[0-9]+\.[0-9]+/{inrelease=0;exit} {if (inrelease) print}" CHANGELOG.md)
           # Multiline body for release. See https://github.community/t/set-output-truncates-multiline-strings/16852/5
           BODY="$(git for-each-ref $GITHUB_REF --format='%(contents:body)')"
+          BODY="${BODY}"$'\n'"${changelog}"
           BODY="${BODY//'%'/'%25'}"
           BODY="${BODY//$'\n'/'%0A'}"
           BODY="${BODY//$'\r'/'%0D'}"
           echo "::set-output name=body::$BODY"
+          # Add pre-release option if tag name has any suffix after vMAJOR.MINOR.PATCH
+          if [[ ${GITHUB_REF#refs/tags/} =~ ^v[0-9]+\.[0-9]+\.[0-9]+.+ ]]; then
+            echo ::set-output name=prerelease::true
+          fi
       - name: Build gem
         run: gem build
+      - name: Calculate checksums
+        run: sha256sum yabeda-puma-plugin-${{ steps.tag.outputs.version }}.gem > SHA256SUM
       - name: Check version
-        run: ls yabeda-puma-plugin-${{ steps.tag.outputs.version }}.gem
+        run: ls -l yabeda-puma-plugin-${{ steps.tag.outputs.version }}.gem
       - name: Create Release
         id: create_release
         uses: actions/create-release@v1
@@ -41,9 +51,8 @@ jobs:
           release_name: ${{ steps.tag.outputs.subject }}
           body: ${{ steps.tag.outputs.body }}
           draft: false
-          prerelease: false
-      - name: Upload Release Asset
-        id: upload-release-asset
+          prerelease: ${{ steps.tag.outputs.prerelease }}
+      - name: Upload built gem as release asset
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -52,3 +61,22 @@ jobs:
           asset_path: yabeda-puma-plugin-${{ steps.tag.outputs.version }}.gem
           asset_name: yabeda-puma-plugin-${{ steps.tag.outputs.version }}.gem
           asset_content_type: application/x-tar
+      - name: Upload checksums as release asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: SHA256SUM
+          asset_name: SHA256SUM
+          asset_content_type: text/plain
+      - name: Publish to GitHub packages
+        env:
+          GEM_HOST_API_KEY: Bearer ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gem push yabeda-puma-plugin-${{ steps.tag.outputs.version }}.gem --host https://rubygems.pkg.github.com/${{ github.repository_owner }}
+      - name: Publish to RubyGems
+        env:
+          GEM_HOST_API_KEY: "${{ secrets.RUBYGEMS_API_KEY }}"
+        run: |
+          gem push yabeda-puma-plugin-${{ steps.tag.outputs.version }}.gem

data/.github/workflows/test.yml

@@ -17,6 +17,7 @@ jobs:
       fail-fast: false
       matrix:
         include:
+          - ruby: 3.0
           - ruby: 2.7
           - ruby: 2.6
           - ruby: 2.5

data/CHANGELOG.md

@@ -0,0 +1,52 @@
+# Changelog
+
+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.6.0 - 2021-02-05
+
+### Changed
+
+- “Most recent” aggregation mode specified for all gauge metrics. [@botimer], [#16](https://github.com/yabeda-rb/yabeda-puma-plugin/pull/16)
+
+## 0.5.0 - 2020-11-13
+
+### Changed
+
+- Start Yabeda exporter on `on_booted` hook to support Puma 4.x daemon mode. [@Envek], [#14](https://github.com/yabeda-rb/yabeda-puma-plugin/pull/14)
+
+## 0.4.0 - 2020-04-29
+
+### Added
+
+- `yabeda_prometheus` plugin to allow metrics export on separate port. [@jwhitcraft], [#11](https://github.com/yabeda-rb/yabeda-puma-plugin/pull/11)
+
+## 0.3.0 - 2020-01-27
+
+### Added
+
+- Support for yabeda 0.2 (required by prometheus-client 1.0). [@Envek]
+
+## 0.2.1 - 2019-12-16
+
+### Fixed
+
+- Fix undefined method in TCP socket. [@Neznauy], [#7](https://github.com/yabeda-rb/yabeda-puma-plugin/pull/7)
+
+## 0.2.0 - 2019-12-12
+
+### Added
+
+- Support for TCP puma control panel url. [@dsalahutdinov]
+
+## 0.1.0 - 2019-04-02
+
+Initial release with basic metrics collection. [@dsalahutdinov]
+
+[@botimer]: https://github.com/botimer "Noah Botimer"
+[@jwhitcraft]: https://github.com/jwhitcraft "Jon Whitcraft"
+[@Neznauy]: https://github.com/Neznauy "Aleksandr Shlyakov"
+[@Envek]: https://github.com/Envek "Andrey Novikov"
+[@dsalahutdinov]: https://github.com/dsalahutdinov "Dmitry Salahutdinov"

data/README.md

@@ -134,6 +134,38 @@ docker-compose run app bundle exec rspec
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/yabeda-rb/yabeda-puma-plugin.
 
+### Releasing
+
+1. Bump version number in `lib/yabeda/puma/plugin/version.rb`
+
+   In case of pre-releases keep in mind [rubygems/rubygems#3086](https://github.com/rubygems/rubygems/issues/3086) and check version with command like `Gem::Version.new(Yabeda::VERSION).to_s`
+
+2. Fill `CHANGELOG.md` with missing changes, add header with version and date.
+
+3. Make a commit:
+
+   ```sh
+   git add lib/yabeda/puma/plugin/version.rb CHANGELOG.md
+   version=$(ruby -r ./lib/yabeda/puma/plugin/version.rb -e "puts Gem::Version.new(Yabeda::Puma::Plugin::VERSION)")
+   git commit --message="${version}: " --edit
+   ```
+
+4. Create annotated tag:
+
+   ```sh
+   git tag v${version} --annotate --message="${version}: " --edit --sign
+   ```
+
+5. Fill version name into subject line and (optionally) some description (list of changes will be taken from changelog and appended automatically)
+
+6. Push it:
+
+   ```sh
+   git push --follow-tags
+   ```
+
+7. GitHub Actions will create a new release, build and push gem into RubyGems! You're done!
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/puma/plugin/yabeda.rb

@@ -15,15 +15,15 @@ Puma::Plugin.create do
     Yabeda.configure do
       group :puma
 
-      gauge :backlog, tags: %i[index], comment: 'Number of established but unaccepted connections in the backlog'
-      gauge :running, tags: %i[index], comment: 'Number of running worker threads'
-      gauge :pool_capacity, tags: %i[index], comment: 'Number of allocatable worker threads'
-      gauge :max_threads, tags: %i[index], comment: 'Maximum number of worker threads'
+      gauge :backlog, tags: %i[index], comment: 'Number of established but unaccepted connections in the backlog', aggregation: :most_recent
+      gauge :running, tags: %i[index], comment: 'Number of running worker threads', aggregation: :most_recent
+      gauge :pool_capacity, tags: %i[index], comment: 'Number of allocatable worker threads', aggregation: :most_recent
+      gauge :max_threads, tags: %i[index], comment: 'Maximum number of worker threads', aggregation: :most_recent
 
       if clustered
-        gauge :workers, comment: 'Number of configured workers'
-        gauge :booted_workers, comment: 'Number of booted workers'
-        gauge :old_workers, comment: 'Number of old workers'
+        gauge :workers, comment: 'Number of configured workers', aggregation: :most_recent
+        gauge :booted_workers, comment: 'Number of booted workers', aggregation: :most_recent
+        gauge :old_workers, comment: 'Number of old workers', aggregation: :most_recent
       end
 
       collect do

data/lib/yabeda/puma/plugin/version.rb

@@ -1,7 +1,7 @@
 module Yabeda
   module Puma
     module Plugin
-      VERSION = "0.5.0"
+      VERSION = "0.6.0"
     end
   end
 end

data/yabeda-puma-plugin.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "yabeda", "~> 0.2"
+  spec.add_runtime_dependency "yabeda", "~> 0.5"
   spec.add_runtime_dependency "puma"
   spec.add_runtime_dependency "json"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-puma-plugin
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Salahutdinov Dmitry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-13 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yabeda
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +119,7 @@ files:
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - LICENSE.txt