metrico 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4776d64decd912f548770131eced35b429d21f0
+  data.tar.gz: '07019fd49b1a63c5c3bb444ac8bb78acfde50d17'
+SHA512:
+  metadata.gz: 858e79e3e87816629a2ca2828e73f284317ebf4eec0cc4f245db8172998c047040dd1acf730ae66c1aad0730d60b19b2cb96019e665d0799989e21697511467b
+  data.tar.gz: 84a25d433efa0efb17757489b195d68d3073b8e52650b290245ef5f92bd545d8535201f59242d744f3eb8908a9f5db13f918a4d7ca3fa6dfd9d884cf2efad4ac

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in metrico.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ivan Shamatov
+
+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,42 @@
+# Metrico [early MVP] [specs required]
+
+> NATS ruby client to write metrics
+> Use it to push in InfluxDB format through NATS
+> `https://docs.influxdata.com/influxdb/v1.2/write_protocols/line_protocol_tutorial/`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'metrico'
+```
+
+```
+$ bundle install
+```
+
+```ruby
+# config/initializers/metrico.rb
+Metrico.configure do |config|
+  config.app_name = 'Compliance' # required
+  config.hostname = 'globalhost' # required
+  config.nodes = ['nats://telegraf-0.somenatsnode.com:4222'] # required
+end
+```
+
+## Usage
+In your app you have to push metrics, passing name, hash of metric/value and hash of tags.
+
+Examples:
+```ruby
+Metrico.push('3rd_party', {response_time: 1300, sidekiq_retry: 2}, {service: :first})
+
+Metrico.push(
+  'heartbeat',
+  { cpu: 99, memory: 3200 }
+)
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "metrico"
+
+# 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/metrico/client.rb

@@ -0,0 +1,16 @@
+module Metrico
+  class Client
+    attr_reader :transport
+
+    def initialize
+      @transport = NATS::IO::Client.new
+      @transport.connect(
+        servers: Metrico.config.nodes
+      )
+    end
+
+    def push(point)
+      transport.publish(Metrico.config.subject, point.to_s)
+    end
+  end
+end

data/lib/metrico/config.rb

@@ -0,0 +1,12 @@
+module Metrico
+  class Config
+    attr_accessor :nodes,
+                  :app_name,
+                  :hostname,
+                  :subject
+
+    def initialize
+      @subject = 'metrico'
+    end
+  end
+end

data/lib/metrico/point.rb

@@ -0,0 +1,43 @@
+module Metrico
+  class Point
+    attr_accessor :name, :tags, :fields
+
+    def initialize(name, fields, tags = {})
+      @name = name
+      @fields = fields
+      tags = { hostname: Metrico.config.hostname }.merge(tags)
+      @tags = tags
+    end
+
+    # https://docs.influxdata.com/influxdb/v1.2/write_protocols/line_protocol_tutorial/
+    # InfluxDB Line Protocol
+    def to_s
+      message = [
+        metric_name,
+        metric_props
+      ].join(',')
+      puts message
+      message
+    end
+
+    private def metric_name
+      [Metrico.config.app_name, name].join(':')
+    end
+
+    private def metric_props
+      [
+        comma_equal_flatten(tags),
+        comma_equal_flatten(fields),
+        timestamp
+      ].join(' ')
+    end
+
+    private def timestamp
+      (Time.now.to_f * 1_000_000_000).to_i
+    end
+
+    private def comma_equal_flatten(hash)
+      hash.map { |k,v| [k,v].join('=') }.join(',')
+    end
+  end
+end

data/lib/metrico/version.rb

@@ -0,0 +1,3 @@
+module Metrico
+  VERSION = "0.1.0"
+end

data/lib/metrico.rb

@@ -0,0 +1,26 @@
+require 'nats/io/client'
+require 'metrico/version'
+
+module Metrico
+  require 'metrico/client'
+  require 'metrico/config'
+  require 'metrico/point'
+
+  class << self
+    attr_accessor :config
+
+    def configure
+      self.config ||= Config.new
+      yield(config)
+    end
+
+    def client
+      @client ||= Client.new
+    end
+
+    def push(name, fields, tags = {})
+      point = Point.new(name, fields, tags)
+      client.push(point)
+    end
+  end
+end

data/metrico.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metrico/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'metrico'
+  spec.version       = Metrico::VERSION
+  spec.authors       = ['Ivan Shamatov']
+  spec.email         = ['status.enable@gmail.com']
+
+  spec.summary       = 'NATS ruby client to write metrics'
+  spec.description   = 'Use it to write your metrics in InfluxDB format through NATS'
+  spec.homepage      = 'https://github.com/IvanShamatov/metrico'
+  spec.license       = 'MIT'
+
+  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.add_dependency 'nats-pure', '~> 0'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: metrico
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Shamatov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nats-pure
+  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: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Use it to write your metrics in InfluxDB format through NATS
+email:
+- status.enable@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/metrico.rb
+- lib/metrico/client.rb
+- lib/metrico/config.rb
+- lib/metrico/point.rb
+- lib/metrico/version.rb
+- metrico.gemspec
+homepage: https://github.com/IvanShamatov/metrico
+licenses:
+- MIT
+metadata: {}
+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.6.11
+signing_key: 
+specification_version: 4
+summary: NATS ruby client to write metrics
+test_files: []