cephdetail 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 364735d754c347eb09d3adfd7fdc7fb50506d5f3
+  data.tar.gz: ddf6b8b562489dc34421ea8800aa55c177f1cee1
+SHA512:
+  metadata.gz: eff00ba84e172ab1ea811ac899b019d9c27e698390855fdb258439bd566fabd29319b4fc1162bf4ff952f5b12f080c556a89419fdb257c547ce0c56d35dfde02
+  data.tar.gz: a1d4a26720c8cc02748b039b34cb237eeb0955a26f010fee3c30771364b4f30bba3a0ad5ecbf127ce5b66228ab77e6470c828607a5f65c301522a7d4e0891ad0

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+.idea/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 xnoder
+
+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,62 @@
+# Cephdetail
+
+`Cephdetail` fetches Ceph capacity and monitoring data from the Ceph REST API, and returns the responses as
+Ruby Hashes to be used in other code.
+
+I initially wrote this to integrate with my LogStash plugin, `logstash-input-ceph`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cephdetail'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cephdetail
+
+## Usage
+
+Using `cephdetail` is very straight forward. First though, you'll need an environment variable called
+`CEPH_REST_API` so that the gem can find the URL of your WSGI service, such as `http://localhost:5000`.
+
+Here's an example:
+
+```ruby
+require 'cephdetail'
+
+health = Cephdetail::Health.new
+    
+df = health.df
+status = health.status
+osdstat = health.osdstat
+```
+
+What you get back are hashes constructed from the JSON returned by the API. The methods mock the following `ceph`
+client commands:
+
+* `df` = `ceph df`
+* `status` = `ceph status`
+* `osdstat` = `ceph osd stat`
+
+## 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/xnoder/cephdetail.
+
+
+## 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/cephdetail.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cephdetail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cephdetail'
+  spec.version       = Cephdetail::VERSION
+  spec.authors       = ['Paul Stevens']
+  spec.email         = ['ps@xnode.co.za']
+
+  spec.summary       = %q{A gem that polls Ceph REST API for health information.}
+  spec.description   = %q{This gem relies on the presence of a Ceph REST API server to pull down and parse health information for your Ceph cluster.}
+  spec.homepage      = 'https://github.com/xnoder/cephdetail'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rest-client', '~> 1.8.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

data/lib/cephdetail/version.rb

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

data/lib/cephdetail.rb

@@ -0,0 +1,62 @@
+# This gem gathers health data from the Ceph REST API web service, returning information similar to the
+# 'ceph health detail' command. You need to have a WSGI script wrapping a 'ceph_rest_api' application handler
+# within a web server of your choice to expose the endpoints required. This gem has been written to work hand-in-hand
+# with my logstash-input-ceph plugin.
+#
+# Author:: Paul Stevens (mailto:ps@xnode.co.za)
+# Copyright:: Copyright (c) 2015 Paul Stevens
+# License:: Distributed under the MIT License
+
+require 'cephdetail/version'
+require 'json'
+require 'rest-client'
+
+module Cephdetail
+
+  # The Health class exposes health data from the /detail endpoint of the Ceph REST API.
+  #
+  # Example:
+  #   >> health = Cephdetail::Health.new
+  #   >> df = health.df
+  #   >> status = health.status
+  #   >> osdstat = health.osdstat
+
+  class Health
+
+    # Fetch the URL for the Ceph REST API server in your environment
+    def initialize
+      @api_url = ENV['CEPH_REST_API']
+    end
+
+    public
+
+    # Return disk usage stats (ceph df) in the form of a Ruby Hash for manipulation by other code/applications.
+    # Uses the private check(attrib) method to make the HTTP request.
+    def df
+      return check("df")
+    end
+
+    # Return /status data (ceph -s) in the form of a Ruby Hash for manipulation by other code/applications.
+    # Uses the private check(attrib) method to make the HTTP request.
+    def status
+      return check("status")
+    end
+
+    # Return  /osd/stat data (ceph osd stat) in the form of a Ruby Hash for manipulation by other code/applications.
+    # Uses the private check(attrib) method to make the HTTP request.
+    def osdstat
+      return check("osd/stat")
+    end
+
+    private
+
+    # Send a request to the Ceph REST API and convert the response into a Ruby Hash.
+    def check(attrib)
+      url = "#{@api_url}/api/v0.1/#{attrib}"
+      request = RestClient.get "#{url}", { :accept => :json }
+      return JSON.parse(request)
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: cephdetail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Stevens
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem relies on the presence of a Ceph REST API server to pull down
+  and parse health information for your Ceph cluster.
+email:
+- ps@xnode.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cephdetail.gemspec
+- lib/cephdetail.rb
+- lib/cephdetail/version.rb
+homepage: https://github.com/xnoder/cephdetail
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A gem that polls Ceph REST API for health information.
+test_files: []