influxdb-process 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1392cd9aa1f34ccf439ff3be4ff7e353b0a8a177
+  data.tar.gz: 455bb5e9016eb0676137b946b7c1460a4a2a3a9a
+SHA512:
+  metadata.gz: d00fe0f8b62f6f674f47d6ab2d4eea9dce08233a826480df24e796be9e1ffb889f2023ad8270db185d99febd26fd8ba745aa76d472ec199a4172be6fee0330a1
+  data.tar.gz: 0d355f43aaf1344a266ed51c8f2da64eecb205d389588d8a0b9a1d96f40c1079f80f572301681ca152f0fca30b82211eaddf390198ca8f26d52afcef0349b243

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in influxdb-process.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ilya Vassilevsky
+
+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/Makefile

@@ -0,0 +1,2 @@
+points:
+	bundle exec ruby test/process.rb

data/README.md

@@ -0,0 +1,77 @@
+# InfluxDB::Process
+
+Gathers metrics from the Ruby process it is executed in and sends them to an InfluxDB database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'influxdb-process'
+```
+
+And then execute:
+
+    $ bundle
+
+Or do all this at once:
+
+    $ bundle add influxdb-process
+
+## Usage
+
+This library assumes that you already have a working InfluxDB client instance.
+It does not attempt to create one for you.
+If not, see [InfluxDB Ruby](https://github.com/influxdata/influxdb-ruby) for client initialization instructions.
+Let's say you have the client in the `influxdb` variable, as it says.
+
+Add this to any place in your Ruby program:
+
+```ruby
+InfluxDB::Process::Instrumentation.new(influxdb)
+```
+
+When you deploy this, the process where this code is executed will create a new thread.
+It will periodically collect process metrics and send them to InfluxDB via the provided client.
+
+By default, metrics will be written to the `process_metrics` series every *10* seconds.
+You can set your own series name and interval via additional keyword arguments:
+
+```ruby
+InfluxDB::Process::Instrumentation.new(influxdb, series: 'ruby_stats', interval: 42)
+```
+
+Metrics will be tagged with process name.
+By default, `$0`/`$PROGRAM_NAME` will be used.
+You can set your own process name via an additional keyword argument:
+
+```ruby
+InfluxDB::Process::Instrumentation.new(influxdb, process: 'report_generator')
+```
+
+You can also set the `INFLUXDB_PROCESS_NAME` environment variable:
+
+    INFLUXDB_PROCESS_NAME=cache_cleaner bundle exec ruby ...
+
+It will take precedence over the keyword argument.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+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`
+* Run `bundle exec rake release`, which will do the following:
+  * create a git tag for the version
+  * push git commits and tags
+  * push the `.gem` file to [rubygems.org](https://rubygems.org)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vassilevsky/influxdb-process
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/influxdb-process.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "influxdb/process/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "influxdb-process"
+  spec.version       = InfluxDB::Process::VERSION
+  spec.authors       = ["Ilya Vassilevsky"]
+  spec.email         = ["vassilevsky@gmail.com"]
+
+  spec.summary       = "Ruby process instrumentation to an InfluxDB database"
+  spec.homepage      = "https://github.com/vassilevsky/influxdb-process"
+  spec.license       = "MIT"
+
+  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_dependency "influxdb"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/influxdb/process/version.rb

@@ -0,0 +1,5 @@
+module InfluxDB
+  module Process
+    VERSION = "0.1.0"
+  end
+end

data/lib/influxdb/process.rb

@@ -0,0 +1,19 @@
+require "influxdb"
+require "influxdb/process/version"
+
+module InfluxDB
+  module Process
+    class Instrumentation
+      def initialize(influxdb, series: 'process_metrics', interval: 10, process: nil)
+        @process = ENV['INFLUXDB_PROCESS_NAME'] || process || $PROGRAM_NAME
+
+        Thread.new do
+          loop do
+            influxdb.write_point(series, tags: {process: @process}, values: GC.stat)
+            sleep(interval)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: influxdb-process
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ilya Vassilevsky
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: influxdb
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: 
+email:
+- vassilevsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- influxdb-process.gemspec
+- lib/influxdb/process.rb
+- lib/influxdb/process/version.rb
+homepage: https://github.com/vassilevsky/influxdb-process
+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.13
+signing_key: 
+specification_version: 4
+summary: Ruby process instrumentation to an InfluxDB database
+test_files: []