como_client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae20fe23f326d495c7edf5f443930b2367aed444
+  data.tar.gz: b93f69e2785a6555fe7c98d9cc8827f8453c6cd8
+SHA512:
+  metadata.gz: ddb4bcbc381b9c3fc9697e1a778e284fdcac72af88c4d5387902fb3a85753f5ee59574417c896865779c8a979844cdd7828c7afb081af3be529ba687c87c78ed
+  data.tar.gz: 0f33065ad30d448a07731b570cf102e639b80bd19f1ff98e47505ba06c895c82d7d82ab16719adc9888c75ecd9ef901dabf201f6f06a6a2a3b6fe06c3b11dad2

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at Colin.Disler1@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Disler Colin, INI-DEV-APO-CAU-LFA
+
+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,34 @@
+# COMOClient
+
+If you work in a Cloud Foundry environment and want to actively push your Prometheus Metrics in a certain interval, you definitely have to try the **COMO Client** Gem!
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'COMO_Client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install COMO_Client
+
+## Usage
+
+```
+# config/initializers/como_client.rb
+
+COMOClient.configure do |config|
+  config.enabled = true
+  config.push_interval = 10
+  config.pushgateway_url = "https://your-app.some-prometheus-pushgateway.com"
+  config.job_name = "your-app-metrics"
+  config.instance_name = "your-app-metrics-1"
+end
+```

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/bin/console

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

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'como_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "como_client"
+  spec.version       = COMOClient::VERSION
+  spec.authors       = ["Disler Colin"]
+  spec.email         = ["Colin.Disler@gmail.com"]
+
+  spec.summary       = "A Prometheus Client for continuous monitoring"
+  spec.description   = "A Prometheus Client for continuous monitoring"
+  spec.homepage      = "https://github.com/lombold/COMO_Client"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against" \
+      "public gem pushes."
+  end
+
+  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.add_development_dependency 'rspec'
+  spec.add_dependency 'concurrent-ruby'
+  spec.add_dependency 'prometheus-client'
+  spec.add_dependency 'usagewatch_ext'
+  spec.add_dependency 'mem_info'
+end

data/lib/como_client.rb

@@ -0,0 +1,57 @@
+require 'como_client/version'
+require 'como_client/configuration'
+require 'como_client/tasks/periodic_push'
+require 'como_client/tasks/observer'
+require 'como_client/metrics'
+require 'como_client/metrics/cf'
+require 'concurrent'
+require 'rack'
+require 'prometheus/middleware/exporter'
+require 'prometheus/middleware/collector'
+
+module COMOClient
+
+  class Railtie < Rails::Railtie
+    initializer 'como_client.configure_rails_initialization' do
+      Rails.configuration.middleware.use Prometheus::Middleware::Collector
+      Rails.configuration.middleware.use Prometheus::Middleware::Exporter
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+    self.run
+  end
+
+  def self.run
+    logger = Logger.new(STDOUT)
+    logger.info("initialize metrics push service...")
+    if @pushTask and @pushTask.running?
+      logger.info("the metrics push service is already running!")
+      return true
+    end
+
+    COMOClient::Metrics.register
+    @pushTask = Concurrent::TimerTask.new(execution_interval: 20, timeout_interval: 20){COMOClient::Tasks::PeriodicPush.push}
+    @pushTask.add_observer(COMOClient::Tasks::Observer.new)
+    @pushTask.execute
+    logger.info("successfully initiated metrics push service!")
+    @pushTask.running?
+  end
+
+  def self.stop
+    @pushTask.shutdown
+  end
+end

data/lib/como_client/configuration.rb

@@ -0,0 +1,18 @@
+module COMOClient
+    class Configuration
+      attr_accessor  :enabled
+      attr_accessor  :push_interval
+      attr_accessor  :pushgateway_url
+      attr_accessor  :job_name
+      attr_accessor  :instance_name
+
+      def initialize
+        @enabled = false
+        @push_interval = 20
+        @pushgateway_url = "https://example.com"
+        @job_name = "prometheus-metrics"
+        @instance_name = "prometheus-metrics#0"
+      end
+
+    end
+end

data/lib/como_client/metrics.rb

@@ -0,0 +1,23 @@
+module COMOClient
+  module Metrics
+    def self.register
+      logger = Logger.new(STDOUT)
+      logger.info("register metrics...")
+
+      #Register Cloud Froundry metrics if the app is pushed to Cloud Foundry
+      COMOClient::Metrics::CF.register if !ENV["CF_INSTANCE_GUID"].nil?
+
+      logger.info("registered metrics")
+    end
+
+    def self.update
+      logger = Logger.new(STDOUT)
+      logger.info("update metrics...")
+
+      #Update Cloud Froundry metrics if the app is pushed to Cloud Foundry
+      COMOClient::Metrics::CF.update if !ENV["CF_INSTANCE_GUID"].nil?
+
+      logger.info("updated metrics")
+    end
+  end
+end

data/lib/como_client/metrics/cf.rb

@@ -0,0 +1,42 @@
+module COMOClient
+  module Metrics
+    class CF
+
+      require 'usagewatch_ext'
+      require 'mem_info'
+
+      def self.register
+        logger = Logger.new(STDOUT)
+        logger.info("register CF metrics...")
+
+        prometheus =  Prometheus::Client.registry
+
+        hardwareGauges = Prometheus::Client::Gauge.new(:instance_metrics, 'instance hardware metrics')
+        prometheus.register(hardwareGauges)
+        logger.info("registered hardware gauges")
+
+        logger.info("registered CF metrics")
+      end
+      def self.update
+        logger = Logger.new(STDOUT)
+        logger.info("update CF metrics...")
+        prometheus =  Prometheus::Client.registry
+
+        usw = Usagewatch
+        mem = MemInfo.new
+        hardwareGauges = prometheus.get(:instance_metrics)
+        hardwareGauges.set({ hardware: 'cpu'}, usw.uw_cpuused)
+        hardwareGauges.set({ hardware: 'avg_load_past_minute'}, usw.uw_load)
+        hardwareGauges.set({ hardware: 'memory_total'}, mem.memtotal)
+        hardwareGauges.set({ hardware: 'memory_free'}, mem.memfree)
+        hardwareGauges.set({ hardware: 'memory_used'}, mem.memused)
+        hardwareGauges.set({ hardware: 'disk_used_perc'}, usw.uw_diskused_perc)
+        hardwareGauges.set({ hardware: 'disk_used_gigabytes'}, usw.uw_diskused)
+        hardwareGauges.set({ hardware: 'uptime_seconds'}, IO.read('/proc/uptime').split[0].to_i)
+        logger.info("instance gauges")
+
+        logger.info("updated CF metrics")
+      end
+    end
+  end
+end

data/lib/como_client/tasks/observer.rb

@@ -0,0 +1,15 @@
+module COMOClient
+  module Tasks
+    class Observer
+      def update(_time, result, ex)
+        if result
+          Rails.logger.info "Execution successfully returned #{result}\n"
+        elsif ex.is_a?(Concurrent::TimeoutError)
+          Rails.logger.fatal "Execution timed out\n"
+        else
+          Rails.logger.fatal "Execution failed with error #{ex}\n"
+        end
+      end
+    end
+  end
+end

data/lib/como_client/tasks/periodic_push.rb

@@ -0,0 +1,21 @@
+module COMOClient
+  module Tasks
+    class PeriodicPush
+      require 'prometheus/client'
+      require 'prometheus/client/push'
+      def self.push
+        # register some metrics
+        logger = Logger.new(STDOUT)
+        logger.info("pushing metrics to #{COMOClient.configuration.pushgateway_url}")
+        logger.info("job: #{COMOClient.configuration.job_name}")
+        logger.info("instance: #{COMOClient.configuration.instance_name}")
+        COMOClient::Metrics.update
+        Prometheus::Client::Push.new(COMOClient.configuration.job_name, #job name
+                                     COMOClient.configuration.instance_name,#instance name
+                                     COMOClient.configuration.pushgateway_url)#pushgateway url
+                                .add(Prometheus::Client.registry)
+        logger.info("successfully pushed metrics")
+      end
+    end
+  end
+end

data/lib/como_client/version.rb

@@ -0,0 +1,3 @@
+module COMOClient
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: como_client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Disler Colin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-14 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  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: prometheus-client
+  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: usagewatch_ext
+  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: mem_info
+  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'
+description: A Prometheus Client for continuous monitoring
+email:
+- Colin.Disler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- como_client.gemspec
+- lib/como_client.rb
+- lib/como_client/configuration.rb
+- lib/como_client/metrics.rb
+- lib/como_client/metrics/cf.rb
+- lib/como_client/tasks/observer.rb
+- lib/como_client/tasks/periodic_push.rb
+- lib/como_client/version.rb
+homepage: https://github.com/lombold/COMO_Client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: A Prometheus Client for continuous monitoring
+test_files: []