tsd_metrics 0.2.0 → 0.2.8

data/lib/tsd_metrics/units.rb

@@ -0,0 +1,22 @@
+# Copyright 2014 Groupon.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+module TsdMetrics
+  UNITS = Set.new([:nanosecond, :microsecond, :millisecond, :second, :minute, :hour, :day, :week, :bit, :byte, :kilobit, :kilobyte, :megabit, :megabyte, :gigabit, :gigabyte, :terabyte, :petabyte])
+  class UnitsUtils
+    def self.isValidUnitValue?(unit)
+      return unit == :noUnit || UNITS.include?(unit)
+    end
+  end
+end

data/lib/tsd_metrics.rb

@@ -1,32 +1,80 @@
-require_relative 'tsd_metrics/tsd_metric_2c'
+# Copyright 2014 Groupon.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+require_relative 'tsd_metrics/tsd_metric'
 require_relative 'tsd_metrics/queue_writer'
 require_relative 'tsd_metrics/async_queue_writer'
 require_relative 'tsd_metrics/metric_builder_for_single_struct_receiver'
-require_relative 'tsd_metrics/json_formatter_receiver'
+require_relative 'tsd_metrics/json_formatting_sink'
 require 'thread'
 require 'logger'
 
 module TsdMetrics
+  attr_reader :errorLogger
   @metricBuilder = nil
-  @writerThread = nil
-  @fileWriter = nil
+  @@errorLogger = nil
 
-  def self.buildMetric
-    init() if @metricBuilder == nil
-    @metricBuilder.build
-  end
+  # +filename+:: Optional: the relative or absolute path to output metrics. Default: 'query.log' in the working directory
+  # +errorLogger+:: Optional: a place to which mis-uses of the library can be logged.
+  #   Expects methods +info+, +warn+, +error+
+  # +rollLogs+:: Optional: Have the library do log rolling; not thread-safe! Setting to false means the library-user should have external log-rolling in place. Default: true
+  def self.init(providedOpts={})
+    defaultOpts = {filename: "query.log", rollLogs: true}
+    opts = defaultOpts.merge providedOpts
+    @errorLogger = opts[:errorLogger] || Logger.new(STDOUT)
 
-  def self.init(filename="tsd_metric_2c.json")
     outputFileQueue = Queue.new
-    # create writer
+
+    # JSON to queue
     writer = QueueWriter.new(outputFileQueue)
-    # create json formatter to take newly-closed metrics
-    formatterStructReveiver = JsonFormatterReceiver.new(writer)
+
+    # Metric to JSON
+    formatterStructReveiver = JsonFormattingSink.new(writer)
     @metricBuilder = MetricBuilderForSingleStructReceiver.new(formatterStructReveiver)
-    logger = createHeaderlessLogger(filename, "daily")
-    # Create async monitor
-    @queueToFileWriter = AsyncQueueWriter.new(outputFileQueue, logger)
+
+    loggerOptions = [opts[:filename]]
+    # Set the ':daily' option on the logger if we want to roll the logs
+    loggerOptions.push(:daily) if opts[:rollLogs]
+    # TODO(mhayter): Switch to hourly rolling (will need different log lib)
+    # [MAI-173]
+    # File writer
+    toFileLogger = createHeaderlessLogger(*loggerOptions)
+
+    # Queue to file
+    @queueToFileWriter = AsyncQueueWriter.new(outputFileQueue, toFileLogger)
     @queueToFileWriter.start
+
+    # Phusion Passenger loses all threads on a fork, this is added
+    # so that the writing thread is recreated.
+    # This code was found at
+    # https://www.phusionpassenger.com/documentation/Users%20guide%20Nginx.html#_smart_spawning_caveat_2_the_need_to_revive_threads
+    if defined?(PhusionPassenger)
+      PhusionPassenger.on_event(:starting_worker_process) do |forked|
+        if forked
+          outputFileQueue.clear
+          @queueToFileWriter.start
+        else
+          # We're in direct spawning mode. We don't need to do anything.
+        end
+      end
+    end
+
+  end
+
+  def self.buildMetric
+    init() if @metricBuilder == nil
+    @metricBuilder.build
   end
 
   private

data/resources/LICENSE

@@ -0,0 +1,158 @@
+Apache License
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License,
+each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,
+no-charge, royalty-free, irrevocable (except as stated in this section) patent
+license to make, have made, use, offer to sell, sell, import, and otherwise
+transfer the Work, where such license applies only to those patent claims
+licensable by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s) with the Work
+to which such Contribution(s) was submitted. If You institute patent litigation
+against any entity (including a cross-claim or counterclaim in a lawsuit)
+alleging that the Work or a Contribution incorporated within the Work
+constitutes direct or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate as of the date
+such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and in
+Source or Object form, provided that You meet the following conditions:
+
+a. You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+b. You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+c. You must retain, in the Source form of any Derivative Works that You 
+distribute, all copyright, patent, trademark, and attribution notices from the
+Source form of the Work, excluding those notices that do not pertain to any part
+of the Derivative Works; and
+d. If the Work includes a "NOTICE" text file as part of its distribution, then
+any Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License. 
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein shall
+supersede or modify the terms of any separate license agreement you may have
+executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as required
+for reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties
+or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any risks
+associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in
+tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to in
+writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages of any character
+arising as a result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill, work stoppage,
+computer failure or malfunction, or any and all other commercial damages or
+losses), even if such Contributor has been advised of the possibility of such
+damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or
+Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole
+responsibility, not on behalf of any other Contributor, and only if You agree
+to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/spec/integration_spec.rb

@@ -0,0 +1,84 @@
+# Copyright 2014 Groupon.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+require "tsd_metrics"
+require "thread"
+require "pry"
+require "json-schema"
+
+describe "creating metrics" do
+  before(:each) do
+    begin
+      File.delete filename
+    rescue
+    end
+  end
+  let(:filename) { "my_file.json" }
+
+  def checkFileForNWellFormedLines(n)
+    File.open filename, "r" do |file|
+      count = 0
+      while true
+        line = file.readline rescue break
+        JSON::Validator.validate!("doc/query-log-schema-2e.json", line)
+        count += 1
+      end
+      count.should == n
+    end
+  end
+
+  it "writes three metrics to the file" do
+    # init
+    TsdMetrics.init(filename: filename)
+    # build metric, close
+    metric = TsdMetrics.buildMetric
+    metric.startTimer("myTimer")
+    metric.setGauge("myGauge", 20)
+    metric.incrementCounter("myCounter", 20)
+    metric.stopTimer("myTimer")
+    metric.close
+    # metric, close
+    metric = TsdMetrics.buildMetric
+    metric.setGauge("myGauge", 20)
+    metric.close
+    # metric, close
+    metric = TsdMetrics.buildMetric
+    metric.setGauge("myGauge", 20)
+    metric.close
+
+    sleep(0.1)
+
+    checkFileForNWellFormedLines(3)
+  end
+
+  it "does not write empty metrics to the file" do
+    TsdMetrics.init(filename: filename)
+    # build metric, close
+    metric = TsdMetrics.buildMetric
+    metric.setGauge("myGauge", 20)
+    metric.close
+    # metric, close
+    metric = TsdMetrics.buildMetric
+    metric.setGauge("myGauge", 20)
+    metric.close
+
+    # EMPTY metric
+    metric = TsdMetrics.buildMetric
+    metric.close
+
+    sleep(0.1)
+
+    checkFileForNWellFormedLines(2)
+  end
+end

data/spec/json_formatter_spec.rb

@@ -0,0 +1,99 @@
+# Copyright 2014 Groupon.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.
+
+require "tsd_metrics/json_formatting_sink"
+require "json"
+require "json-schema"
+require 'timecop'
+require 'time'
+
+describe "JsonFormattingSink" do
+  let(:outputStreamMock) do
+    mock = double()
+  end
+  let(:minimalStruct) do
+    {
+      gauges: {
+        "myGauge" => [{value: 4}]
+      },
+      timers: {
+        "myGauge" => [{value: 427297}]
+      },
+      counters: {
+        "myCounter" => [{value: 16238}, {value: 948}]
+      },
+      annotations: {
+        "myAnnotation" => "Nevermore, quoth the Raven",
+        initTimestamp: Time.parse("2014-11-02T03:33:38.000Z"),
+        finalTimestamp: Time.parse("2014-11-02T03:33:40.838Z")
+      }
+    }
+  end
+
+  let(:zeroSampleStruct) do
+    {
+      gauges: {
+      },
+      timers: {
+      },
+      counters: {
+      },
+      annotations: {
+        initTimestamp: 1393037729.0,
+        finalTimestamp: 1393037735.0
+      }
+    }
+  end
+  let(:receiver) { JsonFormattingSink.new(outputStreamMock) }
+
+  def captureOutput(metricStructMock)
+    json = nil
+    allow(outputStreamMock).to receive(:write) do |outputJson|
+      json = outputJson
+    end
+    receiver.receive(metricStructMock)
+    json
+  end
+
+  it "contains all the metric data" do
+
+    jsonString = captureOutput(double(minimalStruct))
+    expect(jsonString).to include("427297")
+    expect(jsonString).to include("16238")
+    expect(jsonString).to include("948")
+    expect(jsonString).to include('"Nevermore, quoth the Raven"')
+    expect(jsonString).to include('"2014-11-02T03:33:38.000Z"')
+    expect(jsonString).to include('"2014-11-02T03:33:40.838Z"')
+
+  end
+
+  it "includes the time as ISO8601 in UTC" do
+    timeString = '"2014-11-02T03:33:38.000Z"'
+    Timecop.freeze(Time.parse(timeString))
+
+    jsonString = captureOutput(double(minimalStruct))
+    expect(jsonString).to include(timeString)
+    Timecop.return
+  end
+
+  it "conforms to the JSON schema" do
+    jsonString = captureOutput(double(minimalStruct))
+    JSON::Validator.validate!("doc/query-log-schema-2e.json", jsonString)
+  end
+
+  it "does not output anything when no samples are present" do
+    expect(outputStreamMock).to_not receive(:write)
+    receiver.receive(double(zeroSampleStruct))
+  end
+end