puma-plugin-telemetry 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fe506b3cee809f3647bdbd9215b7ed150e8efaadc0d3ce6971c76cbca375dde8
+  data.tar.gz: 0c7a16268af68cd404297699db57a0f253c95e341e78b25555f114debeb6c86b
+SHA512:
+  metadata.gz: c3f48102a6b14d5ba37135788d63b7c489e18a06640217d9df6080a98c9f62efdfdc5f9cf563e192225496d04e342a5829e192ce88b926d9c90e4cf4b68153db
+  data.tar.gz: 36f0d6c18542b52f9c77764bd6a84b7693af50e84a1e398333cf1d6207d76297fbf5dbcf2b906b8ef855bb9de42764a11b7877467ae3e4872a1dd01044b145e7

data/.github/CODEOWNERS

@@ -0,0 +1,5 @@
+# Individuals and teams that are responsible for code in the repository.
+#
+# Read more at https://help.github.com/en/articles/about-code-owners
+
+*   @babbel/tnt

data/.github/workflows/build.yml

@@ -0,0 +1,46 @@
+name: build
+
+on: [push, create]
+
+jobs:
+  build_matrix:
+    strategy:
+      matrix:
+        os: ['ubuntu-18.04', 'ubuntu-20.04']
+        ruby: ['2.6', '2.7', '3.0', '3.1']
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      # Environment setup
+      - uses: actions/checkout@v3
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run rubocop
+        run: |
+          bundle exec rubocop --display-cop-names
+
+      - name: Run tests
+        run: |
+          bundle exec rspec
+
+  build:
+    needs: [build_matrix]
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Dummy for branch status checks
+        run: |
+          echo "build complete"
+
+  release:
+    needs: build
+    if: contains(github.ref, 'tags') && github.event_name == 'create'
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+      - uses: babbel/publish-gem@v1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.6

data/CHANGELOG.md

@@ -0,0 +1,76 @@
+# 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]
+
+## [1.1.0]
+
+Out of beta testing, reading for usage. Following is a recap from Alpha & Beta releases.
+
+### Added
+- new metric: `sockets.backlog` (disabled by default), pulls information from Puma
+  sockets about the state of their backlogs. This together with `queue.backlog`
+  allows for full insights into total number of requests waiting to be processed
+- `config.sockets_telemetry!` option to enable sockets telemetry
+- `config.socket_parser` option to allow custom parser implementation as needed
+- Datadog widgets examples under `docs/examples.md`
+
+## [1.1.0 Beta]
+
+### Added
+
+Different ways to parse `Socket::Option`. Mainly due to the fact that `#inspect` can't
+generate proper data on AWS Fargate, which runs Amazon Linux 2 with 4.14 kernel. So now
+besides `#inspect` there's also `#unpack` that parses binary data and picks proper field.
+
+It depends on the kernel, but new fields are usually added at the end of the `tcp_info`
+struct, so it should more or less stay stable.
+
+You can configure it by passing in `config.socket_parser = :inspect` or
+`config.socket_parser = ->(opt) { your implementation }`.
+
+## [1.1.0 Alpha]
+
+### Added
+
+Socket telemetry, and to be more precise new metric: `sockets.backlog`. If enabled it will
+pull information from Puma sockets about the state of their backlogs (requests waiting to
+be acknowledged by Puma). It will be exposed under `sockets-backlog` metric.
+
+You can enable and test it via `config.sockets_telemetry!` option.
+
+## [1.0.0] - 2021-09-08
+### Added
+- Release to Github Packages
+- Explicitly flush datadog metrics after publishing them
+- Middleware for measuring and tracking request queue time
+
+### Changed
+- Replace `statsd.batch` with direct calls, as it aggregates metrics interally by default now.
+  Also `#batch` method is deprecated and will be removed in version 6 of Datadog Statsd client.
+
+## [0.3.1] - 2021-03-26
+### Changed
+- IO target replaces dots in telemetry keys with dashes for better integration with AWS CloudWatch
+
+## [0.3.0] - 2020-12-21
+### Added
+- Datadog Target integration tests
+
+### Fixed
+- Datadog Target
+
+## [0.2.0] - 2020-12-21
+### Fixed
+- Removed debugging information
+
+## [0.1.0] - 2020-12-18
+### Added
+- Core Plugin
+- Telemetry generation
+- IO Target with JSON formatter
+- Datadog Statsd Target

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at tnt@babbel.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puma-plugin-telemetry.gemspec
+gemspec
+
+gem 'dogstatsd-ruby'
+
+gem 'rack'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.5'
+gem 'rubocop-performance', '~> 1.9'

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    puma-plugin-telemetry (1.1.0)
+      puma (>= 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    dogstatsd-ruby (5.5.0)
+    nio4r (2.5.8)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    puma (5.6.4)
+      nio4r (~> 2.0)
+    rack (2.2.3.1)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.30.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dogstatsd-ruby
+  puma-plugin-telemetry!
+  rack
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.5)
+  rubocop-performance (~> 1.9)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Babbel GmbH
+
+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,136 @@
+# Puma::Plugin::Telemetry
+
+Puma plugin adding ability to publish various metrics to your prefered targets.
+
+## Install
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "puma-plugin-telemetry"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install puma-plugin-telemetry
+
+## Usage
+
+In your puma configuration file (i.e. `config/puma.rb` or `config/puma/<env>.rb`):
+
+```ruby
+plugin "telemetry"
+
+Puma::Plugin::Telemetry.configure do |config|
+  config.enabled = true
+
+  # << here rest of the configuration, examples below
+end
+```
+
+### Basic
+
+Output telemetry as JSON to STDOUT
+
+```ruby
+  config.add_target :io
+```
+
+### Datadog statsd target
+
+Given gem provides built in target for Datadog Statsd client, that uses batch operation to publish metrics.
+
+**NOTE** Be sure to have `dogstatsd` gem installed.
+
+```ruby
+  config.add_target :dogstatsd, client: Datadog::Statsd.new
+```
+
+You can provide all the tags, namespaces, and other configuration options as always to `Datadog::Statsd.new` method.
+
+### All available options
+
+For detailed documentation checkout [`Puma::Plugin::Telemetry::Config`](./lib/puma/plugin/telemetry/config.rb) class.
+
+```ruby
+Puma::Plugin::Telemetry.configure do |config|
+  config.enabled = true
+  config.initial_delay = 10
+  config.frequency = 30
+  config.puma_telemetry = %w[workers.requests_count queue.backlog queue.capacity]
+  config.socket_telemetry!
+  config.socket_parser = :inspect
+  config.add_target :io, formatter: :json, io: StringIO.new
+  config.add_target :dogstatsd, client: Datadog::Statsd.new(tags: { env: ENV["RAILS_ENV"] })
+end
+```
+
+### Custom Targets
+
+Target is a simple object that implements `call` methods that accepts `telemetry` hash object. This means it can be super simple `proc` or some sofisticated class calling some external API.
+
+Just be mindful that if the API takes long to call, it will slow down frequency with which telemetry will get reported.
+
+```ruby
+  # Example logfmt to stdout target
+  config.add_target proc { |telemetry| puts telemetry.map { |k, v| "#{k}=#{v.inspect}" }.join(" ") }
+```
+
+## Extra middleware
+
+This gems comes together with middleware for measuring request queue time, which will be reported in `request.env` and published to given statsd client.
+
+Example configuration:
+
+```ruby
+# in Gemfile add `require` part
+gem "puma-plugin-telemetry", require: ["rack/request_queue_time_middleware"]
+
+# in initializer, i.e. `request_queue_time.rb`
+Rails.application.config.middleware.insert_after(
+  0,
+  RequestQueueTimeMiddleware,
+  statsd: Datadog::Statsd.new(namespace: "ruby.puma", tags: { "app" => "accounts" })
+)
+
+Rails.application.config.log_tags ||= {}
+Rails.application.config.log_tags[:queue_time] = ->(req) { req.env[::RequestQueueTimeMiddleware::ENV_KEY] }
+```
+
+This will provide proper metric in Datadog and in logs as well. Logs can be transformed into log metrics and used for auto scaling purposes.
+
+## 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 that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Release
+
+All gem releases are manual, in order to create a new release follow:
+
+1. Create new PR (this could be included in feature PR, if it's meant to be released)
+   - update `VERSION`, we use [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
+   - update `CHANGELOG`
+   - merge
+2. Draft new release via Github Releases
+   - use `v#{VERSION}` as a tag, i.e. `v0.1.0`
+   - add release notes based on the Changelog
+   - create
+3. Gem will get automatically published to given rubygems server
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/babbel/puma-plugin-telemetry.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the puma-plugin-telemetry project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/babbel/puma-plugin-telemetry/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'puma/plugin/telemetry'
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+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