peastash 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a82ba88b2a2a87b61d0033e94e8ffdb21550fe5d
-  data.tar.gz: 9fbbd55f82230fbf185e3448f611478cbbaf8622
+  metadata.gz: 3ae1c4247d347a2b0bbed42330c324909a05a289
+  data.tar.gz: ddee185247132b7067e3dd3e7db9041c88633414
 SHA512:
-  metadata.gz: 739af7a73e9adb45342803e1c5daeec1954f5f1e7abe51c3058a61df5224d7e8d436d0a1d064bcb6113762ebf70c06e7b9a37186555e792fdc8a911e8fb2d5cd
-  data.tar.gz: 7a9929a16f3db58f4aa6167829b16b6482ba8796aedebff5fd26248d3df6fe4fd37861c4290bc1b7576998a83ea00d269488a2c0a4c40570fedf51c20fc7997d
+  metadata.gz: c3b0b19df08f1b3a01282c995dea4f4d1d128c58b3ca2986aa0df6acc03acc8937fbf4f9643a8c57cbdcf2194757195ac03ffd64d5b5d8f4d6f0f54cb0c99d63
+  data.tar.gz: a93bedc2e49cfe10ec896af5129b24672e4524df83ecbc39a1c3a507543c80fde302ab7b8fa6938d53fe67c8680611f3b0b4856d8f9af78e95d439feb4efedaf

data/.gitignore

@@ -2,3 +2,4 @@ coverage
 pkg
 .DS_STORE
 *.log
+Gemfile.lock

data/README.md

@@ -23,8 +23,8 @@ gem 'peastash'
 
 ### Getting started
 ``Peastash`` provides a simple interface to aggregate data to be sent to Logstash.
-The boundaries of a log entry are defined by a the ``Peastash.with_instance.log`` block.
-When the code inside the block is done running a log entry will be created and written.
+The boundaries of a log entry are defined by the ``Peastash.with_instance.log`` block.
+When the code inside the block is done running, a log entry will be created and written.
 The most basic usage would look like:
 
 ```ruby
@@ -63,9 +63,9 @@ Please note that this is a global setting and cannot be set per-instance.
 
 #### Outputs
 
-Peastash ships with a single output: ``Peastash::Outputs::IO``. It can be initialized either by passing it path or an IO object.
+Peastash ships with a single output: ``Peastash::Outputs::IO``. It can be initialized either by passing it a path or an IO object.
 Peastash can easily be extended to output to any target.
-Simply configure Peastash's output with an object that responds to the ``#dump`` method. This method will be called at the end of the ``#log`` block, with 1 argument : a ``LogStash::Event`` object, that you will probably need to serialize to json.
+Simply configure Peastash's output with an object that responds to the ``#dump`` method. This method will be called at the end of the ``#log`` block, with 1 argument: a ``LogStash::Event`` object that you will probably need to serialize to json.
 
 ### What if I want to use it in my rack app?
 
@@ -77,7 +77,7 @@ use Peastash::Middleware
 ```
 
 By default, the middleware only adds the ``duration``, ``status`` and ``hostname`` (machine name) fields to the log entry.
-In addition to using ``Peastash.with_instance.store`` to add information, you can pass one or two block arguments to ``use``, that will be called with the request env and the Rack response in parameter, in the context of the Middleware's instance.
+In addition to using ``Peastash.with_instance.store`` to add information, you can pass one or two block arguments to the ``use`` dsl, that will be called with the request ``env`` and the Rack response in parameter, in the context of the Middleware's instance.
 The first block will be called **before** the request (with a ``response = nil``), while the second one will be called **after**, with the actual response. For example:
 
 ```ruby
@@ -103,7 +103,7 @@ config.peastash.source = Rails.application.class.parent_name
 
 By default, Peastash's Rails integration will log the same parameters as the Middleware version, plus the fields in the payload of the [``process_action.action_controller``](http://edgeguides.rubyonrails.org/active_support_instrumentation.html#process_action.action_controller) notification (except the params).
 
-All the options for ``Peastash`` can be set using the ``config.peastash`` configuratio object.
+All the options for ``Peastash`` can be set using the ``config.peastash`` configuration object.
 
 #### Logging request parameters
 
@@ -113,7 +113,7 @@ To enable parameter logging, you must add the following to your configuration:
 config.peastash.log_parameters = true
 ```
 
-Be careful, as this can significantly increase the size of the log entries, as well as causing problem if other Logstash entries have the same field with a different data type.
+Be careful, as this can significantly increase the size of the log entries, as well as causing issues if other Logstash entries have the same field with a different data type.
 
 #### Listening to ``ActiveSupport::Notifications``
 Additionaly, you can use Peastash to aggregate data from any ``ActiveSupport::Notifications``:
@@ -156,10 +156,10 @@ Using several instances, you can nest ``log`` blocks without sharing the store,
 For example, you can log your Rails query with the ``global`` instance, and your asynchronous jobs with a ``worker`` instance, and have those instances output to different files.
 
 ### Playing with tags
-There are three ways to tag your log entries in Peastash.with_instance.
+There are three ways to tag your log entries in ``Peastash.with_instance``.
 
-* The first one is through configuration (see above).
-* The second one is by passing tags to the ``Peastash.with_instance.log`` method.
+* The first one is through configuration (see above)
+* The second one is by passing tags to the ``Peastash.with_instance.log`` method
 * The last one is to call the ``Peastash.with_instance.tags`` method from within a ``Peastash.with_instance.log`` block. Tags defined with this method are not persistent and will disappear at the next call to ``Peastash.with_instance.log``
 
 For example:

data/lib/peastash/version.rb

@@ -1,3 +1,3 @@
 class Peastash
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/lib/peastash.rb

@@ -115,6 +115,11 @@ class Peastash
   end
 
   def build_event(source, tags)
-    LogStash::Event.new('@source' => source, '@fields' => store, '@tags' => @base_tags + tags)
+    LogStash::Event.new({
+      '@source' => source,
+      '@fields' => store,
+      '@tags' => @base_tags + tags,
+      '@pid' => Process.pid
+    })
   end
 end

data/spec/peastash/middleware_spec.rb

@@ -53,7 +53,8 @@ describe Peastash::Middleware do
         expect(LogStash::Event).to receive(:new).with({
           '@source' => Peastash::STORE_NAME,
           '@fields' => { path: '/', duration: 0, status: 200, ip: nil },
-          '@tags' => []
+          '@tags' => [],
+          '@pid' => an_instance_of(Fixnum),
         })
         Timecop.freeze { @middleware.call env_for('/') }
       end
@@ -78,7 +79,8 @@ describe Peastash::Middleware do
         expect(LogStash::Event).to receive(:new).with({
           '@source' => Peastash::STORE_NAME,
           '@fields' => { scheme: 'http', duration: 0, status: 200, ip: nil },
-          '@tags' => []
+          '@tags' => [],
+          '@pid' => an_instance_of(Fixnum),
         })
         Timecop.freeze { @middleware.call env_for('/') }
       end
@@ -103,6 +105,7 @@ describe Peastash::Middleware do
           '@source' => Peastash::STORE_NAME,
           '@fields' => { duration: 0, status: 200, foo: 'foo', ip: nil },
           '@tags' => [],
+          '@pid' => an_instance_of(Fixnum),
         })
         Timecop.freeze { @middleware.call env_for('/') }
       end

data/spec/peastash_spec.rb

@@ -35,8 +35,9 @@ describe Peastash do
         Peastash.with_instance.configure!(tags: tags)
         expect(LogStash::Event).to receive(:new).with({
           '@source' => Peastash::STORE_NAME,
-          '@fields' => {},
-          '@tags' => tags
+          '@fields' => an_instance_of(Hash),
+          '@tags' => tags,
+          '@pid' => an_instance_of(Fixnum),
         })
         Peastash.with_instance.log {}
       end
@@ -45,8 +46,9 @@ describe Peastash do
         Peastash.with_instance.configure!(source: 'foo')
         expect(LogStash::Event).to receive(:new).with({
           '@source' => 'foo',
-          '@fields' => {},
-          '@tags' => []
+          '@fields' => an_instance_of(Hash),
+          '@tags' => [],
+          '@pid' => an_instance_of(Fixnum),
         })
         Peastash.with_instance.log {}
       end
@@ -118,8 +120,9 @@ describe Peastash do
         Peastash.with_instance.configure!(tags: base_tags)
         expect(LogStash::Event).to receive(:new).with({
           '@source' => Peastash::STORE_NAME,
-          '@fields' => {},
-          '@tags' => base_tags + tags
+          '@fields' => an_instance_of(Hash),
+          '@tags' => base_tags + tags,
+          '@pid' => an_instance_of(Fixnum),
         })
         Peastash.with_instance.log(tags) {}
       end
@@ -177,8 +180,9 @@ describe Peastash do
         Peastash.with_instance.configure!(tags: base_tags)
         expect(LogStash::Event).to receive(:new).with({
           '@source' => Peastash::STORE_NAME,
-          '@fields' => {},
-          '@tags' => base_tags + tags + additional_tags
+          '@fields' => an_instance_of(Hash),
+          '@tags' => base_tags + tags + additional_tags,
+          '@pid' => an_instance_of(Fixnum),
         })
         Peastash.with_instance.log(tags) { Peastash.with_instance.tags.concat(additional_tags) }
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peastash
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Vincent Boisard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-09 00:00:00.000000000 Z
+date: 2015-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -160,7 +160,6 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - lib/peastash.rb
@@ -236,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Peastash allows you to instrument your code with the ELK stack easily.
@@ -287,3 +286,4 @@ test_files:
 - spec/peastash/rails_ext/watch_spec.rb
 - spec/peastash_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/Gemfile.lock

@@ -1,129 +0,0 @@
-PATH
-  remote: .
-  specs:
-    peastash (0.0.9)
-      logstash-event
-      thread_safe
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionmailer (4.1.1)
-      actionpack (= 4.1.1)
-      actionview (= 4.1.1)
-      mail (~> 2.5.4)
-    actionpack (4.1.1)
-      actionview (= 4.1.1)
-      activesupport (= 4.1.1)
-      rack (~> 1.5.2)
-      rack-test (~> 0.6.2)
-    actionview (4.1.1)
-      activesupport (= 4.1.1)
-      builder (~> 3.1)
-      erubis (~> 2.7.0)
-    activemodel (4.1.1)
-      activesupport (= 4.1.1)
-      builder (~> 3.1)
-    activerecord (4.1.1)
-      activemodel (= 4.1.1)
-      activesupport (= 4.1.1)
-      arel (~> 5.0.0)
-    activesupport (4.1.1)
-      i18n (~> 0.6, >= 0.6.9)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.1)
-      tzinfo (~> 1.1)
-    arel (5.0.1.20140414130214)
-    builder (3.2.2)
-    coderay (1.1.0)
-    diff-lcs (1.2.5)
-    erubis (2.7.0)
-    hike (1.2.3)
-    i18n (0.6.9)
-    json (1.8.1)
-    logstash-event (1.2.02)
-    mail (2.5.4)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    method_source (0.8.2)
-    mime-types (1.25.1)
-    minitest (5.3.4)
-    multi_json (1.10.0)
-    polyglot (0.3.4)
-    pry (0.9.12.6)
-      coderay (~> 1.0)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    rack (1.5.2)
-    rack-test (0.6.2)
-      rack (>= 1.0)
-    rails (4.1.1)
-      actionmailer (= 4.1.1)
-      actionpack (= 4.1.1)
-      actionview (= 4.1.1)
-      activemodel (= 4.1.1)
-      activerecord (= 4.1.1)
-      activesupport (= 4.1.1)
-      bundler (>= 1.3.0, < 2.0)
-      railties (= 4.1.1)
-      sprockets-rails (~> 2.0)
-    railties (4.1.1)
-      actionpack (= 4.1.1)
-      activesupport (= 4.1.1)
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (10.3.1)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    rspec-rails (2.14.1)
-      actionpack (>= 3.0)
-      activemodel (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-    slop (3.5.0)
-    sprockets (2.12.1)
-      hike (~> 1.2)
-      multi_json (~> 1.0)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sprockets-rails (2.1.3)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      sprockets (~> 2.8)
-    thor (0.19.1)
-    thread_safe (0.3.4)
-    tilt (1.4.1)
-    timecop (0.7.1)
-    treetop (1.4.15)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (1.2.0)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  peastash!
-  pry
-  rack-test
-  rails
-  rake
-  rspec (~> 2.14)
-  rspec-rails
-  simplecov (~> 0.7.1)
-  timecop