yabeda-honeybadger_insights 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d29ae1672f88e4a18c194104fe3ca5aae41f463b3dd6aeab76e46a3199cf7158
+  data.tar.gz: 84588213a2d6fd7607fde9c1a4d9917ab8150dd30ded76a2d03d55cbff42e49b
+SHA512:
+  metadata.gz: 4b7c36927ab4500e4f782605d34058c8a623b783fb9b6dea0d2143715509004e9f35efc2dfe97df9bab3916fc96c99c6b8223625f2a15ea5fd879346a7c8f455
+  data.tar.gz: 6052a06ccf11c638a783804955ea990bd7c816f53953abd2c2be906abf975b1ea80d7c74d13a908930e1217337c7fa089e7985dc4a9d88ceed9386c515f72768

data/.github/workflows/release.yml

@@ -0,0 +1,43 @@
+name: Release gem
+
+on:
+  workflow_run:
+    workflows: [Tests]
+    types: [completed]
+    branches: [main]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-if-needed:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create Release PR
+        uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          release-type: ruby
+          package-name: yabeda-honeybadger_insights
+          version-file: lib/yabeda/honeybadger_insights/version.rb
+
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Publish gem
+        if: ${{ steps.release.outputs.release_created }}
+        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 build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/test.yml

@@ -0,0 +1,35 @@
+name: Tests
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  test:
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - ruby: 3.3
+          - ruby: 3.2
+          - ruby: 3.1
+          - ruby: 3.0
+          - ruby: 2.7
+    env:
+      CI: true
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          rubygems: latest
+
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

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

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.3.0

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 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.1.0 - 2024-02-27
+
+* Initial release of yabeda-honeybadger_insights gem.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+group :development, :test do
+  gem "rake"
+  gem "standardrb"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Honeybadger Industries
+
+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,66 @@
+# Honeybadger Insights plugin for Yabeda
+
+[![Tests](https://github.com/honeybadger-io/yabeda-honeybadger_insights/actions/workflows/test.yml/badge.svg)](https://github.com/honeybadger-io/yabeda-honeybadger_insights/actions/workflows/test.yml)
+[![Gem Version](https://badge.fury.io/rb/yabeda-honeybadger_insights.svg)](https://rubygems.org/gems/yabeda-honeybadger_insights)
+
+This [Yabeda] adapter sends application metrics to [Honeybadger Insights].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yabeda-honeybadger_insights'
+```
+
+And then execute:
+
+```shell
+bundle
+```
+
+## Usage
+
+Register the adapter along with your other Yabeda initialization code (such as in `config/initializers/yabeda.rb`).
+
+```ruby
+Yabeda.configure do
+  register_adapter(:honeybadger_insights, Yabeda::HoneybadgerInsights::Adapter.new)
+end
+```
+
+All metrics will be sent to Honeybadger Insights as events, so counters, gauges, and histograms are all treated the same way.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. 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](https://github.com/honeybadger-io/yabeda-honeybadger_insights).
+
+### To contribute your code:
+
+1. Fork the repo.
+2. Create a topic branch `git checkout -b my_branch`.
+3. Make your changes and add an entry to the [CHANGELOG](CHANGELOG.md).
+4. Commit your changes `git commit -am "Boom"`
+5. Push to your branch `git push origin my_branch`
+6. Send a [pull request](https://github.com/honeybadger-io/yabeda-honeybadger_insights/pulls)
+
+### Releasing
+
+Releases are automated using [GitHub Actions](.github/workflows/release.yml):
+
+* When a PR is merged on main the [test.yml](.github/workflows/test.yml) workflow is executed to run the tests.
+* If the tests pass, the [release.yml](.github/workflows/release.yml) workflow will be executed.
+* Depending on the commit message, a release PR will be created with the suggested  version bump and changelog.
+  Note: Not all commit messages trigger a new release. For example, `chore: ...` will not trigger a release.
+* If the release PR is merged, the [release.yml](.github/workflows/release.yml) workflow will be executed again, and this time it will create a GitHub release, bundle the gem, and push it to RubyGems.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[Honeybadger Insights]: https://www.honeybadger.io/tour/insights/
+[Yabeda]: https://github.com/yabeda-rb/yabeda

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'yabeda/honeybadger-insights'
+
+# 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

data/lib/yabeda/honeybadger_insights/adapter.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "yabeda/base_adapter"
+require "honeybadger"
+
+module Yabeda
+  module HoneybadgerInsights
+    class Adapter < BaseAdapter
+      def register_counter!(counter)
+      end
+
+      def perform_counter_increment!(counter, tags, increment)
+        record_metric(counter, tags, increment, "counter")
+      end
+
+      def register_gauge!(gauge)
+      end
+
+      def perform_gauge_set!(gauge, tags, value)
+        record_metric(gauge, tags, value, "gauge")
+      end
+
+      def register_histogram!(histogram)
+      end
+
+      def perform_histogram_measure!(histogram, tags, value)
+        record_metric(histogram, tags, value, "histogram")
+      end
+
+      private
+
+      # Since Honeybadger Insights records metrics as logs, treat all metrics as events, regardless of type
+      def record_metric(metric, tags, value, type)
+        Honeybadger.event("metric", {
+          name: metric.name,
+          value: value,
+          tags: tags,
+          type: type,
+          group: metric.group,
+          unit: metric.unit
+        }.compact)
+      end
+    end
+  end
+end

data/lib/yabeda/honeybadger_insights/version.rb

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

data/lib/yabeda/honeybadger_insights.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "yabeda"
+require "yabeda/honeybadger_insights/version"
+require "yabeda/honeybadger_insights/adapter"
+
+module Yabeda
+  module HoneybadgerInsights
+    class Error < StandardError; end
+  end
+end

data/yabeda-honeybadger_insights.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/yabeda/honeybadger_insights/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "yabeda-honeybadger_insights"
+  spec.version = Yabeda::HoneybadgerInsights::VERSION
+  spec.authors = ["Benjamin Curtis"]
+  spec.email = ["ben@bencurtis.com"]
+
+  spec.summary = "Yabeda Honeybadger Insights adapter"
+  spec.homepage = "https://github.com/honeybadger-io/yabeda-honeybadger_insights"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/honeybadger-io/yabeda-honeybadger_insights"
+  spec.metadata["changelog_uri"] = "https://github.com/honeybadger-io/yabeda-honeybadger_insights/blob/master/CHANGELOG.md"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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.required_ruby_version = ">= 2.3"
+
+  spec.add_dependency "honeybadger", ">= 5.5"
+  spec.add_dependency "yabeda", "~> 0.12"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: yabeda-honeybadger_insights
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Benjamin Curtis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: honeybadger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- ben@bencurtis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".tool-versions"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yabeda/honeybadger_insights.rb
+- lib/yabeda/honeybadger_insights/adapter.rb
+- lib/yabeda/honeybadger_insights/version.rb
+- yabeda-honeybadger_insights.gemspec
+homepage: https://github.com/honeybadger-io/yabeda-honeybadger_insights
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/honeybadger-io/yabeda-honeybadger_insights
+  source_code_uri: https://github.com/honeybadger-io/yabeda-honeybadger_insights
+  changelog_uri: https://github.com/honeybadger-io/yabeda-honeybadger_insights/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Yabeda Honeybadger Insights adapter
+test_files: []