netuitive_ruby_api 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f9fd50b6af094acec6d0cd7ac6c5ea72a630966
+  data.tar.gz: 1c108561b3c14066709454e753f54b498e6e33a0
+SHA512:
+  metadata.gz: 220754c8c9e404a8df135d3f430e2103661506394b3fcef9b621e4175d53f782b970b90d04bfda981f7b84d2b18921c97ad9afcb0a012edc6a70a18d424e6097
+  data.tar.gz: f78e95ce4110a311821099b1308c47a4e5f50634cb4c04e81de6fc5c365bae07be2adbb18e92e3ac2eb500f3a454045abe17089bb7d526b153c59cec242d70b4

data/LICENSE

@@ -0,0 +1,202 @@
+                                 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 {yyyy} {name of copyright owner}
+
+   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/config/agent.yml

@@ -0,0 +1,5 @@
+apiId: [apiId] #apiId for the datasources. found in the datasources section in the netuitive ui
+baseAddr: https://api.app.netuitive.com #where to send the data. in most cases use the default
+port: nil #in most cases this will be nil
+elementName: [element name] #name of the element to assign metrics to in netuitive. if unsure, just use the name of your app
+debugLevel: error #options (in ascending order of debugness) are: error, info, debug

data/lib/netuitive/api_emissary.rb

@@ -0,0 +1,36 @@
+require 'net/http'
+require 'rubygems'
+require 'json'
+require 'yaml'
+require 'netuitive/ruby_config_manager'
+class APIEmissary
+	
+	def initialize(apiId, baseAddr, port)
+		@apiId=apiId
+		@baseAddr=baseAddr
+		@port=port
+		@configManager=ConfigManager.new
+	end 
+
+	def sendElements(elements)
+		if @configManager.isDebug?
+			puts elements.to_json
+		end
+
+		uri = URI("#{@baseAddr}/ingest/#{@apiId}")
+		req = Net::HTTP::Post.new(uri.path, initheader = {'Content-Type' =>'application/json'})
+        req.body = elements.to_json
+        response = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
+  			http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+  			http.ssl_version = :SSLv3
+  			http.request req
+		end
+		puts req.body
+		if (response.code != "202" and @configManager.isError?) or (@configManager.isInfo?)
+			puts "Response from submitting netuitive metrics to api
+			code: #{response.code}
+			message: #{response.message}
+			body: #{response.body}"
+		end
+	end
+end

data/lib/netuitive/ingest_attribute.rb

@@ -0,0 +1,10 @@
+require 'json'
+class IngestAttribute
+    def initialize(name, value)
+        @name=name
+        @value=value
+    end
+    def to_json(options = {})
+        {'name' => @name, 'value' => @value}.to_json
+    end
+end

data/lib/netuitive/ingest_element.rb

@@ -0,0 +1,17 @@
+require 'json'
+class IngestElement
+    attr_accessor :id, :name, :type, :location, :metrics, :samples, :tags, :attributes
+    def initialize(id, name, type, location, metrics, samples, tags, attributes)
+        @id=id
+        @name=name
+        @type=type
+        @location=location
+        @metrics=metrics
+        @samples=samples
+        @tags=tags
+        @attributes=attributes
+    end
+    def to_json(options = {})
+        {'id' => @id, 'name' => @name, 'type' => @type, 'location' => @location, 'metrics' => @metrics, 'samples' => @samples,'tags' => @tags, 'attributes' => @attributes}.to_json.tr('\\', '')
+    end
+end

data/lib/netuitive/ingest_metric.rb

@@ -0,0 +1,15 @@
+require 'json'
+class IngestMetric
+    attr_accessor :id, :name, :unit, :type, :tags, :aggregate
+    def initialize(id, name, unit, type, tags, aggregate)
+        @id=id
+        @name=name
+        @unit=unit
+        @type=type
+        @tags=tags
+        @aggregate=aggregate
+    end
+    def to_json(options = {})
+        {'id' => @id,'name' => @name, 'unit' => @unit,'type' => @type, 'tags' => @tags}.to_json
+    end
+end

data/lib/netuitive/ingest_sample.rb

@@ -0,0 +1,18 @@
+require 'json'
+class IngestSample
+    attr_accessor :metricId, :timestamp, :val, :min, :max, :avg, :sum, :cnt
+    def initialize(metricId, timestamp, val, min, max, avg, sum, cnt)
+        @metricId=metricId
+        @timestamp=timestamp
+        @val=val
+        @min=min
+        @max=max
+        @avg=avg
+        @sum=sum
+        @cnt=cnt
+    end
+    def to_json(options = {})
+        millis=@timestamp.to_f * 1000 
+        {'metricId' => @metricId,'timestamp' => millis.round, 'val' => @val,'min' => @min, 'max' => @max, 'avg' => @avg,'sum' => @sum, 'cnt' => @cnt}.to_json
+    end
+end

data/lib/netuitive/ingest_tag.rb

@@ -0,0 +1,10 @@
+require 'json'
+class IngestTag
+    def initialize(name, value)
+        @name=name
+        @value=value
+    end
+    def to_json(options = {})
+        {'name' => @name, 'value' => @value}.to_json
+    end
+end

data/lib/netuitive/metric_aggregator.rb

@@ -0,0 +1,81 @@
+require 'netuitive/api_emissary'
+require 'netuitive/ingest_metric'
+require 'netuitive/ingest_sample'
+require 'netuitive/ingest_element'
+require 'netuitive/ruby_config_manager'
+
+class MetricAggregator
+
+	def initialize()
+		@metrics=Array.new
+		@samples=Array.new
+		@aggregatedMetrics=Array.new
+		@aggregatedSamples=Hash.new
+		@metricMutex=Mutex.new
+		@configManager=ConfigManager.new
+		@apiEmissary=APIEmissary.new(@configManager.apiId, @configManager.baseAddr, @configManager.port)
+	end
+
+	def sendMetrics()
+		@metricMutex.synchronize{
+			if @metrics.empty?
+				if @configManager.isInfo?
+					puts "no netuitive metrics to report"
+				end
+				return
+			end
+			aggregatedSamplesArray = @aggregatedSamples.values
+			aggregatedSamplesArray.each do |sample|
+				sample.timestamp=Time.new
+			end
+			element=IngestElement.new(@configManager.elementName, @configManager.elementName, "custom", nil, @metrics+@aggregatedMetrics, @samples+aggregatedSamplesArray, nil, nil)
+			elements= [element]
+			@apiEmissary.sendElements(elements)
+			clearMetrics
+		}
+	end
+
+	def addSample(metricId, val)
+		@metricMutex.synchronize{
+			if not metricExists metricId
+				metric=IngestMetric.new(metricId, metricId, nil, "custom", nil, false)
+				@metrics.push(metric)
+			end
+			sample=IngestSample.new(metricId, Time.new, val, nil, nil, nil, nil, nil)
+			@samples.push(sample)
+			if @configManager.isInfo?
+				puts "netuitive sample added #{metricId} val: #{val}"
+			end
+		}
+	end
+
+	def metricExists(metricId)
+		@metrics.each do |metric|
+				if metric.id == metricId
+					return true
+				end
+			end
+		return false
+	end
+
+	def aggregateMetric(metricId, val)
+		@metricMutex.synchronize{
+			if not metricExists metricId
+				metric=IngestMetric.new(metricId, metricId, nil, "custom", nil, false)
+				@metrics.push(metric)
+				sample=IngestSample.new(metricId, Time.new, val, nil, nil, nil, nil, nil)
+				@aggregatedSamples["#{metricId}"]=sample
+			else
+				sample=@aggregatedSamples["#{metricId}"]
+				sample.val+=val
+				@aggregatedSamples["#{metricId}"]=sample
+			end
+		}
+	end
+
+	def clearMetrics
+		@metrics=Array.new
+		@samples=Array.new
+		@aggregatedSamples=Hash.new
+	end
+end

data/lib/netuitive/ruby_config_manager.rb

@@ -0,0 +1,61 @@
+class ConfigManager
+
+	attr_accessor :apiId, :baseAddr, :port, :elementName
+
+	def initialize()
+		@error=0
+		@info=1
+		@debug=2
+		readConfig()
+	end
+
+	def isDebug?
+		if @debugLevel >= @debug
+			return true
+		end
+		return false
+	end
+
+	def isInfo?
+		if @debugLevel >= @info
+			return true
+		end
+		return false
+	end
+
+	def isError?
+		if @debugLevel >= @error
+			return true
+		end
+		return false
+	end
+
+	def readConfig()
+		gem_root= File.expand_path("../../..", __FILE__)
+		data=YAML.load_file "#{gem_root}/config/agent.yml"
+		@apiId=data["apiId"]
+		@baseAddr=data["baseAddr"]
+		@port=data["port"]
+		@elementName=data["elementName"]
+		debugLevelString=data["debugLevel"]
+		if debugLevelString == "error"
+			@debugLevel=@error
+		elsif debugLevelString == "info"
+			@debugLevel=@info
+		elsif debugLevelString == "debug"
+			@debugLevel=@debug
+		else
+			@debugLevel=@error
+		end
+
+		if isDebug?
+			puts "read config file. Results: 
+			apiId: #{apiId}
+			baseAddr: #{baseAddr}
+			port: #{port}
+			elementName: #{elementName}
+			debugLevel: #{debugLevelString}"
+		end
+	end
+
+end 

data/lib/netuitive_ruby_api.rb

@@ -0,0 +1,14 @@
+require 'netuitive/metric_aggregator'
+class NetuitiveRubyAPI
+	class << self
+		def setup
+			@@aggregator=MetricAggregator.new
+		end 
+
+		def aggregator
+			return @@aggregator
+		end
+	end
+end
+
+NetuitiveRubyAPI.setup

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: netuitive_ruby_api
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- John King
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-26 00:00:00.000000000 Z
+dependencies: []
+description: temp description
+email: jking@netuitive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/netuitive/api_emissary.rb
+- lib/netuitive/ingest_attribute.rb
+- lib/netuitive/ingest_element.rb
+- lib/netuitive/ingest_metric.rb
+- lib/netuitive/ingest_sample.rb
+- lib/netuitive/ingest_tag.rb
+- lib/netuitive/metric_aggregator.rb
+- lib/netuitive/ruby_config_manager.rb
+- lib/netuitive_ruby_api.rb
+- config/agent.yml
+- ./LICENSE
+homepage: http://rubygems.org/gems/netuitive_ruby_api
+licenses:
+- Apache v2.0
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Allows submitting metrics to Netuitive's API
+test_files: []