ddtelemetry 1.0.0a2 → 1.0.0a3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fb967335678607cb86deb8c2b48446735a957230cb9349ce3858d21233d002b
-  data.tar.gz: eadc2b1b9a1737564dbd38abc68f4a59c320d5cdbeb13ed3d0df0fe7c5c3a3f3
+  metadata.gz: 596a86f112eb74d0267f7a243d82a1ab9963a951999907a0c08f3a410e6b1a46
+  data.tar.gz: 67293156e3b3edcc33a37bda53c9bc0033c1883db5ea4b95fe05f7c0544337c7
 SHA512:
-  metadata.gz: 1474fb4050d596b8f1fed72f80760e63e37f42a99327c9acdd57d7af5afe3139f096f8067437ca5d297c52ea3d4847117aeacb8ffc8d9b142f753f47495491e9
-  data.tar.gz: 6ac9b71a55dd640a652a762c6974a6260a7448cfc94d1a30cd4f23a340a75237b7fba521049228a5ebc0b3287837434da604224253f6df693d8162e2bba3262f
+  metadata.gz: 3f57821fff43b9f69f0cef5098b7d47407a789b11647e2733e9ed37bb30378258f22eb6bef6628198ab7752d87a3b820ebcd98ef5a3483534eca9a9ea0663b5c
+  data.tar.gz: edb875daf44acaa9493119afe7918470c60fad95855be3154d4a05633daea0cceaf1b23b77a620f62fe1b8cf3626d6d51e0af2505a997a1f4deeb94c5f67706c

data/NEWS.md

@@ -1,5 +1,11 @@
 # DDTelemetry news
 
+## 1.0.0a3 (2017-12-25)
+
+Changes:
+
+* Made labels be a hash
+
 ## 1.0.0a2 (2017-12-18)
 
 Changes:

data/README.md

@@ -44,16 +44,16 @@ class Cache
   end
 
   def []=(key, value)
-    @counter.increment(:set)
+    @counter.increment(type: :set)
 
     @map[key] = value
   end
 
   def [](key)
     if @map.key?(key)
-      @counter.increment(:get_hit)
+      @counter.increment(type: :get_hit)
     else
-      @counter.increment(:get_miss)
+      @counter.increment(type: :get_miss)
     end
 
     @map[key]
@@ -77,9 +77,9 @@ cache['greeting']
 Finally, get the recorded telemetry values:
 
 ```ruby
-cache.counter.get(:set)      # => 1
-cache.counter.get(:get_hit)  # => 3
-cache.counter.get(:get_miss) # => 2
+cache.counter.get(type: :set)      # => 1
+cache.counter.get(type: :get_hit)  # => 3
+cache.counter.get(type: :get_miss) # => 2
 ```
 
 Or even print all stats:
@@ -89,11 +89,11 @@ puts cache.counter
 ```
 
 ```
-         │ count
-─────────┼──────
-get_miss │     2
-     set │     1
- get_hit │     3
+              │ count
+──────────────┼──────
+type=get_miss │     2
+     type=set │     1
+ type=get_hit │     3
 ```
 
 ## Installation
@@ -120,15 +120,13 @@ _DDTelemetry_ provides two metric types:
 
 * A **summary** records observations, and provides functionality for describing the distribution of the observations through quantiles. Examples: outgoing request durations, size of written files, …
 
-Each metric is recorded with a label, which is a free-form object that is useful to further refine the kind of data that is being recorded. For example:
+Each metric is recorded with a label, which is a hash that is useful to further refine the kind of data that is being recorded. For example:
 
 ```ruby
-cache_hits_counter.increment(:file_cache)
-request_durations_summary.observe(:weather_api, 1.07)
+cache_hits_counter.increment(target: :file_cache)
+request_durations_summary.observe(1.07, api: :weather)
 ```
 
-NOTE: Labels will likely change to become key-value pairs in a future version of DDTelemetry.
-
 ### Counters
 
 To create a counter, instantiate `DDTelemetry::Counter`:
@@ -140,13 +138,13 @@ counter = DDTelemetry::Counter.new
 To increment a counter, call `#increment` with a label:
 
 ```ruby
-counter.increment(:file_cache)
+counter.increment(target: :file_cache)
 ```
 
 To get the value for a certain label, use `#get`:
 
 ```ruby
-counter.get(:file_cache)
+counter.get(target: :file_cache)
 # => 1
 ```
 
@@ -158,18 +156,18 @@ To create a summary, instantiate `DDTelemetry::Summary`:
 summary = DDTelemetry::Summary.new
 ```
 
-To observe a value, call `#observe` with a label, along with the value to observe:
+To observe a value, call `#observe` with the value to observe, along with a label:
 
 ```ruby
-summary.observe(:weather_api, 0.88)
-summary.observe(:weather_api, 1.07)
-summary.observe(:weather_api, 0.91)
+summary.observe(0.88, api: :weather)
+summary.observe(1.07, api: :weather)
+summary.observe(0.91, api: :weather)
 ```
 
 To get the list of observations for a certain label, use `#get`, which will return a `DDTelemetry::Stats` instance:
 
 ```ruby
-summary.get(:weather_api)
+summary.get(api: :weather)
 # => <DDTelemetry::Stats>
 ```
 
@@ -189,9 +187,9 @@ To print a metric, use `#to_s`. For example:
 ```ruby
 summary = DDTelemetry::Summary.new
 
-summary.observe(2.1, :erb)
-summary.observe(4.1, :erb)
-summary.observe(5.3, :haml)
+summary.observe(2.1, filter: :erb)
+summary.observe(4.1, filter: :erb)
+summary.observe(5.3, filter: :haml)
 
 puts summary
 ```
@@ -199,10 +197,10 @@ puts summary
 Output:
 
 ```
-     │ count    min    .50    .90    .95    max    tot
-─────┼────────────────────────────────────────────────
- erb │     2   2.10   3.10   3.90   4.00   4.10   6.20
-haml │     1   5.30   5.30   5.30   5.30   5.30   5.30
+            │ count    min    .50    .90    .95    max    tot
+────────────┼────────────────────────────────────────────────
+ filter=erb │     2   2.10   3.10   3.90   4.00   4.10   6.20
+filter=haml │     1   5.30   5.30   5.30   5.30   5.30   5.30
 ```
 
 ### Stopwatch

data/lib/ddtelemetry/counter.rb

@@ -3,10 +3,12 @@
 module DDTelemetry
   class Counter < Metric
     def increment(label)
+      validate_label(label)
       basic_metric_for(label, BasicCounter).increment
     end
 
     def get(label)
+      validate_label(label)
       basic_metric_for(label, BasicCounter).value
     end
 

data/lib/ddtelemetry/metric.rb

@@ -26,5 +26,11 @@ module DDTelemetry
     def basic_metric_for(label, basic_class)
       @basic_metrics.fetch(label) { @basic_metrics[label] = basic_class.new }
     end
+
+    # @api private
+    def validate_label(label)
+      return if label.is_a?(Hash)
+      raise ArgumentError, 'label argument must be a hash'
+    end
   end
 end

data/lib/ddtelemetry/printer.rb

@@ -12,6 +12,10 @@ module DDTelemetry
 
     private
 
+    def label_to_s(label)
+      label.to_a.sort.map { |pair| pair.join('=') }.join(' ')
+    end
+
     def table_for_summary(summary)
       headers = ['', 'count', 'min', '.50', '.90', '.95', 'max', 'tot']
 
@@ -26,7 +30,7 @@ module DDTelemetry
         tot   = stats.sum
         max   = stats.max
 
-        [label.to_s, count.to_s] + [min, p50, p90, p95, max, tot].map { |r| format('%4.2f', r) }
+        [label_to_s(label), count.to_s] + [min, p50, p90, p95, max, tot].map { |r| format('%4.2f', r) }
       end
 
       [headers] + rows
@@ -36,7 +40,7 @@ module DDTelemetry
       headers = ['', 'count']
 
       rows = counter.labels.map do |label|
-        [label.to_s, counter.get(label).to_s]
+        [label_to_s(label), counter.get(label).to_s]
       end
 
       [headers] + rows

data/lib/ddtelemetry/summary.rb

@@ -3,10 +3,12 @@
 module DDTelemetry
   class Summary < Metric
     def observe(value, label)
+      validate_label(label)
       basic_metric_for(label, BasicSummary).observe(value)
     end
 
     def get(label)
+      validate_label(label)
       values = basic_metric_for(label, BasicSummary).values
       DDTelemetry::Stats.new(values)
     end

data/lib/ddtelemetry/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DDTelemetry
-  VERSION = '1.0.0a2'
+  VERSION = '1.0.0a3'
 end

data/samples/cache.rb

@@ -11,16 +11,16 @@ class Cache
   end
 
   def []=(key, value)
-    @counter.increment(:set)
+    @counter.increment(type: :set)
 
     @map[key] = value
   end
 
   def [](key)
     if @map.key?(key)
-      @counter.increment(:get_hit)
+      @counter.increment(type: :get_hit)
     else
-      @counter.increment(:get_miss)
+      @counter.increment(type: :get_miss)
     end
 
     @map[key]
@@ -36,13 +36,13 @@ cache['greeting']
 cache['greeting']
 cache['greeting']
 
-p cache.counter.get(:set)
+p cache.counter.get(type: :set)
 # => 1
 
-p cache.counter.get(:get_hit)
+p cache.counter.get(type: :get_hit)
 # => 3
 
-p cache.counter.get(:get_miss)
+p cache.counter.get(type: :get_miss)
 # => 2
 
 puts cache.counter

data/scripts/release

@@ -2,38 +2,27 @@
 # frozen_string_literal: true
 
 require 'fileutils'
+require 'json'
 require 'octokit'
+require 'shellwords'
+require 'uri'
 
 def run(*args)
-  puts 'I will execute the following:'
-  puts '    ' + args.map { |a| a =~ /\s/ ? a.inspect : a }.join(' ')
-  print 'Is this correct? [y/N] '
-  res = gets
-  unless res.strip.casecmp('y').zero?
-    warn 'Answer was not Y; release aborted.'
-    exit 1
-  end
-
-  system('echo', *args)
+  puts('<exec> ' + args.map { |s| Shellwords.escape(s) }.join(' '))
   system(*args)
-
-  print 'Continue? [y/N] '
-  res = gets
-  unless res.strip.casecmp('y').zero?
-    warn 'Answer was not Y; release aborted.'
-    exit 1
-  end
-
-  true
 end
 
+gem_name = 'ddtelemetry'
+version_constant = 'DDTelemetry::VERSION'
+gem_path = 'ddtelemetry'
+
 puts '=== Logging in to GitHub’s API…'
 client = Octokit::Client.new(netrc: true)
 puts
 
 puts '=== Deleting old *.gem files…'
 Dir['*.gem'].each do |fn|
-  puts "  #{fn}…"
+  puts "deleting #{fn}…"
   FileUtils.rm_f(fn)
 end
 puts
@@ -45,13 +34,41 @@ unless File.readlines('NEWS.md').drop(2).first =~ / \(\d{4}-\d{2}-\d{2}\)$/
 end
 puts
 
+puts '=== Reading version…'
+require "./lib/#{gem_path}/version"
+version = eval(version_constant) # rubocop:disable Security/Eval
+puts "Version = #{version}"
+puts
+
 puts '=== Building new gem…'
 run('gem', 'build', 'ddtelemetry.gemspec')
 puts
 
-puts '=== Reading version…'
-require './lib/ddtelemetry/version'
-puts "Version = #{DDTelemetry::VERSION}"
+puts '=== Verifying that gems were built properly…'
+gem_filename = "#{gem_name}-#{version}.gem"
+unless File.file?(gem_filename)
+  warn "Error: Could not find gem: #{gem_filename}"
+  exit 1
+end
+puts
+
+puts '=== Verifying that gem version does not yet exist…'
+url = URI.parse("https://rubygems.org/api/v1/versions/#{gem_name}.json")
+response = Net::HTTP.get_response(url)
+existing_versions =
+  case response.code
+  when '404'
+    []
+  when '200'
+    JSON.parse(response.body).map { |e| e.fetch('number') }
+  else
+    warn "Error: Couldn’t fetch version information for #{gem_name} (status #{response.code})"
+    exit 1
+  end
+if existing_versions.include?(version)
+  warn "Error: #{gem_name} v#{version} already exists"
+  exit 1
+end
 puts
 
 puts '=== Verifying that release does not yet exist…'

data/spec/ddtelemetry/counter_spec.rb

@@ -5,42 +5,50 @@ describe DDTelemetry::Counter do
 
   describe 'new counter' do
     it 'starts at 0' do
-      expect(subject.get(:erb)).to eq(0)
-      expect(subject.get(:haml)).to eq(0)
+      expect(subject.get(filter: :erb)).to eq(0)
+      expect(subject.get(filter: :haml)).to eq(0)
     end
   end
 
   describe '#increment' do
-    subject { counter.increment(:erb) }
+    subject { counter.increment(filter: :erb) }
 
     it 'increments the matching value' do
       expect { subject }
-        .to change { counter.get(:erb) }
+        .to change { counter.get(filter: :erb) }
         .from(0)
         .to(1)
     end
 
     it 'does not increment any other value' do
-      expect(counter.get(:haml)).to eq(0)
+      expect(counter.get(filter: :haml)).to eq(0)
       expect { subject }
-        .not_to change { counter.get(:haml) }
+        .not_to change { counter.get(filter: :haml) }
+    end
+
+    context 'non-hash label' do
+      subject { counter.increment('WRONG UGH') }
+
+      it 'errors' do
+        expect { subject }.to raise_error(ArgumentError, 'label argument must be a hash')
+      end
     end
   end
 
   describe '#get' do
-    subject { counter.get(:erb) }
+    subject { counter.get(filter: :erb) }
 
     context 'not incremented' do
       it { is_expected.to eq(0) }
     end
 
     context 'incremented' do
-      before { counter.increment(:erb) }
+      before { counter.increment(filter: :erb) }
       it { is_expected.to eq(1) }
     end
 
     context 'other incremented' do
-      before { counter.increment(:haml) }
+      before { counter.increment(filter: :haml) }
       it { is_expected.to eq(0) }
     end
   end
@@ -49,12 +57,12 @@ describe DDTelemetry::Counter do
     subject { counter.labels }
 
     before do
-      counter.increment(:erb)
-      counter.increment(:erb)
-      counter.increment(:haml)
+      counter.increment(filter: :erb)
+      counter.increment(filter: :erb)
+      counter.increment(filter: :haml)
     end
 
-    it { is_expected.to contain_exactly(:haml, :erb) }
+    it { is_expected.to match_array([{ filter: :haml }, { filter: :erb }]) }
   end
 
   describe '#each' do
@@ -65,12 +73,12 @@ describe DDTelemetry::Counter do
     end
 
     before do
-      counter.increment(:erb)
-      counter.increment(:erb)
-      counter.increment(:haml)
+      counter.increment(filter: :erb)
+      counter.increment(filter: :erb)
+      counter.increment(filter: :haml)
     end
 
-    it { is_expected.to eq(haml: 1, erb: 2) }
+    it { is_expected.to eq({ filter: :haml } => 1, { filter: :erb } => 2) }
 
     it 'is enumerable' do
       expect(counter.map { |_label, count| count }.sort)
@@ -82,17 +90,17 @@ describe DDTelemetry::Counter do
     subject { counter.to_s }
 
     before do
-      counter.increment(:erb)
-      counter.increment(:erb)
-      counter.increment(:haml)
+      counter.increment(filter: :erb)
+      counter.increment(filter: :erb)
+      counter.increment(filter: :haml)
     end
 
     it 'returns table' do
       expected = <<~TABLE
-             │ count
-        ─────┼──────
-         erb │     2
-        haml │     1
+                    │ count
+        ────────────┼──────
+         filter=erb │     2
+        filter=haml │     1
       TABLE
 
       expect(subject.strip).to eq(expected.strip)

data/spec/ddtelemetry/summary_spec.rb

@@ -3,13 +3,23 @@
 describe DDTelemetry::Summary do
   subject(:summary) { described_class.new }
 
+  describe '#observe' do
+    context 'non-hash label' do
+      subject { summary.observe(1.23, 'WRONG UGH') }
+
+      it 'errors' do
+        expect { subject }.to raise_error(ArgumentError, 'label argument must be a hash')
+      end
+    end
+  end
+
   describe '#get' do
-    subject { summary.get(:erb) }
+    subject { summary.get(filter: :erb) }
 
     before do
-      summary.observe(2.1, :erb)
-      summary.observe(4.1, :erb)
-      summary.observe(5.3, :haml)
+      summary.observe(2.1, filter: :erb)
+      summary.observe(4.1, filter: :erb)
+      summary.observe(5.3, filter: :haml)
     end
 
     it { is_expected.to be_a(DDTelemetry::Stats) }
@@ -22,12 +32,12 @@ describe DDTelemetry::Summary do
     subject { summary.labels }
 
     before do
-      summary.observe(2.1, :erb)
-      summary.observe(4.1, :erb)
-      summary.observe(5.3, :haml)
+      summary.observe(2.1, filter: :erb)
+      summary.observe(4.1, filter: :erb)
+      summary.observe(5.3, filter: :haml)
     end
 
-    it { is_expected.to contain_exactly(:haml, :erb) }
+    it { is_expected.to match_array([{ filter: :haml }, { filter: :erb }]) }
   end
 
   describe '#each' do
@@ -38,12 +48,12 @@ describe DDTelemetry::Summary do
     end
 
     before do
-      summary.observe(2.1, :erb)
-      summary.observe(4.1, :erb)
-      summary.observe(5.3, :haml)
+      summary.observe(2.1, filter: :erb)
+      summary.observe(4.1, filter: :erb)
+      summary.observe(5.3, filter: :haml)
     end
 
-    it { is_expected.to eq(haml: 5.3, erb: 3.1) }
+    it { is_expected.to eq({ filter: :haml } => 5.3, { filter: :erb } => 3.1) }
 
     it 'is enumerable' do
       expect(summary.map { |_label, stats| stats.sum }.sort)
@@ -55,17 +65,17 @@ describe DDTelemetry::Summary do
     subject { summary.to_s }
 
     before do
-      summary.observe(2.1, :erb)
-      summary.observe(4.1, :erb)
-      summary.observe(5.3, :haml)
+      summary.observe(2.1, filter: :erb)
+      summary.observe(4.1, filter: :erb)
+      summary.observe(5.3, filter: :haml)
     end
 
     it 'returns table' do
       expected = <<~TABLE
-             │ count    min    .50    .90    .95    max    tot
-        ─────┼────────────────────────────────────────────────
-         erb │     2   2.10   3.10   3.90   4.00   4.10   6.20
-        haml │     1   5.30   5.30   5.30   5.30   5.30   5.30
+                    │ count    min    .50    .90    .95    max    tot
+        ────────────┼────────────────────────────────────────────────
+         filter=erb │     2   2.10   3.10   3.90   4.00   4.10   6.20
+        filter=haml │     1   5.30   5.30   5.30   5.30   5.30   5.30
       TABLE
 
       expect(subject.strip).to eq(expected.strip)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddtelemetry
 version: !ruby/object:Gem::Version
-  version: 1.0.0a2
+  version: 1.0.0a3
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2017-12-25 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -71,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Non-timeseries telemetry