honeycomb-beeline 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ee35a2e5343568aa60e59d26e6a8b6cf390b24c
+  data.tar.gz: afbc1a425601869194ca72ff59a3ef0271c5f896
+SHA512:
+  metadata.gz: b4b42d2928d1b1342ab25c85cfeea3a393efa8e906a4c6e80cf882842e7b369241ce87df3a99badb21b8cbe635f64426f358b10f6c72f932579861ecb2544ab5
+  data.tar.gz: 0f8304a7321454ae1282f537e9e4ada27e4bdfc08399bef34ba53da1d366f042b63f5ca5875d4c8ea6af645a5ac83919abca0da787bd16556afde5808ea8a539

data/lib/honeycomb-beeline.rb

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

data/lib/honeycomb-beeline/auto_install.rb

@@ -0,0 +1,48 @@
+# 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/beeline/version.rb

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

data/lib/honeycomb/client.rb

@@ -0,0 +1,60 @@
+require 'honeycomb/beeline/version'
+
+module Honeycomb
+  USER_AGENT_SUFFIX = "#{Beeline::GEM_NAME}/#{Beeline::VERSION}"
+
+  class << self
+    attr_reader :client
+
+    def init(writekey:, dataset:, logger: nil, without: [], **options)
+      options = options.merge(writekey: writekey, dataset: dataset)
+      @logger = logger
+      @without = without
+      options = {user_agent_addition: USER_AGENT_SUFFIX}.merge(options)
+      @client = Libhoney::Client.new(options)
+
+      after_init_hooks.each do |label, block|
+        @logger.debug "Running hook '#{label}' after Honeycomb.init" if @logger
+        run_hook(label, block)
+      end
+    end
+
+    def after_init(label, &block)
+      raise ArgumentError unless block_given?
+
+      hook = if block.arity == 0
+               ->(_) { block.call }
+             elsif block.arity > 1
+               raise ArgumentError, 'Honeycomb.after_init block should take 1 argument'
+             else
+               block
+             end
+
+      if @initialized
+        @logger.debug "Running hook '#{label}' as Honeycomb already initialized" if @logger
+        run_hook(label, hook)
+      else
+        after_init_hooks << [label, hook]
+      end
+    end
+
+    private
+    def after_init_hooks
+      @after_init_hooks ||= []
+    end
+
+    def run_hook(label, block)
+      if @without.include?(label)
+        @logger.debug "Skipping hook '#{label}' due to opt-out" if @logger
+      else
+        block.call @client
+      end
+    rescue => e
+      warn "Honeycomb.init hook '#{label}' raised #{e.class}: #{e}"
+    end
+  end
+
+  after_init :log do
+    @logger.info "Honeycomb inited" if @logger
+  end
+end

data/lib/honeycomb/env_config.rb

@@ -0,0 +1,17 @@
+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

data/lib/honeycomb/span.rb

@@ -0,0 +1,55 @@
+require 'securerandom'
+
+module Honeycomb
+  module Span
+  end
+
+  class << self
+    def with_trace_id(trace_id = SecureRandom.uuid)
+      Thread.current[:honeycomb_trace_id] = trace_id
+      yield trace_id
+    ensure
+      Thread.current[:honeycomb_trace_id] = nil
+    end
+
+    def trace_id
+      Thread.current[:honeycomb_trace_id]
+    end
+
+    def with_span_id(span_id)
+      parent_span_id = Thread.current[:honeycomb_span_id]
+      Thread.current[:honeycomb_span_id] = span_id
+      yield parent_span_id
+    ensure
+      Thread.current[:honeycomb_span_id] = parent_span_id
+    end
+
+    def span(service_name:, name:, span_id: SecureRandom.uuid)
+      event = client.event
+
+      event.add_field :traceId, trace_id if trace_id
+      event.add_field :serviceName, service_name
+      event.add_field :name, name
+      event.add_field :id, span_id
+
+      start = Time.now
+      with_span_id(span_id) do |parent_span_id|
+        event.add_field :parentId, parent_span_id if parent_span_id
+        yield
+      end
+    rescue Exception => e
+      if event
+        event.add_field :exception_class, e.class.name
+        event.add_field :exception_message, e.message
+      end
+      raise
+    ensure
+      if start && event
+        finish = Time.now
+        duration = finish - start
+        event.add_field :durationMs, duration * 1000
+        event.send
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: honeycomb-beeline
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sam Stokes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: libhoney
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: activerecord-honeycomb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-honeycomb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-honeycomb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel-honeycomb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  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
+  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: rspec
+  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: yard
+  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: "    TO DO *is* a description\n"
+email:
+- sam@honeycomb.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- 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/span.rb
+homepage: https://github.com/honeycombio/beeline-ruby
+licenses:
+- MIT
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Instrument your Ruby apps with Honeycomb
+test_files: []