mnemonic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11af3b3be9c8bbfc7f2f894153f15d43fd17f24f
+  data.tar.gz: 1ab4eebad3666c8375fcf688de6103fc431b4c90
+SHA512:
+  metadata.gz: 591b470a1fc840c66068c6f697c82cddc267126c7aa3ecfccc00a5d3086d50556d864028434ba27f9cedbc4228c87d493978c1631658097ed06a206a43c8c458
+  data.tar.gz: 972c5ff51b863f6b5c6f88860b7da359d649ddf21c36d0e499c076ea4621b4164cd99c087218433761fa2219fcaf6f0668aca2a16beaef5df5425f84081045b5

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    mnemonic (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.0)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  mnemonic!
+  pry
+  rake (~> 10.0)
+  rspec
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Alexey Gaziev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,47 @@
+# mnemonic - The best tool to find leakage
+
+If you know (or even just think) that your application is leaking, but you having hard times with figuring out
+what exactly is leaking, when and why – this tool will help you to figure this out.
+
+<a href="https://evilmartians.com/?utm_source=gon">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
+</a>
+
+## How it works
+
+Сейчас у мнемоника есть два режима работы –
+
+1. Полуавтоматический, когда вы добавляете в нужных вам местах триггеры мнемоника.
+   В этом режиме мнемоник будет выводить или сохранять данные каждый раз, когда
+   будет выполняться код триггера.
+
+2. Автоматический, когда вы проксируете ваш логгер через прокси мнемоника.
+   В этом режиме мнемоник будет выводить или сохранять данные каждый раз,
+   когда вызывается логгер.
+
+## Formats
+
+Мнемоник поддерживает три формата вывода данных:
+
+1. Pretty - красиво отформаттированный текстовый вывод данных:
+скриншот
+
+2. JSON - данные представлены в виде JSON-массива, удобно для дальнейшего анализа при
+   помощи внешних инструментов
+пример формата
+
+3. CSV - данные представлены в формате CSV, можно воспользоваться любым инструментом
+   с поддержкой импорта из csv, таким как Google Sheets и тп.
+пример формата
+
+Если вам не хватает какого-либо формата – мы будем очень рады пулл реквесту или
+ишью с описанием недостающего формата.
+
+## What and how you can track with mnemonic
+
+Мы постарались добавить в этот инструмент все метрики, которые когда-либо
+помогали нам в расследовании наших утечек. Если мы упустили что-то важное - мы
+будем очень благодарны за пулл реквест или ишью с описанием метрики.
+
+На данный момент инструмент позволяет следить за следующими показателями:
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

data/bin/setup

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

data/examples/gc_stat.rb

@@ -0,0 +1,13 @@
+mnemonic = Mnemonic.new do |config|
+  config.gc_stat :minor_gc_count, :major_gc_count
+end
+
+mnemonic.attach_pretty(STDOUT)
+
+# 5 major GCs!
+10.times do |i|
+  GC.start if i.odd?
+  mnemonic.trigger!(i.odd? ? 'major!' : 'no major')
+end
+
+mnemonic.detach_all

data/examples/instances.rb

@@ -0,0 +1,23 @@
+class X
+end
+
+mnemonic = Mnemonic.new do |config|
+  config.time_milliseconds
+  config.instances_count(X)
+  config.instances_size(X)
+end
+
+mnemonic.attach_csv(STDOUT, extra: true)
+
+10.times do
+  X.new
+  mnemonic.trigger!(:without_gc)
+end
+
+10.times do
+  X.new
+  GC.start
+  mnemonic.trigger!(:with_gc)
+end
+
+mnemonic.detach_all

data/examples/logger.rb

@@ -0,0 +1,30 @@
+require 'mnemonic/logger_proxy'
+
+file_name = './tmp.log'
+logger = Mnemonic::LoggerProxy.new(Logger.new(file_name)) do |config|
+  config.objects_count(:T_HASH)
+  config.objects_size(:T_HASH)
+  config.objects_count(:T_ARRAY)
+  config.objects_size(:T_ARRAY)
+end
+
+10.times do
+  {}; {[] => []}; [] # +3 arrays, +2 hashes
+  logger.info 'hello with logging enabled!'
+end
+
+logger.disable_mnemonic!
+
+10.times do
+  logger.info 'hello with logging disabled!'
+end
+
+logger.enable_mnemonic!
+
+10.times do
+  logger.info 'hello with logging re-enabled!'
+end
+
+
+
+puts File.read(file_name)

data/examples/rss.rb

@@ -0,0 +1,13 @@
+mnemonic = Mnemonic.new do |config|
+  config.rss
+end
+
+mnemonic.attach_pretty(STDOUT)
+
+# 5 major GCs!
+10.times do |i|
+  '!' * 1_000_000
+  mnemonic.trigger!
+end
+
+mnemonic.detach_all

data/examples/to_csv.rb

@@ -0,0 +1,39 @@
+file_name = './tmp.csv'
+
+mnemonic = Mnemonic.new do |config|
+  config.time_milliseconds
+  config.objects_count(:T_HASH)
+  config.objects_size(:T_HASH)
+end
+
+mnemonic.attach_csv(file_name)
+
+100.times do
+  Hash.new
+  mnemonic.trigger!
+end
+
+mnemonic.detach_all
+
+puts File.read(file_name)
+
+puts
+puts "WITH EXTRA COLUMN"
+puts
+
+mnemonic = Mnemonic.new do |config|
+  config.time_milliseconds
+  config.objects_count(:T_HASH)
+  config.objects_size(:T_HASH)
+end
+
+mnemonic.attach_csv(file_name, extra: true)
+
+100.times do |i|
+  Hash.new
+  mnemonic.trigger!(2 ** i)
+end
+
+mnemonic.detach_all
+
+puts File.read(file_name)

data/examples/to_json.rb

@@ -0,0 +1,17 @@
+file_name = './tmp.json'
+
+mnemonic = Mnemonic.new do |config|
+  config.time_milliseconds
+  config.objects_count(:T_HASH, :T_ARRAY)
+end
+
+mnemonic.attach_json(file_name)
+
+10.times do
+  {}; {[] => []}; [] # +3 arrays, +2 hashes
+  mnemonic.trigger!
+end
+
+mnemonic.detach_all
+
+puts JSON.pretty_generate(JSON.load(File.read(file_name)))

data/lib/mnemonic.rb

@@ -0,0 +1,74 @@
+require 'objspace'
+require 'monitor.rb'
+require 'set'
+
+class Mnemonic
+  require 'mnemonic/version'
+  require 'mnemonic/config'
+  require 'mnemonic/metric'
+  require 'mnemonic/sink'
+  require 'mnemonic/util'
+
+  include MonitorMixin
+
+  attr_reader :root_metrics, :metrics, :metric_names
+
+  def initialize
+    super
+    config = Mnemonic::Config.new
+    yield config
+
+    @root_metrics = config.metrics.map do |metric|
+      metric.klass.new(*metric.args)
+    end
+
+    @metrics = @root_metrics.flat_map do |metric|
+      metric.to_enum(:each_submetric).to_a
+    end
+
+    @root_metrics.each(&:start!)
+    @metric_names = @metrics.map(&:name)
+    @sinks = Set.new
+  end
+
+  def trigger!(extra = nil)
+    synchronize do
+      @root_metrics.each(&:refresh!)
+      @sinks.each { |s| s.drop!(extra) }
+    end
+  end
+
+  def attach_csv(*args)
+    attach(Sink::CSV, *args)
+  end
+
+  def attach_json(*args)
+    attach(Sink::JSON, *args)
+  end
+
+  def attach_pretty(*args)
+    attach(Sink::Pretty, *args)
+  end
+
+  def attach(sink_class, *args, &block)
+    synchronize do
+      sink_class.new(self, *args, &block).tap do |sink|
+        @sinks << sink
+      end
+    end
+  end
+
+  def detach(sink)
+    synchronize do
+      sink.close
+      @sinks.delete sink
+    end
+  end
+
+  def detach_all
+    synchronize do
+      @sinks.each(&:close)
+      @sinks.clear
+    end
+  end
+end

data/lib/mnemonic/config.rb

@@ -0,0 +1,62 @@
+class Mnemonic
+  class Config
+    MetricDescription = Struct.new(:klass, :args)
+
+    attr_reader :metrics
+
+    def initialize
+      @metrics = []
+    end
+
+    def add_metric(klass, args=nil)
+      @metrics << MetricDescription.new(klass, args)
+    end
+
+    def gc_stat(*stat_names)
+      add_metric Metric::GCStat, stat_names
+    end
+
+    def objects_count(*object_types)
+      add_metric Metric::ObjectsCount, object_types
+    end
+
+    def objects_size(*object_types)
+      add_metric Metric::ObjectsSize, object_types
+    end
+
+    def instances_count(*target_klass_names)
+      target_klass_names.each do |klass_name|
+        add_metric Metric::InstancesCount, klass_name
+      end
+    end
+
+    def instances_size(*target_klass_names)
+      target_klass_names.each do |klass_name|
+        add_metric Metric::InstancesSize, klass_name
+      end
+    end
+
+    def time_seconds
+      add_metric Metric::TimeSeconds
+    end
+
+    def time_milliseconds
+      add_metric Metric::TimeMilliseconds
+    end
+
+    def time
+      add_metric Metric::Time
+    end
+
+    def rss
+      # TODO: finish!
+      klass = case Util::OS.type
+              when :linux
+                Metric::RSS::ProcFS
+              else
+                Metric::RSS::PS
+              end
+      add_metric klass
+    end
+  end
+end