elasticsearch_pretty_profile 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 828dfd70028d77d0aa934f95ce63d839e33c9a1f926e6a466288ed5fa3c77ad0
+  data.tar.gz: 5141785f16e391460af6b8272155e9b01e638fe1c3e7f667f32204e8e2f87a0e
+SHA512:
+  metadata.gz: 00db44dfb68c9f7ed0fd7904b84758ce623d992a320cfea95926b7a3f2a39acdfcd87bb2d8b7789703859e38cefdd90980d7a94ea4dc87848775f9080c16d59c
+  data.tar.gz: 2e414d73a7fb05879e768bce20c3c62c65a17c28f45571535d00872e6036231aecfdf6d3990e37b6cfd89cecec7c992297b45773942041aa33798c6ace36aa39

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/doc/
+/pkg/
+/spec/examples.txt
+/tmp/
+/Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in elasticsearch_profile_pp.gemspec
+gemspec

data/README.md

@@ -0,0 +1,97 @@
+# Elasticsearch Pretty Profile
+
+Pretty print an elasticsearch profile.
+
+Iterate quickly from an irb/pry session. Use your own code to run Elasticsearch
+queries and pretty print the full profile or only the slow operations.
+
+Or when setting up Kibana is too troublesome.
+
+
+## Install
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "elasticsearch_pretty_profile"
+```
+
+Or install it yourself as:
+
+    $ gem install elasticsearch_pretty_profile
+
+
+## Usage
+
+```ruby
+require "elasticsearch"
+client = Elasticsearch::Client.new
+result = client.search(body: {profile: true})
+
+require "elasticsearch_pretty_profile/espp"
+espp result, over_ms: 50
+# or
+require "elasticsearch_pretty_profile"
+ElasticsearchPrettyProfile.pp result, breakdown: true
+```
+
+Options:
+ - `over_ms` - Filter output to operations slower than threshold. Default `1`.
+ - `breakdown` - Include breakdown of operations. Default `true`.
+
+Example output:
+```
+[ObNbzJLfQWaafS83U5b9lg][index][2]
+ 108ms BooleanQuery #ConstantScore(vehicle.state:UNBUILT) (106ms next_doc)
+ 397ms CancellableCollector search_cancelled
+  365ms MultiCollector search_multi
+   271ms MultiBucketCollector: [[term_agg_body_type, term_agg_feature, collapsed_total]] aggregation
+
+ 69ms GlobalOrdinalsStringTermsAggregator term_agg_body_type (55ms collect)
+ 256ms GlobalOrdinalsStringTermsAggregator term_agg_feature (118ms build_aggregation 137ms collect)
+  181ms CardinalityAggregator uniq_by (178ms collect)
+
+```
+
+The first line is the shard ID which consists of the node ID, index name, and
+shard number.
+
+The next lines consist of searches (queries and collectors), then a blank line,
+and finally aggregations. Indentation denotes it is a child of the previous
+operation.
+
+The lines follow this pattern:
+ 1. the time taken in milliseconds by the query, collector, or aggregation;
+ 2. the type of the query or aggregation, or the name of the collector;
+ 3. the description of the query or aggregation, or the reason of the collector;
+ 4. the breakdown of the operation in parentheses at the end;
+
+The breakdown is a list of sub-operation names with the associated time in
+milliseconds preceding it.
+
+More shards will be separated by a blank line and follow the same pattern as
+above.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+
+## Release
+
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to [rubygems.org].
+
+[rubygems.org]: https://rubygems.org
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/pchambino/elasticsearch_pretty_profile.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec, :standard]

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "elasticsearch_pretty_profile"
+require "pry"
+
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/elasticsearch_pretty_profile.gemspec

@@ -0,0 +1,29 @@
+require_relative "lib/elasticsearch_pretty_profile/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "elasticsearch_pretty_profile"
+  spec.version = ElasticsearchPrettyProfile::VERSION
+  spec.authors = ["Pedro Chambino"]
+  spec.email = ["pchambino@gmail.com"]
+
+  spec.summary = "Pretty print an elasticsearch profile"
+  spec.description = <<~TXT
+    Iterate quickly from an irb/pry session. Use your own code to run Elasticsearch
+    queries and pretty print the full profile or only the slow operations.
+
+    Or when setting up Kibana is too troublesome.
+  TXT
+  spec.homepage = "https://github.com/pchambino/elasticsearch_pretty_profile"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.start_with? "spec" }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7", "< 3.1")
+
+  spec.add_development_dependency "pry", "~> 0.14"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "standard", "~> 0.12"
+end

data/lib/elasticsearch_pretty_profile.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module ElasticsearchPrettyProfile
+  autoload :VERSION, "elasticsearch_profile_pp/version"
+
+  def self.pp(result, over_ms: 1, breakdown: true)
+    PrettyProfile.new(result, over_ms: over_ms, breakdown: breakdown)
+      .pretty_print
+  end
+
+  class PrettyProfile
+    def initialize(result, over_ms:, breakdown:)
+      @result = result
+      @over_ms = over_ms
+      @breakdown = breakdown
+    end
+
+    def pretty_print
+      profile = @result["profile"]
+      return unless profile
+
+      profile["shards"]&.each do |shard|
+        puts shard["id"]
+
+        shard["searches"]&.each do |search|
+          search["query"]&.each { |op| pp_operation op }
+          search["collector"]&.each { |op| pp_operation op }
+
+          rewrite_time = ns_to_ms search["rewrite_time"]
+          puts " #{rewrite_time}ms rewrite" unless rewrite_time < @over_ms
+          puts
+        end
+
+        shard["aggregations"]&.each { |op| pp_operation op }
+        puts
+      end
+
+      nil
+    end
+
+    private
+
+    def ns_to_ms(nanos)
+      return 0 unless nanos
+
+      nanos / 1000 / 1000
+    end
+
+    def pp_operation(op, indent = 0)
+      time = ns_to_ms op["time_in_nanos"]
+      return if time < @over_ms
+
+      puts [
+        " " * indent,
+        "#{time}ms",
+        op["type"] || op["name"],
+        op["description"] || op["reason"],
+        pp_breakdown(op["breakdown"])
+      ].compact.join " "
+
+      op["children"]&.each { |child| pp_operation child, indent + 1 }
+    end
+
+    def pp_breakdown(bd)
+      return unless @breakdown
+
+      operations = bd&.map do |name, value|
+        time = ns_to_ms(value)
+        next if time < @over_ms
+
+        "#{time}ms #{name}"
+      end&.compact
+
+      "(#{operations.join " "})" if operations&.any?
+    end
+  end
+  private_constant :PrettyProfile
+end

data/lib/elasticsearch_pretty_profile/espp.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "elasticsearch_pretty_profile"
+
+module Kernel
+  def espp(...)
+    ElasticsearchPrettyProfile.pp(...)
+  end
+end

data/lib/elasticsearch_pretty_profile/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ElasticsearchPrettyProfile
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: elasticsearch_pretty_profile
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pedro Chambino
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: |
+  Iterate quickly from an irb/pry session. Use your own code to run Elasticsearch
+  queries and pretty print the full profile or only the slow operations.
+
+  Or when setting up Kibana is too troublesome.
+email:
+- pchambino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- elasticsearch_pretty_profile.gemspec
+- lib/elasticsearch_pretty_profile.rb
+- lib/elasticsearch_pretty_profile/espp.rb
+- lib/elasticsearch_pretty_profile/version.rb
+homepage: https://github.com/pchambino/elasticsearch_pretty_profile
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.1'
+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: Pretty print an elasticsearch profile
+test_files: []