cassandra-utils 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 676b1a4ee9e342140298782e820f8febaf32c40b
+  data.tar.gz: 6aa8c650bbcd8b5c7e666a54a6c5d7c8446df1c4
+SHA512:
+  metadata.gz: 0fc348a064d31d9e7de6af588fe8ac2874064ba2877532f2228046149b46f766d16eac1980e8df4755e227c797f5e47d997b0b397bdf6363eca67adfc56540dd
+  data.tar.gz: 5c0d332b6cf818fb753ba58bce6b32c7aacc9da3e1d8f4d2f78ef8ca34b196ac19923044606551f9052360cd332ba98f98205c8d0c3a9202928e62749fdbd45f

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at Andrew_Thompson@rapid7.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cassandra-utils.gemspec
+gemspec
+
+group :development do
+  gem 'bundler', '~> 1.7'
+  gem 'thor-scmversion', '= 1.7.0'
+end

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    cassandra-utils (0.0.1)
+      daemon_runner (~> 0.2)
+      dogstatsd-ruby (~> 1.6)
+      mixlib-shellout (~> 2.2)
+      thor (~> 0.19)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    daemon_runner (0.2.2)
+      logging (~> 2.1)
+      mixlib-shellout (~> 2.2)
+    dogstatsd-ruby (1.6.0)
+    little-plugger (1.1.4)
+    logging (2.1.0)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
+    minitest (5.9.0)
+    mixlib-shellout (2.2.7)
+    multi_json (1.12.1)
+    rake (10.5.0)
+    thor (0.19.1)
+    thor-scmversion (1.7.0)
+      mixlib-shellout
+      thor
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  cassandra-utils!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  thor-scmversion (= 1.7.0)

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Andrew Thompson
+
+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,48 @@
+# Cassandra::Utils
+
+This is a utility for gathering data about the state of a Cassandra node and reporting metrics about that state.
+
+The utility is composed of a collection of discrete _tasks_.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cassandra-utils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cassandra-utils
+
+## Usage
+
+```bash
+bin/cass-util stats
+```
+
+## Adding tasks
+
+Add a file under `lib/cassandra/utils/` and add that new Class to [Cassandra::Utils::Daemon#tasks](/lib/cassandra/utils/daemon.rb).
+
+You can subclass [Cassandra::Utils::CLI::Base](/lib/cassandra/utils/cli/base.rb) to simplify running shell commands and sending stats to Datadog.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/rapid7/cassandra-utils. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/Thorfile

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+require 'bundler'
+require 'bundler/setup'
+require 'thor/scmversion'

data/bin/cass-util

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require_relative '../lib/cassandra/utils'
+require 'thor'
+
+class CassandraUtils < Thor
+
+  method_option :loop_sleep_time, type: :numeric,
+    required: true, default: 120,
+    desc: 'Frequency tasks are run'
+  desc 'stats', 'Write metrics to Datadog'
+  def stats
+    s = ::Cassandra::Utils::Daemon.new(options)
+    s.start!
+  end
+end
+
+CassandraUtils.start

data/bin/console

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

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/cassandra-utils.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cassandra/utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cassandra-utils"
+  spec.version       = Cassandra::Utils::VERSION
+  spec.authors       = ["Andrew Thompson"]
+  spec.email         = ["Andrew_Thompson@rapid7.com"]
+
+  spec.summary       = %q{Utility to manage Cassandra Monitoring and Management}
+  spec.homepage      = "https://github.com/rapid7/cassandra-utils"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = ["cass-util"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mixlib-shellout", "~> 2.2"
+  spec.add_dependency "dogstatsd-ruby", "~> 1.6"
+  spec.add_dependency "thor", "~> 0.19"
+  spec.add_dependency "daemon_runner", "~> 0.2"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/cassandra/utils/cli/base.rb

@@ -0,0 +1,52 @@
+require 'mixlib/shellout'
+require 'statsd'
+
+module Cassandra
+  module Utils
+    module CLI
+      class Base
+        attr_reader :command, :stdout
+
+        def cwd
+          '/tmp'
+        end
+
+        def timeout
+          15
+        end
+
+        def runner
+          @command ||= Mixlib::ShellOut.new(command, :cwd => cwd, :timeout => timeout)
+        end
+
+        def output
+          raise NotImplementedError, 'Must implement this in a subclass'
+        end
+
+        def run!
+          runner
+          @command.run_command
+          @command.error!
+          @stdout = @command.stdout
+          out = output
+          push_metric(out)
+          out
+        end
+
+        protected
+
+        def statsd
+          @statsd ||= ::Statsd.new('localhost', 8125)
+        end
+
+        def push_metric(value)
+          statsd.gauge(metric_name, value)
+        end
+
+        def to_dd(out)
+          out == true ? 1 : 0
+        end
+      end
+    end
+  end
+end

data/lib/cassandra/utils/daemon.rb

@@ -0,0 +1,15 @@
+require 'daemon_runner'
+
+module Cassandra
+  module Utils
+    class Daemon < ::DaemonRunner::Client
+
+      def tasks
+        [
+          [::Cassandra::Utils::Stats::Compaction.new, 'run!'],
+          [::Cassandra::Utils::Stats::Cleanup.new, 'run!']
+        ]
+      end
+    end
+  end
+end

data/lib/cassandra/utils/stats/cleanup.rb

@@ -0,0 +1,21 @@
+module Cassandra
+  module Utils
+    module Stats
+      class Cleanup < Utils::CLI::Base
+
+        def command
+          'nodetool compactionstats'
+        end
+
+        def output
+          cleanup = stdout.lines.any? { |l| l.include?('Cleanup') }
+          to_dd(cleanup)
+        end
+
+        def metric_name
+          'cassandra.cleanup.running'
+        end
+      end
+    end
+  end
+end

data/lib/cassandra/utils/stats/compaction.rb

@@ -0,0 +1,21 @@
+module Cassandra
+  module Utils
+    module Stats
+      class Compaction < Utils::CLI::Base
+
+        def command
+          'nodetool compactionstats'
+        end
+
+        def output
+          compaction = stdout.lines.any? { |l| l.include?('Compaction') }
+          to_dd(compaction)
+        end
+
+        def metric_name
+          'cassandra.compaction.running'
+        end
+      end
+    end
+  end
+end

data/lib/cassandra/utils/stats.rb

@@ -0,0 +1,2 @@
+require_relative 'stats/compaction'
+require_relative 'stats/cleanup'

data/lib/cassandra/utils/version.rb

@@ -0,0 +1,5 @@
+module Cassandra
+  module Utils
+    VERSION = IO.read(File.expand_path('../../../../VERSION', __FILE__)) rescue '0.0.1'
+  end
+end

data/lib/cassandra/utils.rb

@@ -0,0 +1,3 @@
+require_relative 'utils/cli/base'
+require_relative 'utils/daemon'
+require_relative 'utils/stats'

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: cassandra-utils
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mixlib-shellout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: daemon_runner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- Andrew_Thompson@rapid7.com
+executables:
+- cass-util
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- Thorfile
+- bin/cass-util
+- bin/console
+- bin/setup
+- cassandra-utils.gemspec
+- lib/cassandra/utils.rb
+- lib/cassandra/utils/cli/base.rb
+- lib/cassandra/utils/daemon.rb
+- lib/cassandra/utils/stats.rb
+- lib/cassandra/utils/stats/cleanup.rb
+- lib/cassandra/utils/stats/compaction.rb
+- lib/cassandra/utils/version.rb
+homepage: https://github.com/rapid7/cassandra-utils
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Utility to manage Cassandra Monitoring and Management
+test_files: []