falcore 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 356afec14b000ddb9e068d639eab296b344514d6
+  data.tar.gz: 6b4657fb96b8bf9b0c4749db5a37e9b257fb83c0
+SHA512:
+  metadata.gz: 2e398c709c8043b8d1838165265e44f603f19f758330130c2e167bed3b105cd52887493c113fd7437b16f5ce79b30d70415d7a5c300861cf9c6c05bcb81f2a1b
+  data.tar.gz: f3dda634c7c44ca7e345112c1a5f6c4651e3b8b838b4473147ff22543beb9400e5ae198978b3e1309580b473b12a3c71f31515048a0d55766bc68cd866e159d0

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,19 @@
+rvm:
+  - 2.0.0
+  - 2.1
+
+branches:
+  only:
+    - master
+
+bundler_args: --jobs 7 --without local
+
+script: bundle exec rake travis:ci
+
+notifications:
+  hipchat:
+    rooms:
+      # Build Statuses
+      - secure: CBUBLee7cX9vTx1dPUKOHjmq685nR5s+FXMc/8qtUJfUrHj3u5i2IUsTXQi2TrsRwovi7vecoLHjqFC35XHy+oy8aMGJPvO5Eq3UOPy5TuDbGfA5nt7WfLUSindZ4UksyH65DXq2QP0oxXmgM9HyDEGuFpHOBnzL3pv7twpKWeU=
+      # Release Engineering
+      - secure: PynSuUxkuTSkmfnq1toBN8wUQ1fovveJtlRj7PHC0yPKk5h7fsywu7QwAzs5snoCIOBmPsXT/k3AUucjaTcANWfgSlot8Ur9vcQiDC4rW8F7C2YPMYJCsR2k4djI2XDY6v6Yx8jmT8k20ctkV32lKaZKUFQd13tYmTwp3fHjGck=

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec
+
+group :local do
+  gem 'pry'
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2014 Chef Software, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,98 @@
+Falcore
+=======
+[![Build Status](https://magnum.travis-ci.com/opscode/falcore.svg?token=xjv5yxmcgdD1zvpeR4me&branch=master)](https://magnum.travis-ci.com/opscode/falcore)
+
+Falcore is a Ruby gem for aggregating system information from the Jenkins API.
+
+
+Installation
+------------
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'falcore'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install falcore
+```
+
+
+Vocabulary
+----------
+- _aggregator_ - takes information from the Jenkins master about itself and
+child slaves and converts the information into Ruby objects
+- _dumper_ - converts Ruby objects into an output format (such as Nagios or
+StatsD)
+
+
+Usage
+-----
+1. Create a Falcore configuration file somewhere on disk:
+
+  ```text
+  [jenkins]
+    endpoint = https://localhost:8889
+  ```
+
+  You must add the `jenkins.endpoint` configuration value. This tells Falcore
+  where to query Jenkins for information. You should include the protocol, host
+  or IP address, port, and proxy if applicable.
+
+2. Add configuration for each "dumper" you would like to use. The configuration
+varies by dumper, so consult the documentation accordingly:
+
+  ```text
+  [jenkins]
+    endpoint = https://localhost:8889
+
+  [statsd]
+    host = 127.0.0.1
+    port = 8824
+
+  [nagios]
+    host = https://my.nagios.server
+  ```
+
+3. Run Falcore:
+
+  Foreground:
+
+  ```bash
+  falcore --config /path/to/your/config.falcore
+  ```
+
+  As a daemon:
+
+  ```bash
+  falcore --config /path/to/your/config.falcore --daemon
+  ```
+
+
+License & Authors
+-----------------
+- Author: Seth Vargo (<sethvargo@gmail.com>)
+
+```text
+Copyright 2014 Chef Software, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :travis do
+  desc 'Run tests on Travis'
+  task ci: ['spec']
+end
+
+task default: ['travis:ci']

data/bin/falcore

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+
+# Trap interrupts to quit cleanly
+Signal.trap('INT') { abort }
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# Store a list of options given by the OptionParser
+options = {
+  sleep: 1_000,
+}
+
+# Make our OptionParser (we haven't loaded Falcore yet)
+require 'optparse'
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$PROGRAM_NAME} [OPTIONS]"
+
+  opts.on('-c', '--config [PATH]', 'Path to a Falcore config') do |path|
+    options[:config] = File.expand_path(path, Dir.pwd)
+  end
+
+  opts.on('-d', '--daemon', 'Run process as a daemon') do
+    options[:daemon] = true
+  end
+
+  opts.on('-s', '--sleep', 'Time (ms) to sleep before recalculating') do |value|
+    options[:sleep] = value
+  end
+
+  opts.on_tail('-h', '--help', 'Show this message') do
+    puts opts
+    exit(0)
+  end
+
+  opts.on_tail('-v', '--version', 'Show current Falcore version') do
+    require 'falcore/version'
+    puts Falcore::VERSION
+    exit(0)
+  end
+end
+
+# Parse the options
+begin
+  parser.parse!
+
+  # Raise an exception if we have not be given a config path
+  raise OptionParser::MissingArgument, '--config' if options[:config].nil?
+rescue OptionParser::InvalidOption,
+       OptionParser::MissingArgument => e
+  puts e.to_s
+  puts
+  puts parser
+  exit(1)
+end
+
+# If we got this far, we should actually load up Falcore
+require 'falcore'
+
+# Load the config before looping. If you change the config, restart the process.
+# Config parsing is rather expensive.
+config = Falcore::Config.from_file(options[:config])
+
+# Run as a daemon if we asked to
+if options[:daemon]
+  Process.daemon(true)
+end
+
+# Just keep swimming...
+loop do
+  master = Falcore::Aggregator.new(config).run
+
+  unless config.statsd.nil?
+    Falcore::Dumper::Statsd.new(config, master).run
+  end
+
+  sleep(options[:sleep]/1_000)
+end