yabeda-datadog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76499b2fc49b319aba467fc5ae335b8eb7a8e978cfb2ab1a5b659ba47d7b1dfa
+  data.tar.gz: 43c14e0c4f9db28ddb299049cf5c06aeeac5a97ccdb1e3411f71edeb98f2456e
+SHA512:
+  metadata.gz: fd582c08f725d7e158119e54ac5b3d6d7edb3d3434725c7652c76d86dec305e09d419bb26bc26392a4e2cf4ec3d9b5987a25b69e5fc330853a22c29910923ad2
+  data.tar.gz: dcd61b99c6cf2dcec3ba6aa09678b839cb445315a83351a9744840650a4b4d6993ead2521d72736ac89812e01436a44d45eeb009f57e157dfce3f45e15ef098a

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,48 @@
+---
+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: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-params-comma'
+  Enabled: true
+  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: true
+  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: true
+  EnforcedStyleForMultiline: consistent_comma

data/Gemfile

@@ -0,0 +1,8 @@
+# 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-datadog.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    yabeda-datadog (0.1.0)
+      dogapi
+      yabeda
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    concurrent-ruby (1.1.3)
+    diff-lcs (1.3)
+    dogapi (1.32.0)
+      multi_json
+    dry-initializer (2.5.0)
+    method_source (0.9.2)
+    multi_json (1.13.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    yabeda (0.1.2)
+      concurrent-ruby
+      dry-initializer
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  yabeda-datadog!
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 shvetsovdm
+
+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,46 @@
+# Yabeda Datadog adapter
+
+[Yabeda](https://github.com/yabeda-rb/yabeda) adapter for easy exporting collected custom metrics from your application to the Datadog API.
+
+
+## Installation
+
+This adapter send metrics to [Datadog API](https://docs.datadoghq.com/api/?lang=ruby) and requires to have and Datadog account with API key. You can obtain your Datadog API key in [Datadog dashboard](https://app.datadoghq.com/account/settings#api). For more information refer to [API documentation](https://docs.datadoghq.com/api/?lang=ruby#authentication).
+
+Add line to your application's Gemfile:
+
+```ruby
+gem 'yabeda-datadog'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Require this adapter before Yabeda configuration:
+
+```ruby
+require "yabeda/datadog"
+```
+
+Refer to [Yabeda documentation](https://github.com/yabeda-rb/yabeda) for instruction how to configure and use Yabeda.
+
+Refer to [Datadog metrics documentation](https://docs.datadoghq.com/graphing/metrics/) for working with your metrics in Datadog dashboard.
+
+Please note that configuring Yabeda you have to use Datadog units. Refer to [Datadog unit for metrics documentation](https://docs.datadoghq.com/developers/metrics/#units).
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shvetsovdm/yabeda-datadog.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "yabeda/datadog"
+
+# 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/examples/script.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "yabeda/datadog"
+
+# Put Datadog an API key in DATADOG_API_KEY env variable
+# and appliction key in DATADOG_APP_KEY env variable.
+# Refer to Datadog integrations dashboard for an API key
+
+# To Use this script execute it directly with ruby command.
+#
+# Example:
+#
+#   DATADOG_API_KEY="your-datadog-api-key-here" ruby script.rb
+#
+
+Yabeda.configure do
+  group :yabeda_datadog_gem_examples_script
+  counter :run_count, comment: "The total number of times the script was executed", unit: "execution"
+  gauge :run_time, comment: "Script execution time", unit: "second"
+end
+
+start_time = Time.now
+Yabeda.yabeda_datadog_gem_examples_script_run_count.increment(device: "developent_computer")
+finish_time = Time.now
+Yabeda.yabeda_datadog_gem_examples_script_run_time.set({ device: "developent_computer" }, finish_time - start_time)

data/lib/yabeda/datadog.rb

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

data/lib/yabeda/datadog/adapter.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "dogapi"
+require "yabeda/base_adapter"
+
+module Yabeda
+  module Datadog
+    # DataDog adapter. Sends yabeda metrics as custom metrics to DataDog API.
+    # https://docs.datadoghq.com/integrations/ruby/
+    class Adapter < BaseAdapter
+      def register_counter!(counter)
+        metric = AdapterMetric.new(counter, "counter")
+        dog.update_metadata(metric.name, metric.metadata)
+      end
+
+      def perform_counter_increment!(counter, tags, increment)
+        metric = AdapterMetric.new(counter, "counter")
+        tags[:type] = "counter"
+        dog.emit_point(metric.name, increment, tags)
+      end
+
+      def register_gauge!(gauge)
+        metric = AdapterMetric.new(gauge, "gauge")
+        dog.update_metadata(metric.name, metric.metadata)
+      end
+
+      def perform_gauge_set!(gauge, tags, value)
+        metric = AdapterMetric.new(gauge, "gauge")
+        tags[:type] = "gauge"
+        dog.emit_point(metric.name, value, tags)
+      end
+
+      private
+
+      def dog
+        ::Dogapi::Client.new(ENV["DATADOG_API_KEY"], ENV["DATADOG_APP_KEY"])
+      end
+
+      Yabeda.register_adapter(:datadog, new)
+    end
+
+    # Internal adapter representation of metrics
+    class AdapterMetric
+      def initialize(metric, type)
+        @metric = metric
+        @type = type
+      end
+
+      attr_reader :type
+
+      def metadata
+        {
+          type: type,
+          description: description,
+          short_name: name,
+          unit: unit,
+          per_unit: per_unit,
+        }
+      end
+
+      def name
+        parts = ""
+        parts += "#{metric.group}." if metric.group
+        parts + metric.name.to_s
+      end
+
+      def description
+        metric.comment
+      end
+
+      def unit
+        metric.unit
+      end
+
+      def per_unit
+        metric.per
+      end
+
+      private
+
+      attr_reader :metric
+    end
+  end
+end

data/lib/yabeda/datadog/version.rb

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

data/yabeda-datadog.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 "yabeda/datadog/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yabeda-datadog"
+  spec.version       = Yabeda::Datadog::VERSION
+  spec.authors       = ["Dmitry Shvetsov <@shvetsovdm>"]
+  spec.email         = ["shvetsovdm@gmail.com"]
+
+  spec.summary       = "DataDog adapter for reporting metrics from Yabeda suite"
+  spec.description = <<~DESCRIPTION
+    Adapter for reporting custom metrics from Yabeda to DataDog.
+  DESCRIPTION
+  spec.homepage      = "https://github.com/shvetsovdm/yabeda-datadog"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__, __FILE__)) 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_dependency "dogapi"
+  spec.add_dependency "yabeda"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: yabeda-datadog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmitry Shvetsov <@shvetsovdm>
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dogapi
+  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: yabeda
+  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.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !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: 'Adapter for reporting custom metrics from Yabeda to DataDog.
+
+'
+email:
+- shvetsovdm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/script.rb
+- lib/yabeda/datadog.rb
+- lib/yabeda/datadog/adapter.rb
+- lib/yabeda/datadog/version.rb
+- yabeda-datadog.gemspec
+homepage: https://github.com/shvetsovdm/yabeda-datadog
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shvetsovdm/yabeda-datadog
+  source_code_uri: https://github.com/shvetsovdm/yabeda-datadog
+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: DataDog adapter for reporting metrics from Yabeda suite
+test_files: []