tracebin 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 632b0078b17a6e931957ef7c68fa6618633bc798
-  data.tar.gz: e9dfe8944b070c402683a50e5d39664f07c1c5dc
+  metadata.gz: 1154bcf6a675e91b8bf67d1996b669ffdb35ff7a
+  data.tar.gz: 4e898dbe53ffea1676abfe241a1c8adfb40d5ea7
 SHA512:
-  metadata.gz: 7e7873a9d6d04088225e0f39b8d3fa7b6fc92cd202a055a535d828968beda8c2c0f87fec5135e1853c5e975d81294523411263ddcd2f199cf16a32d7d6f3d4e8
-  data.tar.gz: 47c77b5ccdb964e95e35999e821d646b0a468c074c8d1161f69b6e4638be9265baf60d013003e7b3efac823cf336d753a5e1012ad269d043af3b1abe898827cf
+  metadata.gz: 071b0a19683f51231b3f0a7e431f39531ae240111278736e7349637d9f15c3dd6e4a835ca99f2a0b5fea99aee0e1d8a3bf233590ce7981b45deeb1aa33e02a53
+  data.tar.gz: 8e74447c51d81cbc755ab936f726f1720af9e4e0e7bd9429f14e2058285f353b075b52f4caa7752822198b65e0c8cf239d904acbc12189baf6a7b000bf0476cc

data/README.md

@@ -1,5 +1,7 @@
 # tracebin-ruby
 
+This is the official Ruby agent for Tracebin, a simple performance monitoring tool for web applications. Go to [traceb.in](https://traceb.in) to get started.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -10,15 +12,31 @@ gem 'tracebin'
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
-Or install it yourself as:
+Configure the gem to point to this bin:
 
-    $ gem install tracebin
+```ruby
+Tracebin::Agent.configure do |config|
+  config.bin_id = '<YOUR BIN ID>'
+end
+```
 
-## Usage
+## Configuration
 
-TODO: Write usage instructions here
+There are several configuration options available for the Tracebin agent. Just set the options in a `configure` block on `Tracebin::Agent`:
+
+```ruby
+Tracebin::Agent.configure do |config|
+  config.ignored_paths = ['/assets'] # Put any paths you wish to ignore in an array.
+
+  if Rails.env.development? || Rails.env.test?
+    config.enabled = false # You can completely disable the agent under the conditions of your choosing.
+  end
+end
+```
 
 ## Development
 

data/lib/tracebin/agent.rb

@@ -12,6 +12,8 @@ module Tracebin
       attr_accessor :config, :storage, :logger
 
       def start!
+        return if started? || !config.enabled
+
         logger.info "TRACEBIN: Starting Tracebin agent..."
 
         @subscribers = Subscribers.new
@@ -21,17 +23,22 @@ module Tracebin
         @reporter = Reporter.new(storage, config, logger)
 
         @reporter.start!
+        @started = true
 
         logger.info "TRACEBIN: Tracebin agent started!"
       end
 
       def stop!
+        return unless started?
+
         logger.info "TRACEBIN: Shutting down Tracebin agent..."
 
         @health_monitor.stop!
         @worker_process_monitor.stop!
         @reporter.stop!
 
+        storage.unload
+
         @started = false
 
         logger.info "TRACEBIN: Tracebin agent stopped!"

data/lib/tracebin/config.rb

@@ -4,7 +4,8 @@ module Tracebin
       log_level: 'info',
       host: 'https://traceb.in',
       report_path: 'reports',
-      ignored_paths: []
+      ignored_paths: [],
+      enabled: true
     }.freeze
 
     attr_accessor *(DEFAULTS.keys + [:bin_id])

data/lib/tracebin/reporter.rb

@@ -62,7 +62,7 @@ module Tracebin
       res
     rescue Exception => e
       logger.warn "TRACEBIN: Exception occurred sending data to the server: #{e.message}"
-      self.stop!
+      Tracebin::Agent.stop!
     end
 
     def handle_response(res, payload)
@@ -71,7 +71,7 @@ module Tracebin
         logger.info 'TRACEBIN: Successfully sent payload to the server.'
       when Net::HTTPBadRequest
         logger.warn 'TRACEBIN: App bin ID not found. Please create a new app bin and add it to the config.'
-        self.stop!
+        Tracebin::Agent.stop!
       else
         logger.warn 'TRACEBIN: Failed to send data to the server. Will try again in 1 minute.'
         @storage.add_payload payload

data/lib/tracebin/version.rb

@@ -1,3 +1,3 @@
 module Tracebin
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tracebin
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Tyler Guillen