mobile_metrics 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66ed534e226cd7151aba4d7c2bae9ca551af7361
+  data.tar.gz: d9833bebadf111fab41104b16bfe15ebb321c52f
+SHA512:
+  metadata.gz: 130948656a1dcf4546ffe2a2fb85d53ec06952409fe17c3118679903680801fe0f5cb8ad5553f730e1621a507b47022d6654be8b3cf9082a7e11c8b8f2d263b7
+  data.tar.gz: b9a3295ba27805917a25cd024e6f51818ce5a330af93497a1503ed4c456344d15d561ba4cedd52f62779a0b03e84e88be2922c1197abe8e04e68db9808feb8ab

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mobile_metrics.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    mobile_metrics (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  mobile_metrics!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mobile_metrics"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mobile_metrics.rb

@@ -0,0 +1,330 @@
+require "mobile_metrics/version"
+
+require 'time'
+require 'json'
+require 'securerandom'
+require 'fileutils'
+require 'pathname'
+
+# Metric types
+METRIC_TIMER    = 'x.mobile_metric.timer'
+METRIC_COUNTER  = 'x.mobile_metric.counter'
+METRIC_RATIO    = 'x.mobile_metric.ratio'
+METRIC_SIZE     = 'x.mobile_metric.size'
+
+# Misc Constants
+UNKNOWN = 'UNKNOWN'
+LOG_PREFIX = 'CI-METRICS:'
+LOGGING_DIR = '/tmp/cimetricslogs' 
+UPLOAD_ENV_VAR = 'MOBILE_METRICS_UPLOAD_LOCATION'
+
+module MobileMetrics 
+  class Log
+
+    @@in_progress_timers = {}
+    @@log_file = nil
+    @@env_values = nil
+    @@verbose = false
+    @@upload_location = nil
+    
+    #========================================
+    # Configuration
+    #=========================================
+    
+    # Named params, with ability to override / leave out stuff we don't care about.
+    def self.set_default_values(
+      # Required params
+      project:,
+      # These params either aren't required, or have sensible defaults.
+      level: "info", 
+      platform: "iOS", 
+      buildUrl: ENV['BUILD_URL'], 
+      gitUrl: ENV['GIT_URL'], 
+      gitBranch: ENV['DOTCI_BRANCH'], 
+      gitSha: ENV['DOTCI_SHA'], 
+      # no sensible defaults for these, we'll strip them later
+      buildType: UNKNOWN, 
+      brand: UNKNOWN,
+      # Controls log levels within this class
+      verbose: false,
+      # Upload location for logs
+      upload_location: nil
+      ) 
+      
+      #TODO: May be able to support overridding these at some point in the future.
+      # It won't be threadsafe, but our builds aren't parallelized at the build script level anyway.
+      if @@env_values
+        print 'Can only override default values once! Aborting!'
+        return
+      end
+      
+      if project.nil? 
+        print 'Project value for logging MUST be non-nil, failing build.'
+        exit 14
+        return
+      end
+      
+      @@verbose = verbose
+      
+      # Upload location
+      @@upload_location = (upload_location || ENV[UPLOAD_ENV_VAR])
+      if @@upload_location.nil? 
+        print 'Upload location value for logging MUST not be nil, exiting.'
+        exit 15
+        return
+      end
+      
+      # Create the logging dir + filename
+      FileUtils.mkdir_p(LOGGING_DIR)
+      filename = "metrics_#{project}_#{build_number}.log"
+      @@log_file = Pathname.new(LOGGING_DIR) + filename
+      print @@log_file if @@verbose
+      
+      # Populate our env values
+      @@env_values = {}
+      
+      # Required
+      @@env_values[:project] = project
+      # Optional
+      @@env_values[:level] = level
+      @@env_values[:platform] = platform
+      @@env_values[:gitUrl] = gitUrl
+      @@env_values[:gitBranch] = gitBranch
+      @@env_values[:gitSha] = gitSha
+      @@env_values[:buildUrl] = buildUrl
+      
+      #TODO: Should any of these be required? 
+      @@env_values[:buildType] = buildType if buildType != UNKNOWN
+      @@env_values[:brand] = brand if brand != UNKNOWN
+    end
+    
+  # =begin
+  #   # Sample timer metric
+  #   {
+  #   "time": "<yyyy-MM-ddThh:mm:ss[.sss]Z>",
+  #   "name": "x.mobile_metric.<metric_type>",
+  #   "level": "info",
+  #   "data": {
+  #      "name": "<metric_name>",
+  #      … // additional data per metric type
+  #   }
+  #   "context": {
+  #     "platform": "<ios_or_android>",
+  #     "project": "<project_name>",
+  #     "gitUrl": "<git_url>",
+  #     "gitBranch": "<git_branch>",
+  #     "gitSha": "<git_sha>",
+  #     "buildType": "<build_type>",
+  #     "brand": "<brand>",
+  #     "host": "<machine_dns_name_or_device_name>",
+  #     "processId": "<process_id_or_build_number>"
+  #   }
+  # }
+  # =end
+
+    #=========================================
+    # Public Logging Methods
+    #=========================================
+    
+    def self.log_ratio_metric(name:, ratio:)
+      overrides = {name: METRIC_RATIO, data: {name: name, ratio: ratio.to_f }}
+      metric = merge_hashes(default_metric, overrides).to_json
+      append_to_log(metric)
+    end
+    
+    def self.log_counter_metric(name:, count:)
+      overrides = {name: METRIC_COUNTER, data: {name: name, count: count.to_i }}
+      metric = merge_hashes(default_metric, overrides).to_json
+      append_to_log(metric) 
+    end
+    
+    def self.log_size_metric(name:, sizeInBytes:, filename:, artifactUrl:)
+      overrides = {name: METRIC_SIZE, data: {name: name, filename: filename, sizeInBytes: sizeInBytes, artifactUrl: artifactUrl }}
+      metric = merge_hashes(default_metric, overrides).to_json
+      append_to_log(metric)
+    end
+    
+    def self.start_timer_metric(name:)
+      if @@in_progress_timers.has_key?(name) 
+        print "WARNING: #{name} already has a running timer, refusing to start a new timer"
+        return
+      end
+      @@in_progress_timers[name] = monotonic_timestamp
+    end
+    
+    def self.end_timer_metric(name:)
+      if !@@in_progress_timers.has_key?(name)
+        print "WARNING: #{name} does not have a running timer, the end_timer_metric call has no effect"
+        return
+      end
+      
+      # Calculate delta
+      start = @@in_progress_timers[name]
+      now = monotonic_timestamp
+      delta_in_ms = ((now - start) * 1000).to_i
+      
+      # remove existing timer
+      @@in_progress_timers.delete(name)
+      
+      # log to file
+      overrides = {name: METRIC_TIMER, data: {name: name, duration: delta_in_ms }}
+      metric = merge_hashes(default_metric, overrides).to_json
+      append_to_log(metric)
+    end
+    
+    # Block based timer. This is the recommended way to timer operations.
+    def self.time(name:, &block)
+      self.start_timer_metric(name: name)
+      yield
+      self.end_timer_metric(name: name)
+    end
+    
+    def self.upload_logs()
+      # Already called upload logs before, second time is a no-op 
+      if @@log_file.nil? || !@@log_file.file? 
+        print "WARN: Log file is empty or doesn't exist. Was upload_logs called previously?"
+        return 
+      end
+      
+      # Skip uploads for local dev machines
+      if !should_upload_logs() 
+        print 'Detected local machine, refusing to upload build metrics. Removing intermediate log file'
+        remove_log_file()
+        return
+      end
+      
+      # Warn for any open timers
+      if @@in_progress_timers.size > 0 
+        @@in_progress_timers.each { |k,v| 
+          print "WARN: Timer not closed when upload_logs was called: #{k}"
+        }
+      end
+      
+      # Upload 
+      upload_log_file()
+      
+      # Remove log file
+      remove_log_file()
+    end
+    
+    def self.log_file()
+      @@log_file
+    end
+    
+    def self.upload_location()
+      @@upload_location
+    end
+    
+    # Tears down logging instance, removes any intermediate log files.
+    # Does not finalize or upload any in-progress logs.
+    # To use the logger again, you'll have to call set_default_values before any other methods.
+    def self.reset()
+      if @@log_file 
+        remove_log_file()
+      end
+      @@log_file = nil
+      @@env_values = nil
+      @@in_progress_timers = {}
+      @@verbose = false
+      @@upload_location = nil
+    end
+    
+    def self.remove_all_log_files()
+      FileUtils.rm_rf(LOGGING_DIR) 
+    end
+    
+  private
+
+    # Creates a stubbed metric with common fields
+    def self.default_metric() 
+      if !@@env_values
+        print 'default_metric called before env_values initialized, aborting!'
+        exit 12
+      end
+
+      context = {
+        platform: @@env_values[:platform],
+        project: @@env_values[:project],
+        # name is overridden per metric, so not present here.
+        gitUrl: @@env_values[:gitUrl],
+        gitBranch: @@env_values[:gitBranch],
+        gitSha: @@env_values[:gitSha],
+        buildType: @@env_values[:buildType],
+        brand: @@env_values[:brand],
+        buildUrl: @@env_values[:buildUrl],
+        host: hostname(),
+        processId: build_number()
+      }.select { |k,v| !v.nil? } 
+      {time: timestamp(), level:@@env_values[:level], context: context}
+    end
+    
+    def self.append_to_log(value)
+      # Create the log file if it doesn't exist
+      if !@@log_file.file? 
+        FileUtils.touch(@@log_file) 
+      end
+      File.open(@@log_file, 'a+') { |f| f.puts(value + "\n") }
+    end
+    
+    def self.remove_log_file()
+      FileUtils.rm_rf(@@log_file)
+    end
+    
+    def self.upload_log_file()
+      destination = @@upload_location + "metrics_#{@@env_values[:project]}_#{build_number}.log"
+      command = "scp -v -o StrictHostKeyChecking=no #{@@log_file} #{destination}"
+      # This feels icky
+      print `#{command}`
+    end
+
+    # Returns a timestamp as a string in the correct logging format.
+    # Note: This format doesn't currently add milliseconds.
+    # Example: "2018-03-27T21:12:21Z"
+    # Note: DO NOT use this for benchmarking / measuring timers, see monotonic_timestamp instead.
+    def self.timestamp() 
+      Time.now.utc.iso8601.to_s
+    end
+    
+    # Returns a floating point monotonic timestamp suitable for timers
+    # Monotonic means we won't ever go back for things like leap seconds
+    # Unit is a floating point in seconds.
+    def self.monotonic_timestamp()
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+    
+    # Util method for merging the default hash values and overrides recursively as we want them
+    def self.merge_hashes(default, overrides)
+      default.merge(overrides) { |key, oldval, newval| 
+        if key == :data || key == :contenxt 
+          oldval.merge(newval)
+        else
+          newval
+        end
+      }
+    end
+    
+    # Returns the host name of the machine we are currently running on 
+    def self.hostname() 
+      ENV['NODE_NAME'] || 'local-dev'
+    end
+    
+    def self.build_number() 
+      ENV['BUILD_NUMBER']
+    end
+    
+    # This method checks against a bunch of default environment variables available through DOTCI
+    # The intent is never to upload timing logs from a local machine, so we make it unlikely that these 
+    # env variables are present on a dev's local machine
+    def self.should_upload_logs()
+      have_workspace = ENV['WORKSPACE'] && !ENV['WORKSPACE'].empty?
+      have_build_number = ENV['BUILD_NUMBER'] && !ENV['BUILD_NUMBER'].empty?
+      have_jenkins_url = ENV['JENKINS_URL'] && !ENV['JENKINS_URL'].empty?
+      have_ci_var = ENV['CI'] && !ENV['CI'].empty?
+      have_workspace && have_build_number && have_jenkins_url && have_ci_var
+    end
+    
+    def self.print(val)
+      puts("#{LOG_PREFIX} #{val}")
+    end
+  end
+end

data/lib/mobile_metrics/version.rb

@@ -0,0 +1,3 @@
+module MobileMetrics
+  VERSION = "0.0.1"
+end

data/mobile_metrics.gemspec

@@ -0,0 +1,25 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mobile_metrics/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mobile_metrics"
+  spec.version       = MobileMetrics::VERSION
+  spec.authors       = ["dbeard"]
+  spec.email         = ["dbeard@groupon.com"]
+
+  spec.summary       = %q{Mobile logging format library}
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features|README|scripts)/}) || f.match(%r{^(.ci|README.md)})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: mobile_metrics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- dbeard
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- dbeard@groupon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mobile_metrics.rb
+- lib/mobile_metrics/version.rb
+- mobile_metrics.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Mobile logging format library
+test_files: []