honeycomb-beeline 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 933f23233b9babc6adafa6eddc7292925f6fecbd68cba8de60a77591bb14667a
-  data.tar.gz: 7a82833864990c92193ca8066a91a48143ef78440b01c723d238ad6f95397d9f
+  metadata.gz: d8226a2444f449e489670d844e544ec8986ff40b32016ae9199031ae2fef1df8
+  data.tar.gz: 11e5d5f9dc8dcc000e6a4cdb5dbebd35f0fe332c9ff5ab0a85f4b084f428f7bd
 SHA512:
-  metadata.gz: 5eac3fe8bb20f0094c0e649bde8661e01fbcb950701f610373916aca9abeed3c8b0660dbf4ee6b2172f8376452d48a1f6532986c573cdb3ad00597c157471203
-  data.tar.gz: 9228ef70a625b7f0691e497335ffed7b9a0bb4f4537b283a3e059d35a57210c19fff9207eaa8dc29c73b67631b93b21abddc8a72a32b17afcf7ace2f9db7c933
+  metadata.gz: 5370b82bf792605cf79bcf67a5930a0430f498e84f0472e5046b3a027d52761d0fbc3410b21374a2fc32c61beb20738defa47db30a80a650b9ede888b09bc13a
+  data.tar.gz: c70d4cd7b0ea59c6642286db68b38bd0c637715e5468bfa096c8684486d93bcbebb0b7b037be01bb440f10c645199465a6500dfd54ab62fb602e467dea017a46

data/README.md

@@ -6,58 +6,19 @@ instruments them to send useful events to Honeycomb.
 
 ## Setup
 
-Setup requires minimal changes to your app, but the approach depends on how your
-app loads gems at startup.
-
-### Automatic setup for apps that call `Bundler.require`
-
-If your app calls `Bundler.require` at startup (you can verify by running `git
-grep 'Bundler\.require'`) then setup just requires adding one line to your
-Gemfile:
-
-```ruby
-gem 'honeycomb-beeline', require: 'honeycomb-beeline/auto_install'
-```
-
-Now run `bundle install` to install the gem.
-
-### Automatic setup for other apps
-
-If your app does not call `Bundler.require` at startup (you can verify by
-running `git grep 'Bundler\.require'`) then you'll need to make two changes.
-First add this line to your Gemfile:
-
-```ruby
-gem 'honeycomb-beeline'
-```
-
-Then require the gem somewhere in your app's startup script - e.g. for a Rack app
-add it to your "config.ru":
-
-```ruby
-require 'honeycomb-beeline/auto_install'
-```
-
-Now run `bundle install` to install the gem.
-
-### Manual setup
-
-If the automatic setup doesn't work for your app, or you prefer to choose which
-libraries to instrument, then you'll need to call `Honeycomb.init` manually.
-
-First add this line to your Gemfile:
+Setup requires minimal changes to your app. First add this line to your Gemfile:
 
 ```ruby
 gem 'honeycomb-beeline'
 ```
 
-Then require and init the gem somewhere in your app's startup script - e.g. for
-a Rack app add it to your "config.ru":
+Then in your app's startup script - e.g. for a Rack app "config.ru" is a good
+place - add the following code:
 
 ```ruby
 require 'honeycomb-beeline'
 
-Honeycomb.init(writekey: '<MY HONEYCOMB WRITEKEY>', dataset: 'my-app')
+Honeycomb.init
 ```
 
 Now run `bundle install` to install the gem.
@@ -68,17 +29,18 @@ You'll need to configure your Honeycomb writekey so that your app can
 identify itself to Honeycomb. You can find your writekey on [your Account
 page](https://ui.honeycomb.io/account).
 
-You can also configure which dataset in your Honeycomb account to send events
-to. If you don't, the gem will guess the dataset name based on the name of the
-current directory.
+You'll also need to configure the name of a dataset in your Honeycomb account to
+send events to. The name of your app is a good choice.
 
 You can specify the configuration either via environment variables, or by
-calling `Honeycomb.init` explicitly:
+passing arguments to `Honeycomb.init`:
 
 ### Configuration via environment variables
 
  * `HONEYCOMB_WRITEKEY` - specifies the writekey
  * `HONEYCOMB_DATASET` - specifies the dataset
+ * `HONEYCOMB_SERVICE` - specifies the name of your app (defaults to the dataset
+   name)
 
 ### Configuration via code
 
@@ -86,6 +48,9 @@ calling `Honeycomb.init` explicitly:
 Honeycomb.init(writekey: '<MY HONEYCOMB WRITEKEY>', dataset: 'my-app')
 ```
 
+Note that you should not check your Honeycomb writekey into version control, as
+it is sensitive and allows sending data to your Honeycomb account.
+
 ## Development
 
 ### Releasing a new version

data/lib/honeycomb-beeline.rb

@@ -1,13 +1,7 @@
-# Main entrypoint for the 'honeycomb-beeline' gem (see also
-# lib/honeycomb-beeline/automagic.rb for an alternative entrypoint).
+# Main entrypoint for the 'honeycomb-beeline' gem.
 
 require 'libhoney'
 
 require 'honeycomb/client'
+require 'honeycomb/instrumentations'
 require 'honeycomb/span'
-
-require 'activerecord-honeycomb'
-require 'faraday-honeycomb'
-
-module Honeycomb
-end

data/lib/honeycomb/beeline/version.rb

@@ -1,6 +1,6 @@
 module Honeycomb
   module Beeline
     GEM_NAME = 'honeycomb-beeline'
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/honeycomb/client.rb

@@ -1,4 +1,7 @@
 require 'honeycomb/beeline/version'
+
+require 'libhoney'
+
 require 'socket'
 
 module Honeycomb
@@ -6,8 +9,18 @@ module Honeycomb
 
   class << self
     attr_reader :client
+    attr_reader :service_name
+
+    def init(
+      writekey: ENV['HONEYCOMB_WRITEKEY'],
+      dataset: ENV['HONEYCOMB_DATASET'],
+      service_name: ENV['HONEYCOMB_SERVICE'] || dataset,
+      without: [],
+      logger: nil,
+      **options
+    )
+      reset
 
-    def init(writekey: nil, dataset: nil, service_name: dataset, logger: nil, without: [], **options)
       @logger = logger
       @without = without
       @service_name = service_name
@@ -19,22 +32,24 @@ module Honeycomb
         @logger.debug "Running hook '#{label}' after Honeycomb.init" if @logger
         run_hook(label, block)
       end
+
+      @initialized = true
     end
 
     def new_client(options)
-      @client = options.delete :client
+      client = options.delete :client
 
       options = {user_agent_addition: USER_AGENT_SUFFIX}.merge(options)
-      @client ||= begin
+      client ||= begin
         unless options[:writekey] && options[:dataset]
           raise ArgumentError, "must specify writekey and dataset"
         end
         Libhoney::Client.new(options)
       end
-      @client.add_field 'meta.beeline_version', Beeline::VERSION
-      @client.add_field 'meta.local_hostname', Socket.gethostname rescue nil
-      @client.add_field 'service_name',  @service_name
-      @client
+      client.add_field 'meta.beeline_version', Beeline::VERSION
+      client.add_field 'meta.local_hostname', Socket.gethostname rescue nil
+      client.add_field 'service_name',  @service_name
+      client
     end
 
     def after_init(label, &block)
@@ -48,7 +63,7 @@ module Honeycomb
                block
              end
 
-      if @initialized
+      if defined?(@initialized)
         @logger.debug "Running hook '#{label}' as Honeycomb already initialized" if @logger
         run_hook(label, hook)
       else
@@ -56,6 +71,26 @@ module Honeycomb
       end
     end
 
+    def shutdown
+      if defined?(@client) && @client
+        @client.close
+      end
+    end
+
+    # @api private
+    def reset
+      # TODO encapsulate all this into a Beeline object so we don't need
+      # explicit cleanup
+
+      shutdown
+
+      @logger = nil
+      @without = nil
+      @service_name = nil
+      @client = nil
+      @initialized = false
+    end
+
     private
     def after_init_hooks
       @after_init_hooks ||= []

data/lib/honeycomb/instrumentations.rb

@@ -0,0 +1,25 @@
+require 'honeycomb/client'
+
+require 'activerecord-honeycomb/auto_install'
+require 'faraday-honeycomb/auto_install'
+require 'rack-honeycomb/auto_install'
+require 'sequel-honeycomb/auto_install'
+
+module Honeycomb
+  INSTRUMENTATIONS = [
+    ActiveRecord::Honeycomb,
+    Faraday::Honeycomb,
+    Rack::Honeycomb,
+    Sequel::Honeycomb,
+  ].freeze
+
+  INSTRUMENTATIONS.each do |instrumentation|
+    auto = instrumentation::AutoInstall
+    if auto.available?
+      hook_label = instrumentation.name.sub(/::Honeycomb$/, '').downcase.to_sym
+      after_init(hook_label) do |client|
+        auto.auto_install!(honeycomb_client: client, logger: @logger)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeycomb-beeline
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sam Stokes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-24 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libhoney
@@ -246,10 +246,9 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/honeycomb-beeline.rb
-- lib/honeycomb-beeline/auto_install.rb
 - lib/honeycomb/beeline/version.rb
 - lib/honeycomb/client.rb
-- lib/honeycomb/env_config.rb
+- lib/honeycomb/instrumentations.rb
 - lib/honeycomb/span.rb
 homepage: https://github.com/honeycombio/beeline-ruby
 licenses:

data/lib/honeycomb-beeline/auto_install.rb

@@ -1,48 +0,0 @@
-# Alternative entrypoint for the 'honeycomb-beeline' gem that detects libraries
-# we can instrument and automagically instrument them.
-
-require 'libhoney'
-
-require 'honeycomb/client'
-require 'honeycomb/span'
-
-require 'activerecord-honeycomb/auto_install'
-require 'faraday-honeycomb/auto_install'
-require 'rack-honeycomb/auto_install'
-require 'sequel-honeycomb/auto_install'
-
-require 'honeycomb/env_config'
-
-module Honeycomb
-  module Beeline
-    LOGGER = if Honeycomb::DEBUG
-      require 'logger'
-      Logger.new($stderr).tap do |l|
-        l.level = Logger::Severity.const_get(Honeycomb::DEBUG)
-      end
-    end
-
-    INSTRUMENTATIONS = [
-      ActiveRecord::Honeycomb,
-      Faraday::Honeycomb,
-      Rack::Honeycomb,
-      Sequel::Honeycomb,
-    ].freeze
-
-    INSTRUMENTATIONS.each do |instrumentation|
-      auto = instrumentation::AutoInstall
-      if auto.available?(logger: LOGGER)
-        hook_label = instrumentation.name.sub(/::Honeycomb$/, '').downcase.to_sym
-        Honeycomb.after_init(hook_label) do |client|
-          auto.auto_install!(honeycomb_client: client, logger: LOGGER)
-        end
-      else
-        LOGGER.debug "Not autoinitialising #{instrumentation.name}" if LOGGER
-      end
-    end
-  end
-end
-
-if Honeycomb::ENV_CONFIG
-  Honeycomb.init(logger: Honeycomb::Beeline::LOGGER, **Honeycomb::ENV_CONFIG)
-end

data/lib/honeycomb/env_config.rb

@@ -1,17 +0,0 @@
-module Honeycomb
-  ENV_CONFIG = begin
-    writekey = ENV['HONEYCOMB_WRITEKEY']
-    dataset = ENV['HONEYCOMB_DATASET'] || ENV['PWD'].split('/').last
-
-    withouts = ENV['HONEYCOMB_WITHOUT'] || ''
-    without = withouts.split(',').map(&:to_sym)
-
-    if writekey
-      {writekey: writekey, dataset: dataset, without: without}.freeze
-    end
-  end
-
-  DEBUG = if ENV.key?('HONEYCOMB_DEBUG')
-    ENV['HONEYCOMB_DEBUG'].upcase.to_sym
-  end
-end