utracker 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4ee4c98911ffef4acc63f4a59993a7993fa0c2f
-  data.tar.gz: f13b2bfeba7ca0d2203456041d15ba95eb7846b1
+  metadata.gz: 127d98e8fb9eda9a1ce15e7a4aae35965c3552f4
+  data.tar.gz: 172d5d04d4ba8a6de4687fb6c4ca3278234adda9
 SHA512:
-  metadata.gz: bd6d3ec4c8e7b2dfd79dea5f9f0c19caae604643e49a086a8a22eabc7e6b08fc13f6f1d06bef22e38ee0133af7fd1c033f67d2c2d932b1e10895df116aecfdd8
-  data.tar.gz: 766d32f041b8f10dfb3772667304f3730da9c86ae1553e4b6801e28206b55f8b53e1f5409845f023e33d5190cc2c3d791b29118e2c5f0f7f3b9b832f6adb9fa0
+  metadata.gz: 64b7571d649d4485b12f1abf28a74c43c261ffc875e405bfb274e7b78b6dca97e763cbf8a8f87d9f2bb1bd334b2db114729217d437d917aec63894421e31c67a
+  data.tar.gz: 63f94dc7e0dc4da286625d8d29ca00aea6b0cf60a3ac8b596e6b979de81f046bd2e60374cc38087af3ae55f839f940e44039356a38609a535e203444e4b6f9e5

data/README.md

@@ -3,6 +3,7 @@
 [![Build Status](https://travis-ci.org/nicoolas25/micro-tracker.svg?branch=development)](https://travis-ci.org/nicoolas25/micro-tracker)
 [![Code Climate](https://codeclimate.com/github/nicoolas25/micro-tracker/badges/gpa.svg)](https://codeclimate.com/github/nicoolas25/micro-tracker)
 [![Test Coverage](https://codeclimate.com/github/nicoolas25/micro-tracker/badges/coverage.svg)](https://codeclimate.com/github/nicoolas25/micro-tracker)
+[![Gem Version](https://badge.fury.io/rb/utracker.svg)](http://badge.fury.io/rb/utracker)
 
 Modern web application are more and more designed with micro-services. Those services exchange messages in order to communicate with each other. Eventually your architecture ends with a graph of services that could be quite complex. Micro-tracker is all about tracking this micro-service's interactions in order to know which service received which message, when and from which other service. It will help you monitor your architecture and debug faster.
 
@@ -14,8 +15,14 @@ Modern web application are more and more designed with micro-services. Those ser
 * [x] Create messages using a parent message.
 * [x] Allow to filter the payload in logs.
 
+## Backends
+
+* MongoDB through [utracker-mongodb][backend-mongodb]
+
 ## Useful tools on top of this
 
 * [ ] Broken service alert
 * [ ] Scaling advisor
 * [ ] Replay messages after a failure
+
+[backend-mongodb]: https://github.com/nicoolas25/micro-tracker-mongodb

data/lib/utracker.rb

@@ -2,6 +2,7 @@ require "utracker/version"
 
 module Utracker
 
+  autoload :Drawer,       'utracker/drawer'
   autoload :Logger,       'utracker/logger'
   autoload :StdoutLogger, 'utracker/logger/stdout_logger'
 

data/lib/utracker/drawer.rb

@@ -0,0 +1,36 @@
+class Utracker::Drawer
+
+  Node = Struct.new(:service, :edges) do
+    def ==(other)
+      other.service == service
+    end
+  end
+
+  def write_graph(filename)
+    File.open(filename, 'w') do |file|
+      file.puts "digraph message_flow {"
+      file.puts "  node [style=filled fillcolor=white]"
+      file.puts "  rankdir=LR"
+      write_graph_into(file)
+      file.puts "}"
+    end
+  end
+
+  protected
+
+  def build_graph
+    fail 'Please implement me in subclasses.'
+  end
+
+  private
+
+  def write_graph_into(file)
+    build_graph.each do |node|
+      file.puts "  #{node.service}"
+      node.edges && node.edges.each do |connected_node|
+        file.puts "  #{node.service} -> #{connected_node.service}"
+      end
+    end
+  end
+
+end

data/lib/utracker/version.rb

@@ -1,3 +1,3 @@
 module Utracker
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/utracker/drawer/node_spec.rb

@@ -0,0 +1,17 @@
+RSpec.describe Utracker::Drawer::Node do
+  let(:instance) { described_class.new('name') }
+
+  describe "#==" do
+    subject { instance == other_instance }
+
+    context "when the other instance has the same service name" do
+      let(:other_instance) { described_class.new(instance.service) }
+      it { is_expected.to be true }
+    end
+
+    context "when the other instance has a different service name" do
+      let(:other_instance) { described_class.new('name2') }
+      it { is_expected.to be false }
+    end
+  end
+end

data/spec/utracker/drawer_spec.rb

@@ -0,0 +1,32 @@
+RSpec.describe Utracker::Drawer do
+  let(:instance) { described_class.new }
+
+  describe '#write_graph' do
+    subject { instance.write_graph(filename) }
+
+    let(:filename) { "spec/test_graph.dot" }
+    let(:content) { File.read(filename) }
+    let(:graph) do
+      node1 = Utracker::Drawer::Node.new('node1', [])
+      node2 = Utracker::Drawer::Node.new('node2', nil)
+      node1.edges << node2
+      [node1, node2]
+    end
+
+    before { allow(instance).to receive(:build_graph).and_return(graph) }
+    after { File.delete(filename) }
+
+    it "writes the expected file" do
+      subject
+      expect(content).to eq <<-EXPECTED_FILE
+digraph message_flow {
+  node [style=filled fillcolor=white]
+  rankdir=LR
+  node1
+  node1 -> node2
+  node2
+}
+      EXPECTED_FILE
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utracker
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nicolas ZERMATI
@@ -126,11 +126,14 @@ files:
 - examples/services.out
 - examples/services.rb
 - lib/utracker.rb
+- lib/utracker/drawer.rb
 - lib/utracker/logger.rb
 - lib/utracker/logger/stdout_logger.rb
 - lib/utracker/message.rb
 - lib/utracker/version.rb
 - spec/spec_helper.rb
+- spec/utracker/drawer/node_spec.rb
+- spec/utracker/drawer_spec.rb
 - spec/utracker/logger/event_spec.rb
 - spec/utracker/logger_spec.rb
 - spec/utracker/message/logging_spec.rb
@@ -163,6 +166,8 @@ specification_version: 4
 summary: Track micro-services interactions.
 test_files:
 - spec/spec_helper.rb
+- spec/utracker/drawer/node_spec.rb
+- spec/utracker/drawer_spec.rb
 - spec/utracker/logger/event_spec.rb
 - spec/utracker/logger_spec.rb
 - spec/utracker/message/logging_spec.rb