stackdriver-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 533a9f71ae4edea5f911cccabed44c57d995835c
+  data.tar.gz: 01e22c7b6dc3076574959bfa0c331e4fb2dfc831
+SHA512:
+  metadata.gz: 310c5eeeee1c05e092300d05233e8ec642636e343c3615998ab7ee56ab9358ecd31227b94c3a1db77b74c9585ec0df8eee5397c87d2ceee0c8c33ae62e35a1be
+  data.tar.gz: ae45d9fe4f9db5f8580bf3d10a920e8048f4710422eeb64b68d4d7fc4f6a7d0a07ef1ed27f1a6d11afb6e7af4fc87c34c8968ec9c99df754a77953fa84509d2a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'minitest', '~> 5.3.0'
+  gem 'webmock'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 balser
+
+MIT License
+
+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,88 @@
+# stackdriver-ruby
+
+A simple ruby toolkit for reporting metrics and events to [Stackdriver] endpoints.
+
+## installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stackdriver-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stackdriver-ruby
+
+## usage
+
+Set `STACKDRIVER_API_KEY` in your environment.  Errors are rescued by default in order to not break the application if reporting fails.  For debugging responses, you can call `Stackdriver.last_response` to inspect the previous response.
+
+**Reporting a [custom metric]**
+
+```ruby
+Stackdriver.custom(metric_name, value, collected_at, aws_instance_id)
+# => true
+```
+
+**Sending a [deploy event]**
+
+```ruby
+options = {
+  deployed_by: 'whodis',
+  deployed_to: 'production',
+  repository:  'foo'
+}
+
+Stackdriver.deploy_event('0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33', options)
+# => true
+```
+
+**Displaying an [annotation event]**
+
+```ruby
+options = {
+  level:        'WARN'        # INFO/WARN/ERROR (default INFO)
+  annotated_by: 'whodis'
+  instance_id:  'i-1234abcd',
+  event_epoch:  Time.now.to_i
+}
+
+Stackdriver.annotation_event('That just happened!', options)
+# => true
+```
+
+## examples
+
+  * [Using with delayed jobs.](https://github.com/balser/stackdriver-ruby/wiki/Example-using-with-delayed-jobs)
+
+## tk
+
+  * configureables (logger, agent, etc)
+  * tests
+
+## thank you
+
+The code structure an conventions are heavily influenced by the following gems:
+  * [octokit]
+  * [twitter]
+  * [instagram-ruby-gem]
+
+## contributing
+
+1. Fork it ( http://github.com/balser/stackdriver-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[stackdriver]: http://www.stackdriver.com/
+[custom metric]: http://feedback.stackdriver.com/knowledgebase/articles/181488-sending-custom-application-metrics-to-the-stackdri
+[deploy event]: http://feedback.stackdriver.com/knowledgebase/articles/212917-sending-code-deploy-events-to-stackdriver
+[annotation event]: http://feedback.stackdriver.com/knowledgebase/articles/260455-sending-annotation-events-to-stackdriver
+
+[octokit]: https://github.com/octokit/octokit.rb
+[instagram-ruby-gem]: https://github.com/Instagram/instagram-ruby-gem
+[twitter]: https://github.com/sferik/twitter

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs    << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end

data/lib/stackdriver.rb

@@ -0,0 +1,24 @@
+require 'stackdriver/client'
+
+#
+# Ruby toolkit for the reporting Stackdriver events and metrics.
+#
+module Stackdriver
+
+  class << self
+
+    def client
+      @client ||= Stackdriver::Client.new
+    end
+
+    private
+
+    #
+    # Delegate to the Stackdriver::Client.
+    #
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+  end
+end

data/lib/stackdriver/client.rb

@@ -0,0 +1,58 @@
+require 'stackdriver/client/custom'
+require 'stackdriver/client/deploy_event'
+require 'stackdriver/client/annotation_event'
+
+module Stackdriver
+  #
+  # Client for Stackdriver API
+  #
+  class Client
+    include Stackdriver::Client::Custom
+    include Stackdriver::Client::DeployEvent
+    include Stackdriver::Client::AnnotationEvent
+
+    STACKDRIVER_HOST = 'https://custom-gateway.stackdriver.com'.freeze
+
+    def last_response
+      @last_response
+    end
+
+    def clear
+      @last_response = nil
+    end
+
+    private
+
+    def conn
+      @conn ||= Faraday.new(url: STACKDRIVER_HOST) do |faraday|
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    #
+    # Send the metrics/event and return success boolean.
+    #
+    def request(method, endpoint, data)
+      begin
+        @last_response = conn.send(method) do |req|
+          req.url endpoint
+          req.body = MultiJson.dump(data)
+          req.headers['Content-Type']         = 'application/json'
+          req.headers['x-stackdriver-apikey'] = api_key
+          req.options[:timeout]               = 2
+          req.options[:open_timeout]          = 2
+        end
+
+        # TODO: Confirm whether 201 is the only success response.
+        @last_response.status == 201
+      rescue
+        false
+      end
+    end
+
+    def api_key
+      @api_key ||= ENV.fetch('STACKDRIVER_API_KEY', 'NullApiKey')
+    end
+
+  end
+end

data/lib/stackdriver/client/annotation_event.rb

@@ -0,0 +1,28 @@
+#
+# See:
+#   http://feedback.stackdriver.com/knowledgebase/articles/260455-sending-annotation-events-to-stackdriver
+#
+module Stackdriver
+  class Client
+    module AnnotationEvent
+
+      ENDPOINT = 'v1/annotationevent'.freeze
+
+      #
+      # Options:
+      #   :level (INFO/WARN/ERROR, default INFO)
+      #   :annotated_by
+      #   :instance_id
+      #   :event_epoch
+      #
+      def annotation_event(message, options={})
+        data = {
+          message: message,
+        }.merge(options)
+
+        request(:post, ENDPOINT, data)
+      end
+
+    end
+  end
+end

data/lib/stackdriver/client/custom.rb

@@ -0,0 +1,34 @@
+#
+# See: http://feedback.stackdriver.com/knowledgebase/articles/181488-sending-custom-application-metrics-to-the-stackdri
+#
+module Stackdriver
+  class Client
+    module Custom
+
+      ENDPOINT = 'v1/custom'.freeze
+
+      def custom(name, value, collected_at=Time.now.to_i, instance=nil)
+        data_point = {
+          name:         name,
+          value:        value,
+          collected_at: collected_at,
+          instance:     instance,
+        }
+
+        request(:post, ENDPOINT, gateway_message(data_point))
+      end
+
+      #
+      # Wraps the datapoint per doc.
+      #
+      def gateway_message(data)
+        {
+          data: data,
+          timestamp: Time.now.to_i,
+          proto_version: 1,
+        }
+      end
+
+    end
+  end
+end

data/lib/stackdriver/client/deploy_event.rb

@@ -0,0 +1,26 @@
+#
+# http://feedback.stackdriver.com/knowledgebase/articles/212917-sending-code-deploy-events-to-stackdriver
+#
+module Stackdriver
+  class Client
+    module DeployEvent
+
+      ENDPOINT = 'v1/deployevent'
+
+      #
+      # Options:
+      #   :deployed_by
+      #   :deployed_to
+      #   :repository
+      #
+      def deploy_event(revision_id, options={})
+        data = {
+          revision_id: revision_id,
+        }.merge(options)
+
+        request(:post, ENDPOINT, data)
+      end
+
+    end
+  end
+end

data/lib/stackdriver/version.rb

@@ -0,0 +1,3 @@
+module Stackdriver
+  VERSION = '0.0.1'
+end

data/stackdriver-ruby.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stackdriver/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'stackdriver-ruby'
+  spec.version       = Stackdriver::VERSION
+  spec.authors       = ['Brian Balser']
+  spec.email         = ['balser.brian@gmail.com']
+  spec.summary       = %q{A ruby client for Stackdriver metrics.}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',    '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_runtime_dependency     'multi_json', '~> 1.8'
+  spec.add_runtime_dependency     'faraday',    '~> 0.9'
+end

data/test/helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'stackdriver'
+

data/test/stackdriver/client/custom_test.rb

@@ -0,0 +1,11 @@
+require 'helper'
+
+describe Stackdriver::Client::Custom do
+
+  before do
+    Stackdriver.clear
+  end
+
+  it 'is testable'
+
+end

data/test/stackdriver_test.rb

@@ -0,0 +1,5 @@
+require 'helper'
+
+describe Stackdriver do
+  it 'is testable'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: stackdriver-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Balser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email:
+- balser.brian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stackdriver.rb
+- lib/stackdriver/client.rb
+- lib/stackdriver/client/annotation_event.rb
+- lib/stackdriver/client/custom.rb
+- lib/stackdriver/client/deploy_event.rb
+- lib/stackdriver/version.rb
+- stackdriver-ruby.gemspec
+- test/helper.rb
+- test/stackdriver/client/custom_test.rb
+- test/stackdriver_test.rb
+homepage: ''
+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.2.0
+signing_key: 
+specification_version: 4
+summary: A ruby client for Stackdriver metrics.
+test_files:
+- test/helper.rb
+- test/stackdriver/client/custom_test.rb
+- test/stackdriver_test.rb