umbrtonic 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f6c51022dc73df0c8bc6e5335b86a1614b1fe1a613412f53679ed9aef067da0
+  data.tar.gz: f748c9a4046aebe509409ee2a340459ef8171293961ab4a0e44f6adb5f691784
+SHA512:
+  metadata.gz: 0e3d96b49d8703d3faa3a7b3c9fe92aea46d6f95129cb719806fbc6387c161653142f319626d0ce2541d044d3974205277081d2dc46ebbac53f4d34da60539c0
+  data.tar.gz: 3f4c98044e37342709131ddfb87b1a66a4c628da80170a2cdad93b7bfcf049a3077856df384fcdf4cfe24abbb2b88f1b54891d7a3788dbc1661158510879a022

data/.github/workflows/build.yml

@@ -0,0 +1,45 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache: true
+      - name: Run rubocop
+        run: bundle exec rubocop
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,14 @@
+/log/*
+!/log/.keep
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+.rspec_status
+Gemfile.lock
+*.gem

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,12 @@
+inherit_gem:
+  rubocop-config-umbrellio: lib/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Include:
+    - bin/*
+    - lib/**/*.rb
+    - spec/**/*.rb
+    - Gemfile
+    - Rakefile
+    - umbrtonic.gemspec

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## [0.2.0] - 2021-03-04
+- Public Release :)

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in umbrtonic.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2021 Umbrellio
+
+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,122 @@
+# Umbrtonic
+
+[![build](https://github.com/umbrellio/umbrtonic/workflows/build/badge.svg)](https://github.com/umbrellio/umbrtonic/actions)
+
+Gem for transferring Active Support Instrumentation events 
+to the InfluxDB database via UDP without boilerplate code.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'umbrtonic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install umbrtonic
+
+
+## Configuration
+Under the hood Umbrtonic uses [Qonfig](https://github.com/0exp/qonfig) gem.
+
+By default, gem sends data to 127.0.0.1:8089. You are able to change this easily:
+
+```ruby
+Umbrtonic.configure do |conf|
+  conf.influxdb.host = "another.machine"
+  conf.influxdb.port = 4444
+end
+```
+
+
+### Using a custom prefix
+Optionally you are able to set a prefix:
+
+```ruby
+Umbrtonic.configure do |conf|
+  conf.prefix = "my_app"
+end
+```
+
+For example, when you subscribe to `actions`, 
+points to InfluxDB will be sent as `my_app_actions`.
+
+Alternatively, it is possible to configure with file:
+
+```yaml
+production:
+  prefix: custom
+  influxdb:
+    host: 127.0.0.1
+    port: 8094
+# etc
+```
+
+and then load configuration:
+
+```ruby
+Umbrtonic.config.load_from_yaml(
+  Rails.root / "config" / "umbrtonic.yml",
+  expose: Rails.env
+)
+```
+
+## Usage
+```ruby
+Umbrtonic.bind("process_action.action_controller") do |inf, event, payload|
+  inf.values(
+    count:      1, 
+    duration:   event.duration, 
+    db_runtime: event.payload[:db_runtime],
+  )
+  
+  inf.tags(
+    controller: payload[:controller], 
+    action:     payload[:action],
+  )
+end
+```
+
+Gem provides instance of InfluxDB data builder
+and information about the event and payload for quick access:
+
+```ruby
+Umbrtonic.bind("process_action.action_controller") do |inf, event, payload|
+  event.name     # => "process_action.action_controller"
+  event.duration # => 10 (in milliseconds)
+  event.payload  # => event-specific payload 
+
+  payload        # => event-specific payload, alias for event.payload 
+end
+```
+
+
+
+See more information about Active Support Notifications 
+[here](https://guides.rubyonrails.org/active_support_instrumentation.html)
+
+You are able to set custom name for event:
+
+```ruby
+Umbrtonic.bind("process_action.action_controller", measurement: "actions") do |inf, event, payload|
+  # your bindings
+end
+```
+
+In this example events will be sent as `actions`.
+
+There is complete list of 
+[Ruby on Rails hooks](https://guides.rubyonrails.org/v5.1/active_support_instrumentation.html#rails-framework-hooks)
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub 
+at https://github.com/umbrellio/umbrtonic.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "umbrtonic"
+require "logger"
+require "influxdb"
+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/umbrtonic.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "active_support/notifications"
+require "influxdb/point_value"
+require "socket"
+require "qonfig"
+
+module Umbrtonic
+  require_relative "umbrtonic/influxdb"
+  require_relative "umbrtonic/version"
+
+  include Qonfig::Configurable
+
+  configuration do
+    setting :influxdb do
+      setting :host, "127.0.0.1"
+      setting :port, 8089
+    end
+
+    setting :prefix
+  end
+
+  module_function
+
+  def bind(name, measurement: name)
+    ActiveSupport::Notifications.subscribe(name) do |*args|
+      event  = ActiveSupport::Notifications::Event.new(*args)
+      influx = Umbrtonic::InfluxDB.new(measurement)
+
+      yield influx, event, event.payload
+      send_via_udp influx
+    end
+  end
+
+  def unbind(name)
+    ActiveSupport::Notifications.unsubscribe(name)
+  end
+
+  def send_via_udp(influx)
+    config = self.config.settings.influxdb
+    socket.send(influx.build, 0, config.host, config.port)
+  end
+
+  def socket
+    @socket ||= UDPSocket.new
+  end
+end

data/lib/umbrtonic/influxdb.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+class Umbrtonic::InfluxDB
+  def initialize(measurement, values: {}, tags: {})
+    @measurement = measurement
+    @values      = values
+    @tags        = tags
+  end
+
+  def value(name, value)
+    @values[name] = value
+  end
+
+  def values(**values)
+    @values = @values.merge(**values)
+  end
+
+  def tag(name, value)
+    @tags[name] = value
+  end
+
+  def tags(**tags)
+    @tags = @tags.merge(**tags)
+  end
+
+  def data
+    { values: @values,
+      tags: @tags,
+      series: series }
+  end
+
+  def build
+    ::InfluxDB::PointValue.new(data).dump
+  end
+
+  private
+
+  def series
+    [Umbrtonic.config.settings.prefix, @measurement].compact.join("_")
+  end
+end

data/lib/umbrtonic/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Umbrtonic
+  VERSION = "0.2.0"
+end

data/umbrtonic.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "umbrtonic/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "umbrtonic"
+  spec.version       = Umbrtonic::VERSION
+  spec.authors       = ["Umbrellio Team", "Eugene Yak"]
+  spec.email         = ["oss@umbrellio.biz", "eugene.yak@umbrellio.biz"]
+
+  spec.summary       = "Gem for transferring Active Support Instrumentation events " \
+                       "to the InfluxDB database via UDP without boilerplate code."
+
+  # 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.required_ruby_version = ">= 2.5"
+
+  spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "influxdb"
+  spec.add_runtime_dependency "qonfig"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-config-umbrellio"
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: umbrtonic
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Umbrellio Team
+- Eugene Yak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: influxdb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: qonfig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-config-umbrellio
+  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:
+- oss@umbrellio.biz
+- eugene.yak@umbrellio.biz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/build.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/umbrtonic.rb
+- lib/umbrtonic/influxdb.rb
+- lib/umbrtonic/version.rb
+- umbrtonic.gemspec
+homepage:
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Gem for transferring Active Support Instrumentation events to the InfluxDB
+  database via UDP without boilerplate code.
+test_files: []