canary_ipa 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8c0b039fc3f9703bc1fcfb811b639faf990d6f853f09456790c74e33512b4fd
+  data.tar.gz: 855f9d7efdcb7f13a80a081848274067628a837602602bc8f8b44205c67f8e90
+SHA512:
+  metadata.gz: '062291508bede280a514ea8b685f786f0bcaedc7d80f5196974c3245963a9d56927fc54cd988089fda3c92f7976a3bd4a7aecb74dacd8dee37cce1547f528af7'
+  data.tar.gz: 75ffd7186d7c31a9ecf6ba964584fee83cceded341ba9e957b82e506f965cbda2b7e8408b7d2ee3643353bb98b0750a3856865e5646cc146dad0764cc60e8d11

data/README.md

@@ -0,0 +1,38 @@
+# Canary In-Process Agent
+
+This Rails Plugin/Gem contains the Canary Monitoring In-Process Agent.
+
+The goal of this agent is simple: all outgoing HTTP traffic gets intercepted and is sent off
+to the local Canary Monitoring Agent, which sifts through the data and decides what to do with it.
+
+It is kept very simple on purpose: it will time the call, and then send some elementary
+data to the host's agent per UDP. The overhead of this is in the order of microseconds,
+and an UDP `send()` will not block; this way, we can be sure that your application will
+not be impacted. All the heavy lifting is done in the Monitoring Agent, where it is fine
+if stuff gets delayed, dropped, or whatever.
+
+## Usage
+
+Just installing the Gem is enough. There is some optional configuration through the environment:
+
+* `CANARY_MONITORING_AGENT_HOST` can be set to a hostname/IP to send the telemetry data to, the default
+  is to send to localhost.
+* `CANARY_MONITORING_AGENT_PORT` can be set to a port to send the telemetry data to, the default is to
+  sent to port 51712.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'canary_ipa'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install canary_ipa
+```

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/canary_ipa.rb

@@ -0,0 +1,24 @@
+require "canary_ipa/version"
+require "canary_ipa/railtie"
+
+module CanaryIpa
+  module NetHttpExtensions
+    @@sock = UDPSocket.new
+    @@host = ENV["CANARY_MONITORING_AGENT_HOST"] || "127.0.0.1"
+    @@port = (ENV["CANARY_MONITORING_AGENT_PORT"] || "51712").to_i
+    def request(req, body = nil, &block)
+      start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      result = super(req, body, &block)
+      delta = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
+      delta_ms = delta * 1000
+      @@sock.send("0\t#{req.method}\t#{@address}\t#{req.path}\t#{delta_ms}\n", 0, @@host, @@port)
+      #overhead = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start - delta
+      #puts "Measuring and UDP overhead: around #{overhead}s"
+      result
+    end
+  end
+end
+
+class Net::HTTP
+  prepend CanaryIpa::NetHttpExtensions
+end

data/lib/canary_ipa/railtie.rb

@@ -0,0 +1,4 @@
+module CanaryIpa
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/canary_ipa/version.rb

@@ -0,0 +1,3 @@
+module CanaryIpa
+  VERSION = '0.1.0'
+end

data/lib/tasks/canary_ipa_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :canary_ipa do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: canary_ipa
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Canary Monitoring, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.1
+description: Plugin to measure outgoing API call performance using Canary Monitoring
+email:
+- rubygems@canarymonitor.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/canary_ipa.rb
+- lib/canary_ipa/railtie.rb
+- lib/canary_ipa/version.rb
+- lib/tasks/canary_ipa_tasks.rake
+homepage: https://canarymonitor.com
+licenses:
+- CC-BY-NC-ND
+metadata:
+  homepage_uri: https://canarymonitor.com
+  source_code_uri: https://canarymonitor.com
+  changelog_uri: https://canarymonitor.com
+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: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Plugin to measure outgoing API call performance using Canary Monitoring
+test_files: []