pcptrace 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d1409374dfe9cea8944910ccd090d6b9bd43345
+  data.tar.gz: 755c7a8bc579d7d55ce06e44842c585f6819b9cf
+SHA512:
+  metadata.gz: 9bd124971686faba63d22d272ee4cee255639421bbe6e87ecbfcfa4442999b42f19fea27ddc26ff0e25ca9ad3fad6e308f324e6a4d6d3f438d8a914d22187dc5
+  data.tar.gz: f99508dde9017c3b83cfc75dc9a61c8ff0dda543cbd3be9eaa318e877a606ea4b6fdad4924d6507dc5f1f4664d15c06f1e1a52e950c1629868c50bb51603fcc4

data/README.md

@@ -0,0 +1,100 @@
+Ruby bindings for PCP trace PMDA & API
+
+# DESCRIPTION
+
+Ruby bindings of:
+
+https://github.com/performancecopilot/pcp/blob/master/src/include/pcp/trace.h
+
+As easy as that. Visit man page for more info:
+
+http://pcp.io/man/man3/pmdatrace.3.html
+
+# USAGE
+
+	require "pcptrace"
+
+	# reached a point in source code
+	PCPTrace::point("a_point"))
+
+	# observation of an arbitrary value
+	PCPTrace::obs("an_observation", 130.513))
+
+	# a counter - increasing or decreasing
+	PCPTrace::counter("a_counter", 1))
+
+	# time spent in a transaction (or block)
+	PCPTrace::begin("a_transaction"))
+	# ...
+	PCPTrace::end("a_transaction"))
+
+	# transactions must be aborted (e.g. exception)
+	#PCPTrace::abort("a_transaction"))
+
+	# all methods return non-zero code
+	result = PCPTrace::counter("a_counter", -5))
+	puts("Error: " + PCPTrace::errstr(result)) if result != 0
+
+# RUBY-FRIENDLY API
+
+Little bit more Ruby-friendly wraper:
+
+	require 'pcptrace/kernel'
+	PCPTrace::setup_kernel(true)
+
+	pcp_point("a_point")
+	pcp_observe("an_observation", 99.9)
+	pcp_counter("a_counter", 10)
+	pcp_counter("a_counter") # increment by 1
+	pcp_measure("a_transaction") do
+	  # block of code - properly aborted on exception
+	end
+
+# REQUIREMENTS
+
+The PCP library and headers.
+
+## Fedora
+
+	$ dnf install ruby-devel pcp pcp-libs-devel
+
+## Debian or Ubuntu
+
+	$ sudo apt-get install noidea todo
+
+# INSTALLATION
+
+Regular rubygem:
+
+	gem install pcptrace
+
+When building from source:
+
+	rake compile
+
+# AUTHORS
+
+* Lukas Zapletal
+
+# LICENSE
+
+(The MIT License)
+
+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/ext/pcptrace/extconf.rb

@@ -0,0 +1,6 @@
+require 'mkmf'
+
+extension_name = "pcptrace"
+dir_config(extension_name)
+have_library("pcp_trace", "pmtracestate")
+create_makefile(extension_name)

data/ext/pcptrace/pcptrace.c

@@ -0,0 +1,64 @@
+#include <ruby.h>
+#include <pcp/trace.h>
+
+VALUE pcp = Qnil;
+
+static VALUE rb_ext_begin(VALUE self, VALUE str_id)
+{
+  return INT2NUM(pmtracebegin(StringValueCStr(str_id)));
+}
+
+static VALUE rb_ext_end(VALUE self, VALUE str_id)
+{
+  return INT2NUM(pmtraceend(StringValueCStr(str_id)));
+}
+
+static VALUE rb_ext_abort(VALUE self, VALUE str_id)
+{
+  return INT2NUM(pmtraceabort(StringValueCStr(str_id)));
+}
+
+static VALUE rb_ext_point(VALUE self, VALUE str_id)
+{
+  return INT2NUM(pmtracepoint(StringValueCStr(str_id)));
+}
+
+static VALUE rb_ext_errstr(VALUE self, VALUE int_code)
+{
+  return rb_str_new_cstr(pmtraceerrstr(NUM2INT(int_code)));
+}
+
+static VALUE rb_ext_counter(VALUE self, VALUE str_id, VALUE double_val)
+{
+  return INT2NUM(pmtracecounter(StringValueCStr(str_id), NUM2DBL(double_val)));
+}
+
+static VALUE rb_ext_obs(VALUE self, VALUE str_id, VALUE double_val)
+{
+  return INT2NUM(pmtraceobs(StringValueCStr(str_id), NUM2DBL(double_val)));
+}
+
+static VALUE rb_ext_state(VALUE self, VALUE int_code)
+{
+  return INT2NUM(pmtracestate(NUM2INT(int_code)));
+}
+
+void Init_pcptrace(){
+  pcp = rb_define_module("PCPTrace");
+  rb_define_module_function(pcp, "begin", rb_ext_begin, 1);
+  rb_define_module_function(pcp, "end", rb_ext_end, 1);
+  rb_define_module_function(pcp, "abort", rb_ext_abort, 1);
+  rb_define_module_function(pcp, "point", rb_ext_point, 1);
+  rb_define_module_function(pcp, "counter", rb_ext_counter, 2);
+  rb_define_module_function(pcp, "obs", rb_ext_obs, 2);
+  rb_define_module_function(pcp, "errstr", rb_ext_errstr, 1);
+  rb_define_module_function(pcp, "state", rb_ext_state, 1);
+
+  rb_define_const(pcp, "STATE_NONE", INT2NUM(PMTRACE_STATE_NONE));
+  rb_define_const(pcp, "STATE_API", INT2NUM(PMTRACE_STATE_API));
+  rb_define_const(pcp, "STATE_COMMS", INT2NUM(PMTRACE_STATE_COMMS));
+  rb_define_const(pcp, "STATE_PDU", INT2NUM(PMTRACE_STATE_PDU));
+  rb_define_const(pcp, "STATE_PDUBUF", INT2NUM(PMTRACE_STATE_PDUBUF));
+  rb_define_const(pcp, "STATE_NOAGENT", INT2NUM(PMTRACE_STATE_NOAGENT));
+  rb_define_const(pcp, "STATE_ASYNC", INT2NUM(PMTRACE_STATE_ASYNC));
+}

data/lib/pcptrace/kernel.rb

@@ -0,0 +1,54 @@
+module PCPTrace
+  def self.setup_kernel(enabled, state = PCPTrace::STATE_NONE)
+    Kernel.const_set('PCP_ENABLED', enabled.to_s == "true")
+    Kernel.send(:extend, PCPTrace::KernelMethods)
+    PCPTrace::state(state)
+  end
+
+  module KernelMethods
+    def self.extended(mod)
+      mod.module_eval do
+        def pcp_begin(tag)
+          return 0 unless Kernel::PCP_ENABLED
+          PCPTrace::begin(tag)
+        end
+
+        def pcp_end(tag)
+          return 0 unless Kernel::PCP_ENABLED
+          PCPTrace::end(tag)
+        end
+
+        def pcp_abort(tag)
+          return 0 unless Kernel::PCP_ENABLED
+          PCPTrace::abort(tag)
+        end
+
+        def pcp_measure(tag)
+          return 0 unless Kernel::PCP_ENABLED
+          PCPTrace::begin(tag)
+          result = yield
+          PCPTrace::end(tag)
+          result
+        rescue => e
+          PCPTrace::abort(tag)
+          raise
+        end
+
+        def pcp_point(tag)
+          return 0 unless Kernel::PCP_ENABLED
+          PCPTrace::point(tag)
+        end
+
+        def pcp_counter(tag, value = 1)
+          return 0 unless Kernel::PCP_ENABLED
+          PCPTrace::counter(tag, value)
+        end
+
+        def pcp_observe(tag, value = 1)
+          return 0 unless Kernel::PCP_ENABLED
+          PCPTrace::obs(tag, value)
+        end
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Newt
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: pcptrace
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lukas Zapletal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rake-compiler
+  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: Ruby bindings for PCP tracing library pcp_trace
+email: lzap+rpm@redhat.com
+executables: []
+extensions:
+- ext/pcptrace/extconf.rb
+extra_rdoc_files: []
+files:
+- README.md
+- ext/pcptrace/extconf.rb
+- ext/pcptrace/pcptrace.c
+- lib/pcptrace/kernel.rb
+- lib/version.rb
+homepage: https://github.com/lzap/ruby-pcptrace
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- ext
+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 bindings for pcptrace (pcp_trace library)
+test_files: []