rails_opentracer 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4c181eb9d05e45903b24fc2763d936b7eb5bf5c
-  data.tar.gz: e590daa78234fb7447ce436cd974f57830b9127a
+  metadata.gz: b363c1b439ae8e9574219e8cea6b8b3eac8bc72e
+  data.tar.gz: 9c2b3db94eeeac2f748c0861e6b7199790d214f0
 SHA512:
-  metadata.gz: ae5dcc5a1b708f6b4409614a48bdfc8b0453bf76bdc4703d456a46cdafd3eecb7c1e664a18782d7304a891e2e56eb5eb22e7c3d9a7348a9709c4fda902520dbe
-  data.tar.gz: 09e028b25b0afd4020595ecd9876f026e1ee01f8933940e2d2449256c78f148eaedd3b31878f7209b5c66aadac917680fa8a8ab6eb5de6b4d80f27a7583247c6
+  metadata.gz: 959c878b41ac3358a02486ec1d91108426f30cd83c5ffa9f39d30f4dc64c5d9314ec87e5df4c3e1f870ec8bca642406a01715cd3dadf83b200bb8b2ffca9e504
+  data.tar.gz: 55892e8701e66a9df2b4581c742970d8ce6ef68e872e5aa3665718399dc8f4024239e2dedadaf98ee764c810bfe85c59a1052d9f1a815e70712fe24cf1edb924

data/README.md

@@ -1,8 +1,7 @@
 # RailsOpentracer
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_opentracer`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem instruments an application to be used with a tracing client. At this stage it is configured to be used with Zipkin only, but
+this can be changed at a later stage.
 
 ## Installation
 
@@ -20,9 +19,39 @@ Or install it yourself as:
 
     $ gem install rails_opentracer
 
+Generate files required by gem:
+
+    $ rails g rails_opentracer:install
+
+Add the following to development.rb:
+
+```ruby
+config.middleware.use Tracer
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+To run Zipkin locally, do:
+
+  $ docker run -d -p 9411:9411 openzipkin/zipkin
+
+You will need to set an environment variable with the Zipkin client URL. Locally this would be: `ENV['ZIPKIN_SERVICE_URL']='http://localhost:9411'`.
+
+Whenever a request is made to another application, do:
+
+```ruby
+include RailsOpentracer
+```
+
+in the applicable controller, and then:
+
+```ruby
+with_span 'name of span' do
+  faraday_get(URL)
+end
+```
+
+
 
 ## Development
 

data/lib/rails_opentracer/generators/rails_opentracer/install_generator.rb

@@ -1,6 +1,6 @@
 require 'rails/generators'
 
-module RailsFaradayTracer
+module RailsOpentracer
   module Generators
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path("../../templates", __FILE__)

data/lib/rails_opentracer/version.rb

@@ -1,3 +1,3 @@
 module RailsOpentracer
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_opentracer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Erik Botes