alerty-plugin-stackdriver 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dfe5672c5435de5e687dde50cb6f59456e8b57b6
+  data.tar.gz: 0ea6b49908522bf2d8ed2b03b333f4f0ff22456f
+SHA512:
+  metadata.gz: 3f661c604da93e10943ee3cec15e1bffaff8093cc1bc2bd4f1ffa8dde10478aed3e6397112cdfac326dddc263e2eba97989b25c12bf0f2e3f1a563c608224b95
+  data.tar.gz: 2f0d435a6135995b035f327f9810bd34ce79c1ab475fcffc1879201a42d9d0935009eec37091eef06c0b9d2f232194446c016042a104f5984e92747b4f57bd59

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,40 @@
+# Alerty::Plugin::Stackdriver
+
+Google Stackdriver plugin for alerty (https://github.com/sonots/alerty)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alerty-plugin-stackdriver'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install alerty-plugin-stackdriver
+
+## Configuration
+
+* **type**: must be `stackdriver`.
+* **keyfile**: service account keyfile path.
+* **project_id**: your GCP project id.
+* **log_name**: Stackdriver log name.
+* **resource_type**: Stackdriver Logging monitored resource types. https://cloud.google.com/logging/docs/api/v2/resource-list
+* **resource_labels**: Stackdriver Logging monitored resource labels. https://cloud.google.com/logging/docs/api/v2/resource-list
+* **message**: message of alert. `${command}` is replaced with a given command, `${hostname}` is replaced with the hostname ran the command, `${output}` is replaced with the output. The default is `${output}`.
+
+## 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/potato2003/alerty-plugin-stackdriver.
+

data/Rakefile

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

data/alerty-plugin-stackdriver.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = "alerty-plugin-stackdriver"
+  spec.version       = "0.1.0"
+  spec.authors       = ["potato2003"]
+  spec.email         = ["potato2003@gmail.com"]
+
+  spec.summary       = "Google Stackdriver plugin for alerty"
+  spec.description   = "Google Stackdriver plugin for alerty"
+  spec.homepage      = "https://github.com/potato2003/alerty-plugin-stackdriver"
+
+  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.license       = 'MIT'
+
+  spec.add_runtime_dependency "alerty"
+  spec.add_runtime_dependency "google-cloud-logging", "~> 1.5"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "alerty/plugin/stackdriver"
+
+# 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/example_config.yml

@@ -0,0 +1,11 @@
+log_path: STDOUT
+log_level: debug
+plugins:
+  - type: stackdriver
+    keyfile: "example_keyfile.json"
+    project_id: "example_project"
+    log_name: "example_alerty_log"
+    resource_type: "gae_app"
+    resource_labels:
+      module_id: "1"
+      version_id: "20150925t173233"

data/lib/alerty/plugin/stackdriver.rb

@@ -0,0 +1,86 @@
+require 'alerty'
+require "google/cloud/logging"
+
+class Alerty
+  class Plugin
+    class Stackdriver
+
+      DEFAULT_NUM_OF_RETIRES = 3
+
+      def initialize(config)
+        # https://cloud.google.com/logging/docs/api/v2/resource-list
+        @resource_type   = config.resource_type
+        @resource_labels = config.resource_labels
+        @log_name        = config.log_name || 'alerty'
+        @message         = config.message
+        @num_retries     = config.num_retries || DEFAULT_NUM_OF_RETIRES
+
+        @stackdriver = Google::Cloud::Logging.new(
+          project_id: config.project_id,
+          keyfile:    config.keyfile ? ensure_keyfile(config.keyfile) : nil
+        )
+      end
+
+      def alert(record)
+        entry = make_entry(record)
+
+        retrable(tries: @num_retries) do
+          @stackdriver.write_entries(entry)
+          Alerty.logger.info "Sent #{{log_entry: entry.inspect}} to #{@log_name}"
+        end
+      end
+
+    private
+      def retrable(options = {}, &block)
+        tries = options[:tries] || DEFAULT_NUM_OF_RETIRES
+
+        retries = 0
+        begin
+          yield
+        rescue => e
+          retries += 1
+          sleep 1
+          if retries <= tries
+            retry
+          else
+            raise e
+          end
+        end
+      end
+
+      def make_entry(record)
+        e = @stackdriver.entry
+
+        e.resource.type   = @resource_type
+        e.resource.labels = @resource_labels if @resource_labels
+        e.log_name        = @log_name
+        e.payload         = payload(record)
+
+        e
+      end
+
+      def payload(record)
+        if @message
+          expand_placeholder(@message, record)
+        else
+          record[:output]
+        end
+      end
+
+      def expand_placeholder(str, record)
+        replaced = str.gsub('${command}', record[:command])
+        replaced.gsub!('${hostname}', record[:hostname])
+        replaced.gsub!('${output}', record[:output])
+        replaced
+      end
+
+      def ensure_keyfile(v)
+        if v.is_a?(String)
+          v
+        elsif v.is_a?(Hash)
+          JSON.parse(v['content'])
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: alerty-plugin-stackdriver
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- potato2003
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: alerty
+  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: google-cloud-logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: Google Stackdriver plugin for alerty
+email:
+- potato2003@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- alerty-plugin-stackdriver.gemspec
+- bin/console
+- bin/setup
+- example_config.yml
+- lib/alerty/plugin/stackdriver.rb
+homepage: https://github.com/potato2003/alerty-plugin-stackdriver
+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: Google Stackdriver plugin for alerty
+test_files: []