newrelic-elasticsearch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ed7177296564fd7bae9ce3b4bc19d4b3d19f12d
+  data.tar.gz: 220ff74651363c4d8188b5928c2fa9f83c01503d
+SHA512:
+  metadata.gz: 064c15be05f084f92ce1cd6a9456deb8e0d8e80d831aabc1e261ab86cee55ce1ef5d3c57dfdf25dc4880baee5d33fff9775e22c3c4fff1067364d04756020027
+  data.tar.gz: bae067d77f372639775c6048b313ecfd8b96340eb6e9cd5d372ebc1cd6b10b78fcf04462d0c53955825dd89a26e9440fe8dd8b97537e5b788874cb84de950269

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in newrelic-elasticsearch.gemspec
+gemspec
+
+gem 'pry-byebug'

data/README.md

@@ -0,0 +1,30 @@
+# Newrelic::Elasticsearch
+
+Provides NewRelic instrumentation for Elasticsearch for Application Level concerns.  This is not
+an Elasticsearch monitoring tool, but provides metrics for application performance related
+to Elasticsearch queries.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'new_relic-elasticsearch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install new_relic-elasticsearch
+
+## Usage
+
+Add it to your Gemfile, take it away.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/goldstar/newrelic-elasticsearch.
+

data/Rakefile

@@ -0,0 +1,38 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+task :test do
+  Rake::TestTask.new do |t|
+    t.libs << 'test'
+    t.pattern = "test/**/*_test.rb"
+  end
+end
+
+task :generate_resolver do
+  list = File.read(File.expand_path('test/endpoint_list.txt', __dir__))
+
+  pp list.lines.each.with_object({}) { |l, memo|
+    scanner = StringScanner.new(l)
+    scanner.scan_until(/(POST|GET|PUT|DELETE|HEAD)/)
+    next if scanner.pre_match.nil?
+
+    operation_name = scanner.pre_match.rstrip
+    method = scanner.matched
+    url_pattern = scanner.rest
+    api_name = if matches = /\/(_.*?)(\/|\b)/.match(url_pattern)
+                 matches[1]
+               end
+
+
+    if memo.has_key?([method, api_name])
+      next if memo[[method, api_name]] == operation_name
+      memo[[method, api_name]] = :"ambiguous#{api_name || "_" + method.downcase}_resolver"
+    else
+      memo[[method, api_name]] = operation_name
+    end
+
+  }.sort_by { |k,v| k[1] || '_' }.to_h
+end
+

data/lib/newrelic/elasticsearch.rb

@@ -0,0 +1,46 @@
+require 'newrelic/elasticsearch/version'
+require 'new_relic/agent/method_tracer'
+require 'elasticsearch'
+
+DependencyDetection.defer do
+  named :elasticsearch
+
+  depends_on do
+    defined?(::Elasticsearch::Transport::Client)
+  end
+
+  executes do
+    ::NewRelic::Agent.logger.info 'Installing Elasticsearch instrumentation'
+    require 'newrelic/elasticsearch/operation_resolver'
+  end
+
+  executes do
+    NewRelic::Agent::MethodTracer.extend(NewRelic::Agent::MethodTracer)
+
+    ::Elasticsearch::Transport::Client.class_eval do
+      def perform_request_with_new_relic(method, path, params={}, body=nil)
+        resolver = NewRelic::ElasticsearchOperationResolver.new(method, path)
+
+        callback = proc do |result, metric, elapsed|
+          # conditionally require body with notice_statement
+          if body && params
+            statement = body.merge(params)
+          else
+            statement = body || params
+          end
+          statement[:scope] = resolver.scope
+          statement[:additional_parameters] = resolver.operands
+
+          NewRelic::Agent::Datastores.notice_statement(statement.inspect, elapsed) if statement
+        end
+
+        NewRelic::Agent::Datastores.wrap('Elasticsearch', resolver.operation_name, resolver.index, callback) do
+          perform_request_without_new_relic(method, path, params, body)
+        end
+      end
+
+      alias_method :perform_request_without_new_relic, :perform_request
+      alias_method :perform_request, :perform_request_with_new_relic
+    end
+  end
+end

data/lib/newrelic/elasticsearch/operation_resolver.rb

@@ -0,0 +1,216 @@
+class NewRelic::ElasticsearchOperationResolver
+  ELASTICSEARCH_OPERATION_NAMES =
+    {
+      [ "PUT", nil ] => :ambiguous_put_resolver,
+      [ "POST", nil ] => :ambiguous_post_resolver,
+      [ "HEAD", nil ] => :ambiguous_head_resolver,
+      [ "GET", nil ] => :ambiguous_get_resolver,
+      [ "DELETE", nil ] => :ambiguous_delete_resolver,
+      [ "HEAD", "_alias" ] => "AliasesExist",
+      [ "PUT", "_alias" ] => "IndexPutAlias",
+      [ "DELETE", "_alias" ] => "IndexDeleteAliases",
+      [ "GET", "_alias" ] => "GetAliases",
+      [ "GET", "_aliases" ] => "GetIndicesAliases",
+      [ "POST", "_aliases" ] => "IndicesAliases",
+      [ "GET", "_analyze" ] => "Analyze",
+      [ "POST", "_analyze" ] => "Analyze",
+      [ "POST", "_bulk" ] => "Bulk",
+      [ "PUT", "_bulk" ] => "Bulk",
+      [ "GET", "_cache" ] => "ClearIndicesCache",
+      [ "POST", "_cache" ] => "ClearIndicesCache",
+      [ "GET", "_cat" ] => :ambiguous_cat_resolver,
+      [ "POST", "_close" ] => "CloseIndex",
+      [ "POST", "_cluster" ] => "ClusterReroute",
+      [ "GET", "_cluster" ] => :ambigous_cluster_resolver,
+      [ "PUT", "_cluster" ] => "ClusterUpdateSettings",
+      [ "GET", "_count" ] => "Count",
+      [ "POST", "_count" ] => "Count",
+      [ "POST", "_create" ] => "CreateDocument",
+      [ "PUT", "_create" ] => "CreateDocument",
+      [ "GET", "_explain" ] => "Explain",
+      [ "POST", "_explain" ] => "Explain",
+      [ "GET", "_flush" ] => "Flush",
+      [ "POST", "_flush" ] => "Flush",
+      [ "POST", "_gateway" ] => "GatewaySnapshot",
+      [ "GET", "_id" ] => "SearchScroll",
+      [ "DELETE", "_id" ] => "ClearScroll",
+      [ "POST", "_id" ] => "SearchScroll",
+      [ "POST", "_mapping" ] => "PutMapping",
+      [ "PUT", "_mapping" ] => "PutMapping",
+      [ "GET", "_mapping" ] => "GetMapping",
+      [ "DELETE", "_mapping" ] => "DeleteMapping",
+      [ "POST", "_mget" ] => "MultiGet",
+      [ "GET", "_mget" ] => "MultiGet",
+      [ "GET", "_mlt" ] => "MoreLikeThis",
+      [ "POST", "_mlt" ] => "MoreLikeThis",
+      [ "POST", "_mpercolate" ] => "MultiPercolate",
+      [ "POST", "_msearch" ] => "MultiSearch",
+      [ "GET", "_msearch" ] => "MultiSearch",
+      [ "POST", "_mtermvectors" ] => "MultiTermVectors",
+      [ "GET", "_mtermvectors" ] => "MultiTermVectors",
+      [ "GET", "_nodes" ] => :ambiguous_nodes_resolver,
+      [ "POST", "_open" ] => "OpenIndex",
+      [ "POST", "_optimize" ] => "Optimize",
+      [ "GET", "_optimize" ] => "Optimize",
+      [ "GET", "_percolate" ] => :ambiguous_percolate_resolver,
+      [ "POST", "_percolate" ] => :ambiguous_percolate_resolver,
+      [ "DELETE", "_query" ] => "DeleteByQuery",
+      [ "GET", "_refresh" ] => "Refresh",
+      [ "POST", "_refresh" ] => "Refresh",
+      [ "POST", "_reindex" ] => "Reindex",
+      [ "POST", "_restart" ] => "NodesRestart",
+      [ "GET", "_search" ] => :ambiguous_search_resolver,
+      [ "POST", "_search" ] => :ambiguous_search_resolver,
+      [ "DELETE", "_search" ] => "ClearScroll",
+      [ "GET", "_segments" ] => "IndicesSegments",
+      [ "PUT", "_settings" ] => "UpdateSettings",
+      [ "GET", "_settings" ] => "GetSettings",
+      [ "GET", "_search_shards" ] => "ClusterSearchShards",
+      [ "POST", "_search__shards" ] => "ClusterSearchShards",
+      [ "POST", "_shutdown" ] => "NodesShutdown",
+      [ "HEAD", "_source" ] => "HeadSource",
+      [ "GET", "_source" ] => "GetSource",
+      [ "GET", "_stats" ] => :ambiguous_stats_resolver,
+      [ "GET", "_status" ] => "IndicesStatus",
+      [ "GET", "_suggest" ] => "Suggest",
+      [ "POST", "_suggest" ] => "Suggest",
+      [ "POST", "_template" ] => "PutIndexTemplate",
+      [ "PUT", "_template" ] => "PutIndexTemplate",
+      [ "DELETE", "_template" ] => "DeleteIndexTemplate",
+      [ "GET", "_template" ] => "GetIndexTemplate",
+      [ "HEAD", "_template" ] => "HeadIndexTemplate",
+      [ "GET", "_termvector" ] => "TermVector",
+      [ "POST", "_termvector" ] => "TermVector",
+      [ "GET", "_threads" ] => "NodesHotThreads",
+      [ "POST", "_update" ] => "Update",
+      [ "GET", "_validate" ] => "ValidateQuery",
+      [ "POST", "_validate" ] => "ValidateQuery",
+      [ "GET", "_warmer" ] => "GetWarmer",
+      [ "PUT", "_warmer" ] => "PutWarmer",
+      [ "DELETE", "_warmer" ] => "DeleteWarmer"
+  }
+
+  AMBIGUOUS_API_OPS = {
+    0 => 'Server',
+    1 => 'Index',
+    2 => 'Type',
+    3 => 'Document'
+  }
+
+  AMBIGOUS_CAT_OPS = {
+    "indices" => "Indices",
+    "master" => "Cluster",
+    "nodes" => "Nodes",
+    "shards" => "Shards",
+    "aliases" => "Aliases"
+  }
+
+  attr_accessor :http_method, :path
+
+  def initialize(http_method, path)
+    @http_method = http_method
+    @path = path
+  end
+
+  def operation_name
+    resolved = ELASTICSEARCH_OPERATION_NAMES[[http_method, api_name]]
+    case resolved
+    when Symbol
+      send(resolved)
+    else
+      resolved
+    end
+  end
+
+  def path_components
+    @path_components ||= path.split('/').reject { |s| s.empty? }
+  end
+
+  def operands
+    if api_name.nil?
+      []
+    else
+      path_components[op_index + 1 .. -1]
+    end
+  end
+
+  def api_name
+    return nil if op_index.nil?
+    path_components[op_index]
+  end
+
+  def scope
+    if api_name.nil?
+      path_components
+    else
+      path_components[0 .. (op_index - 1)]
+    end
+  end
+
+  def scope_path
+    scope.join("_")
+  end
+
+  def index
+    scope[0]
+  end
+
+  def type
+    scope[1]
+  end
+
+  def id
+    scope[2]
+  end
+
+  def op_index
+    @op_index ||= path_components.index { |c| c.start_with?('_') }
+  end
+
+  def ambiguous_put_resolver
+    AMBIGUOUS_API_OPS[scope.count] + "Create"
+  end
+
+  alias_method :ambiguous_post_resolver, :ambiguous_put_resolver
+
+  def ambiguous_head_resolver
+    AMBIGUOUS_API_OPS[scope.count] + "Exists"
+  end
+
+  def ambiguous_get_resolver
+    AMBIGUOUS_API_OPS[scope.count] + "Get"
+  end
+
+  def ambiguous_delete_resolver
+    AMBIGUOUS_API_OPS[scope.count] + "Delete"
+  end
+
+  def ambiguous_cat_resolver
+    "Cat" + AMBIGOUS_CAT_OPS[operands.first]
+  end
+
+  def ambiguous_nodes_resolver
+    "Node" + operands[1..-1].map(&:capitalize).join
+  end
+
+  def ambiguous_percolate_resolver
+    "Percolate" + operands.first.to_s
+  end
+
+  def ambiguous_search_resolver
+    "Search" + operands.first.to_s
+  end
+
+  def ambiguous_stats_resolver
+    "Indicies" + operands.map(&:capitalize).join
+  end
+
+  def ambiguous_cluster_resolver
+    case operands.join('/')
+    when /pending_tasks/ then "ClusterPendingTasks"
+    when /nodes\/_restart/ then "NodesRestart"
+    when /nodes\/(.*?)\/_restart/ then "NodesRestart"
+    when /nodes\/(>*?)\/_shutdown/ then "NodesShutdown"
+    end
+  end
+end

data/lib/newrelic/elasticsearch/version.rb

@@ -0,0 +1,5 @@
+module NewRelic
+  module Elasticsearch
+    VERSION = "0.1.0"
+  end
+end

data/newrelic-elasticsearch.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'newrelic/elasticsearch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "newrelic-elasticsearch"
+  spec.version       = NewRelic::Elasticsearch::VERSION
+  spec.authors       = ["Stephen Prater"]
+  spec.email         = ["me@stephenprater.com"]
+
+  spec.summary       = %q{Provides NewRelic datastore instrumentation for Elasticsearch}
+  spec.description   = %q{Not for monitoring Elasticsearch, but for instrumenting it as
+                          as a datatore in the databases tab in NewRelic}
+  spec.homepage      = "http://github.com/goldstar/newrelic-elasticsearch"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 4.7.5"
+  spec.add_development_dependency "webmock"
+  spec.add_dependency "newrelic_rpm"
+  spec.add_dependency "elasticsearch"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: newrelic-elasticsearch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Prater
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: newrelic_rpm
+  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: elasticsearch
+  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'
+description: |-
+  Not for monitoring Elasticsearch, but for instrumenting it as
+                            as a datatore in the databases tab in NewRelic
+email:
+- me@stephenprater.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/newrelic/elasticsearch.rb
+- lib/newrelic/elasticsearch/operation_resolver.rb
+- lib/newrelic/elasticsearch/version.rb
+- newrelic-elasticsearch.gemspec
+homepage: http://github.com/goldstar/newrelic-elasticsearch
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Provides NewRelic datastore instrumentation for Elasticsearch
+test_files: []
+has_rdoc: