yabeda-newrelic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42d707c68a6031d26a3ec7b9d31d9287f9350fa479756e7e9bb20331bb8ed8df
+  data.tar.gz: ecc8474600385cc8b4b5333b70806e4a416d176789bf9f7f6363507097c4f374
+SHA512:
+  metadata.gz: 1f2d72d4eef6ce67c60c9178eece3f0b4ed3a201350e0ab2b703ee6f5da5473aa2a99ead98595df6077a80d03bc08d17cdbb04250bf03ebd0336376a31c0a2fb
+  data.tar.gz: 41064232c183a7b7f70815af49d3f71dcfbbcc4e130689d590a1f605dc5b20724bf29cfaaf57af30fad4a289814000e9600fb7e0477f6a1cc27c72765c069120

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,51 @@
+---
+require:
+- rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+  - "Gemfile"
+  - "spec/**/*"
+
+Metrics/LineLength:
+  Max: 120
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# Allow to use let!
+RSpec/LetSetup:
+  Enabled: no
+
+RSpec/MultipleExpectations:
+  Enabled: no
+
+Bundler/OrderedGems:
+  Enabled: no
+
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-params-comma'
+  Enabled: yes
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  Description: 'Checks for trailing comma in array literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: yes
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  Description: 'Checks for trailing comma in hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: yes
+  EnforcedStyleForMultiline: consistent_comma
+
+RSpec/FilePath:
+  Enabled: no

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+  - 2.4.5
+  - 2.3.8
+before_install: gem install bundler -v 1.17.0

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# 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 - 2018-10-30
+
+ - Initial release: custom metrics being reported to NewRelic. @Envek

data/Gemfile

@@ -0,0 +1,16 @@
+# 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-newrelic.gemspec
+gemspec
+
+group :development, :test do
+  gem "pry"
+  gem "pry-byebug", platform: :mri
+
+  gem "rubocop"
+  gem "rubocop-rspec"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrey Novikov
+
+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,67 @@
+# Yabeda::[NewRelic]
+
+[![Gem Version](https://badge.fury.io/rb/yabeda-newrelic.svg)](https://rubygems.org/gems/yabeda-newrelic) [![Build Status](https://travis-ci.org/yabeda-rb/yabeda-newrelic.svg?branch=master)](https://travis-ci.org/yabeda-rb/yabeda-newrelic)
+
+Adapter for easy exporting collected custom metrics from your application to the [NewRelic Insights].
+
+<a href="https://evilmartians.com/?utm_source=yabeda-newrelic&utm_campaign=project_page">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
+</a>
+
+
+## Installation
+
+ 1. [Install and configure official NewRelic agent for Ruby](https://docs.newrelic.com/docs/agents/ruby-agent/installation/install-new-relic-ruby-agent).
+
+ 2. Add this line to your application's Gemfile:
+
+    ```ruby
+    gem 'yabeda-newrelic'
+    ```
+
+    And then execute:
+
+        $ bundle
+
+
+## Usage
+
+All metrics registered in [Yabeda] will be sent to NewRelic automatically.
+
+Go to [NewRelic Insights] → Data Explorer → Metrics to view them.
+
+### Caveats
+
+When testing make sure that your NewRelic agent is enabled (`NewRelic::Agent.config[:agent_enabled]` is `true`) as it is being automatically disabled in console sessions as example.
+
+
+## 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Please read following articles about how [NewRelic Ruby Agent](https://github.com/newrelic/rpm/) works under the hood to better understand how to interact with it:
+
+ - http://mgiroux.me/2016/instrumenting-rails-apps/
+ - https://qiita.com/k0kubun/items/4810d2044c47e597540f
+
+### Architecture
+
+Every time Yabeda metric is being updated the NewRelic API will be called.
+
+`collect` blocks for metrics collected on demand will be called during NewRelic's [harvest cycle](https://docs.newrelic.com/docs/using-new-relic/welcome-new-relic/getting-started/glossary#harvest-cycle). 
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yabeda-rb/yabeda-newrelic.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[NewRelic]: https://newrelic.com/
+[NewRelic Insights]: https://insights.newrelic.com/
+[Yabeda]: https://github.com/yabeda-rb/yabeda/ "Extendable framework for collecting and exporting metrics from your Ruby application "

data/Rakefile

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

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "yabeda/newrelic"
+
+# 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 "pry"
+Pry.start

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/newrelic.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "yabeda"
+require "yabeda/newrelic/version"
+require "yabeda/newrelic/adapter"
+
+module Yabeda
+  # Namespace for NewRelic adapter
+  module NewRelic
+  end
+end

data/lib/yabeda/newrelic/adapter.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "newrelic_rpm"
+require "yabeda/base_adapter"
+
+module Yabeda
+  module NewRelic
+    # NewRelic adapter. Sends yabeda metrics as custom metrics to NewRelic.
+    # See https://docs.newrelic.com/docs/agents/ruby-agent/api-guides/ruby-custom-metrics
+    class Adapter < BaseAdapter
+      def register_counter!(_metric)
+        # Do nothing. NewRelic don't need to register metrics
+      end
+
+      def perform_counter_increment!(counter, tags, increment)
+        ::NewRelic::Agent.increment_metric(build_name(counter, tags), increment)
+      end
+
+      def register_gauge!(_metric)
+        # Do nothing. NewRelic don't need to register metrics
+      end
+
+      def perform_gauge_set!(metric, tags, value)
+        ::NewRelic::Agent.record_metric(build_name(metric, tags), value)
+      end
+
+      def register_histogram!(_metric)
+        # Do nothing. NewRelic don't need to register metrics
+      end
+
+      def perform_histogram_measure!(metric, tags, value)
+        ::NewRelic::Agent.record_metric(build_name(metric, tags), value)
+      end
+
+      def initialize(*)
+        super
+        ::NewRelic::Agent.add_instrumentation(File.join(__dir__, "configure.rb"))
+      end
+
+      private
+
+      # https://docs.newrelic.com/docs/plugins/plugin-developer-resources/developer-reference/metric-naming-reference
+      def build_name(metric, labels = {})
+        name = metric.name.to_s
+        # Attrs: https://docs.newrelic.com/docs/plugins/plugin-developer-resources/developer-reference/metric-naming-reference#metric_attributes
+        name = "#{name}/#{labels.values.join('/')}" if labels.any?
+        name += units_for(metric)
+
+        ["Custom", metric.group&.capitalize, name].compact.join("/")
+      end
+
+      # https://docs.newrelic.com/docs/plugins/plugin-developer-resources/developer-reference/metric-units-reference
+      def units_for(metric)
+        return "[#{[metric.unit, metric.per].compact.join('/')}]" if metric.unit
+        return "#{name}[|#{metric.per}]" if !metric.unit && metric.per
+
+        ""
+      end
+
+      Yabeda.register_adapter(:newrelic, new)
+    end
+  end
+end

data/lib/yabeda/newrelic/configure.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This file is required by NewRelic agent when it configures itself
+# Read more on how NewRelic Ruby agent works under the hood:
+# http://mgiroux.me/2016/instrumenting-rails-apps/
+# https://qiita.com/k0kubun/items/4810d2044c47e597540f
+::NewRelic::Agent.agent.events.subscribe(:before_harvest) do
+  Yabeda.collectors.each(&:call)
+end

data/lib/yabeda/newrelic/version.rb

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

data/yabeda-newrelic.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yabeda/newrelic/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "yabeda-newrelic"
+  spec.version = Yabeda::NewRelic::VERSION
+  spec.authors = ["Andrey Novikov"]
+  spec.email   = ["envek@envek.name"]
+
+  spec.summary = "NewRelic adapter for reporting metrics from Yabeda suite"
+  spec.description = <<~DESCRIPTION
+    Adapter for reporting custom metrics from Yabeda to the NewRelic Insights.
+  DESCRIPTION
+  spec.homepage = "https://github.com/yabeda-rb/yabeda-newrelic"
+  spec.license  = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/yabeda-rb/yabeda-newrelic"
+  spec.metadata["changelog_uri"] = "https://github.com/yabeda-rb/yabeda-newrelic/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) 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_development_dependency "newrelic_rpm", "~> 5.0"
+  spec.add_development_dependency "yabeda", "~> 0.1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: yabeda-newrelic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrey Novikov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.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: 'Adapter for reporting custom metrics from Yabeda to the NewRelic Insights.
+
+'
+email:
+- envek@envek.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yabeda/newrelic.rb
+- lib/yabeda/newrelic/adapter.rb
+- lib/yabeda/newrelic/configure.rb
+- lib/yabeda/newrelic/version.rb
+- yabeda-newrelic.gemspec
+homepage: https://github.com/yabeda-rb/yabeda-newrelic
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yabeda-rb/yabeda-newrelic
+  source_code_uri: https://github.com/yabeda-rb/yabeda-newrelic
+  changelog_uri: https://github.com/yabeda-rb/yabeda-newrelic/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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: NewRelic adapter for reporting metrics from Yabeda suite
+test_files: []