statscloud 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cfc4b9f7ca3ff6dfc74d26c74805c53562ef11ae1842c043ff76fa802025867e
+  data.tar.gz: 8bd02234c81c1537ed5b03b5eb507d31e23cf0140ebf03343445af1d143904c5
+SHA512:
+  metadata.gz: 1036da28708e37ced51549361dc0f200ba3ab9a4386ad9b5ce6b0228d77ed56e25b3ff491ff9d80f449ce9806c42be70da2655ababfd629b93066fd06a13889d
+  data.tar.gz: 09800276336b3e3087c332d27facf0e57118ba3175c141af87b5467a21a7c434ae4d3d9a9b2fa38acb9186bf0f0d957109bd1439556eb6a0a2f819e580226e98

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,72 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Layout/ExtraSpacing:
+  Exclude:
+    - 'statscloud.gemspec'
+
+Layout/LeadingBlankLines:
+  Exclude:
+    - 'statscloud.gemspec'
+
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'statscloud.gemspec'
+
+Layout/SpaceInsideBlockBraces:
+  Exclude:
+    - 'Gemfile'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'statscloud.gemspec'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/statscloud/helpers/socketio_helper.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/statscloud/helpers/socketio_helper.rb'
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+Style/ExpandPathArguments:
+  Exclude:
+    - 'statscloud.gemspec'
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+
+Style/MutableConstant:
+  Exclude:
+    - 'lib/statscloud/version.rb'
+
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'statscloud.gemspec'
+
+Style/StringLiterals:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'bin/console'
+    - 'lib/statscloud/version.rb'
+    - 'spec/spec_helper.rb'
+    - 'spec/statscloud_client_spec.rb'
+    - 'statscloud.gemspec'
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'lib/templates/statscloud/statscloud.rb'
+Style/UnneededPercentQ:
+  Exclude:
+    - 'statscloud.gemspec'
+
+Metrics/LineLength:
+  Max: 120

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    statscloud (1.0.0)
+      activesupport (>= 5.0.0.1)
+      crc32 (~> 1.0.1)
+      eventmachine (~> 1.2)
+      fileutils
+      leon (~> 1.1)
+      logger (~> 1.2)
+      rest-client (~> 2.0.2)
+      statscloud.io-ruby-socket.io-client-simple (~> 1.2.1.pre.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    crc32 (1.0.1)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    event_emitter (0.2.6)
+    eventmachine (1.2.7)
+    fileutils (1.1.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    httparty (0.16.2)
+      multi_xml (>= 0.5.2)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    leon (1.1.2)
+    logger (1.2.8)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
+    netrc (0.11.0)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    statscloud.io-ruby-socket.io-client-simple (1.2.1.pre.2)
+      event_emitter
+      httparty
+      json
+      websocket-client-simple (~> 0.3.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    websocket (1.2.8)
+    websocket-client-simple (0.3.0)
+      event_emitter
+      websocket
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  statscloud!
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1 @@
+(c) Copyright 2018 Agilium Labs LLC, all rights reserved

data/README.md

@@ -0,0 +1,96 @@
+# StatsCloud
+StatsCloud module
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'statscloud'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install statscloud
+
+## Usage
+
+### Rails
+
+1. Run generator for creatinig initializer file, statscloud.io configuration file `.statscloud.yml` and directory for saving your metrics configurations.
+    ```ruby
+    rails g stats_cloud:install
+    ```
+2. Set up your configuration files (you can read more about StatsCloud configuration [here](https://medium.com/@roman.kisilenko/software-application-monitoring-how-to-or-how-not-to-let-your-production-fail-9481dd0ef6de)).
+
+3. You can change `statscloud.rb` intializer file if you want to start StatsCloud service with a different environment or add some tags to your StatsmeterClient.
+    
+    #### `with_environment('env')`
+    This method allows you to record metrics from different environments (like `test`, `development`, `production`) separately, so
+    ```ruby
+    StatsCloud.with_environment('production').start 
+    ```
+    would start StatsCloud service at `production` environment. Without this method, the environment would be chosen from the configuration file. If you don't configure it service would try to find env in the RAILS_ENV and if it is also missing it would set the value as the `default`.
+    
+    #### `with_tags(array[string])`
+    Also, you can start service with sending some tags to the cluster. Tags are used to group metrics. By default, the host name is used as a tag, which allows you to track metrics for both the application as a whole and for each host individually. In the cloud, an array of tags `['region', 'server_name']` can be used, which allows you to track metrics for the application as a whole, separate regions or separate servers.
+    ```ruby
+    StatsCloud.with_tags(['region', 'server_name']).start
+    ```
+    You can combine these methods calling them as a chain.
+     
+4. Use StatsCLoud.meter with `record_event` method for recording one event or `record_events` to send multiple events to cluster from any place of you application.
+
+    ```ruby
+    StatsCloud.meter.record_event('event', 1)
+    StatsCloud.meter.record_events({name: 'gauge', measurement: 123}, {name: 'counter'})
+    ```
+### Ruby
+1. Install `statscloud` gem:
+
+    ```ruby
+    gem install statscloud
+    ```
+ 
+2. Require `statscloud` in the project and set up your application structure, with `.statscloud.yml` configuration file (at the root of the project) and metrics configs (read more about StatsCloud configuration [here](https://medium.com/@roman.kisilenko/software-application-monitoring-how-to-or-how-not-to-let-your-production-fail-9481dd0ef6de)).
+
+3. Customize statscloud run with `with_environment` and `with_tags` methods and start it where you need it.
+
+    ```ruby
+    StatsCloud.with_environment('test').with_tags(['usa', 'server_1']).start
+    ```
+4. Send metrics via StatsCloud.meter
+    
+    ```ruby
+    meter = StatsCloud.meter
+    meter.record_event('event', 1)
+    meter.record_events({name: 'gauge', measurement: 123}, {name: 'counter'});
+    ```
+    
+5. Stop work of StatsCloud service when 'time is over'.
+    ```ruby
+    StatsCloud.stop
+    ```
+    
+The full version of pure ruby example takes the form:
+```ruby
+require 'statscloud' # import gem
+
+# start the module, returns a thread
+StatsCloud.start
+
+# track events (remember that you have to wait for the socket connection to the cluster before record any metrics)
+StatsCloud.meter.record_event('numeric', 123)
+StatsCloud.meter.record_events({name: 'gauge', measurement: 123}, {name: 'counter'})
+
+# stop the module
+StatsCloud.stop
+
+```
+
+## License
+
+(c) Copyright 2018 Agilium Labs LLC, all rights reserved.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "statscloud"
+
+# 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/generators/stats_cloud/install_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module StatsCloud
+  # Rails generator for statscloud configuration.
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../templates/statscloud', __dir__)
+
+    # Creates rails initializer for simultaneous start with rails server.
+    def create_initializer_file
+      copy_file 'statscloud_template.rb', File.join('config', 'initializers', 'statscloud.rb')
+    end
+
+    # Creates directory for saving metrics config files.
+    def create_config_statscloud_directory
+      empty_directory File.join('config', 'statscloud')
+    end
+
+    # Creates statscloud configuration file.
+    def create_config_file
+      copy_file '.statscloud_template.yml', '.statscloud.yml'
+    end
+  end
+end

data/lib/statscloud/cluster_client.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require_relative './helpers/parsed_response_helper'
+require_relative './helpers/logger_helper'
+require 'rest-client'
+
+module StatsCloud
+  # statscloud.io cluster-api service client.
+  class ClusterClient
+    include StatsCloud::LoggerHelper
+
+    # Constructs cluster-api service client instance.
+    #
+    # @param [+String+] env
+    #   cluster api environment
+    #
+    # @param [+String+] host
+    #   cluster api host.
+    #
+    # @api public
+    def initialize(env, host = 'https://cluster-api-v1.statscloud.statscloud.io')
+      @environment = env
+      @host = host
+    end
+
+    # Schedules cluster instance to be retrieved.
+    #
+    # @param [+String+] token
+    #   authorization token.
+    # @param [+String+] app
+    #   cluster name.
+    #
+    # @api public
+    def get_cluster(token, app)
+      url = "#{host}/users/current/clusters/#{app}/#{environment}"
+      response = http_client.get(url, headers(token))
+      get_parsed_response(response)
+    rescue StandardError => error
+      logger.error error
+    end
+
+    # Schedules cluster to be (re)deployed.
+    #
+    # @param [+String+] token
+    #   authorization token.
+    # @param [+String+] app
+    #   cluster name.
+    # @param [+String+] configuration
+    #   cluster configuration
+    #
+    # @api public
+    def deploy_cluster(token, app, configuration)
+      url = "#{host}/users/current/clusters/#{app}/#{environment}"
+      body = body_hash_parameters(configuration)
+      response = http_client.put(url, body.to_json, headers(token))
+      get_parsed_response(response)
+    rescue StandardError => error
+      logger.error error
+    end
+
+    # Schedules cluster to be undeployed.
+    # @param [+String+] token
+    #   authorization token.
+    # @param [+String+] app
+    #   cluster name.
+    #
+    # @api public
+    def undeploy_cluster(token, app)
+      url = "#{host}/users/current/clusters/#{app}/#{environment}/undeploy"
+      response = http_client.post(url, nil, headers(token))
+      get_parsed_response(response)
+    rescue StandardError => error
+      logger.error error
+    end
+
+    private
+
+    attr_reader :host, :environment
+
+    def headers(token)
+      default_headers.merge(auth_headers(token))
+    end
+
+    def default_headers
+      {
+        content_type: :json,
+        accept: :json
+      }
+    end
+
+    def auth_headers(token)
+      {
+        'auth-token' => token
+      }
+    end
+
+    def body_hash_parameters(configuration)
+      {
+        configuration: configuration.to_json
+      }
+    end
+
+    def get_parsed_response(response)
+      StatsCloud::ParsedResponseHelper.new(response)
+    end
+
+    def http_client
+      RestClient
+    end
+
+    def logger
+      @logger ||= ::StatsCloud.logger
+    end
+  end
+end

data/lib/statscloud/helpers/assets_helper.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module StatsCloud
+  # This helper works to gather and merge the configuration from files.
+  module AssetsHelper
+    private
+
+    def asset_selector_matches(filename, asset_selector)
+      includes = asset_selector[:include]
+      excludes = asset_selector[:exclude]
+      process_match(includes, filename) && !process_match(excludes, filename)
+    end
+
+    def collect_statscloud_assets(config, source_mappings, dir = '.')
+      asset_selector = get_checked_asset_selector(config)
+      process_files(dir, config, source_mappings, asset_selector)
+    end
+
+    def join_configs(config, extra_config, source_mappings, file_name)
+      process_array_fields(config, extra_config, source_mappings, file_name)
+      process_object_fields(config, extra_config, source_mappings, file_name)
+      process_value_fields(config, extra_config)
+    end
+
+    def get_checked_asset_selector(config)
+      asset_selector = config[:assetSelector] || {
+        include: ['.*\.statscloud.yml'], exclude: []
+      }
+      asset_selector[:include] = put_to_array_if_needed(asset_selector[:include])
+      asset_selector[:exclude] = put_to_array_if_needed(asset_selector[:exclude])
+      asset_selector
+    end
+
+    def get_config_from_file(file)
+      return ::YAML.load_file(file) if File.exist?(file)
+      {}
+    end
+
+    def process_files(dir, config, source_mappings, asset_selector)
+      entries = Dir.entries(dir)
+      entries.reduce({}) do |_config, entry|
+        file_name = File.join(dir, entry)
+        if it_directory?(file_name, entry)
+          collect_statscloud_assets(config, source_mappings, file_name)
+        elsif it_config_file?(file_name, asset_selector)
+          extra_config = get_config_from_file(file_name)
+          join_configs(config, extra_config, source_mappings, file_name)
+        end
+      end
+    end
+
+    def process_match(list, filename)
+      list.reduce(false) do |match, pattern|
+        match || Regexp.new(pattern).match(filename)
+      end
+    end
+
+    def process_array_fields(config, extra_config, source_mappings, file_name)
+      array_fields.each do |array_field|
+        next unless it_not_empty_array?(extra_config, array_field)
+        config[array_field] ||= []
+        source_mappings[array_field.to_sym].push(source_map_index(config, extra_config, array_field, file_name))
+        config[array_field] = config[array_field].concat(extra_config[array_field])
+      end
+    end
+
+    def process_object_fields(config, extra_config, source_mappings, file_name)
+      object_fields.each do |object_field|
+        next unless extra_config[object_field]&.kind_of?(Hash)
+        source_mappings[object_field.to_sym].push(
+          fields: extra_config[object_field].keys,
+          sourceFile: file_name
+        )
+        config[object_field] = (config[object_field] || {}).merge(extra_config[object_field])
+      end
+    end
+
+    def process_value_fields(config, extra_config)
+      value_fields.each do |field|
+        config[field] = extra_config[field] if config[field].nil? && !extra_config[field].nil?
+      end
+    end
+
+    def put_to_array_if_needed(object)
+      object.is_a?(Array) ? object : [object]
+    end
+
+    def it_directory?(file_name, entry)
+      File.directory?(file_name) && not_required_directory.exclude?(entry)
+    end
+
+    def it_config_file?(file_name, asset_selector)
+      File.stat(file_name).file? && asset_selector_matches(file_name, asset_selector)
+    end
+
+    def it_not_empty_array?(extra_config, field)
+      extra_config[field]&.kind_of?(Array) && extra_config[field].length.positive?
+    end
+
+    def source_map_index(config, extra_config, array_field, file_name)
+      start_index = config[array_field].length
+      {
+        startIndex: start_index,
+        endIndex: start_index + extra_config[array_field].length - 1,
+        sourceFile: file_name
+      }
+    end
+
+    def not_required_directory
+      %w[. ..]
+    end
+
+    def array_fields
+      %w[alerts dashboards]
+    end
+
+    def object_fields
+      %w[metrics admins]
+    end
+
+    def value_fields
+      %w[token application environment endpoint assetSelector propagateErrors
+         passwordProtect retention flushIntervalInSeconds diskSize]
+    end
+  end
+end

data/lib/statscloud/helpers/event_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module StatsCloud
+  # This helper works with events.
+  module EventHelper
+    private
+
+    # Byte size for measurement.
+    MEASUREMENT_SIZE = 4
+
+    def get_binary_length(size)
+      size + MEASUREMENT_SIZE
+    end
+
+    def get_plain_length(name, measurement)
+      name.length + (measurement ? MEASUREMENT_SIZE + 1 : 0) + 1
+    end
+
+    def get_event_name(event)
+      event[:name].to_s
+    end
+
+    def get_event_measurement(event)
+      event[:measurement]&.to_s
+    end
+  end
+end

data/lib/statscloud/helpers/logger_helper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module StatsCloud
+  # This helper works to help log errors and info about StatsCloud service work.
+  module LoggerHelper
+    # Log information about work to standart ouput
+    def logger
+      file_utils.mkdir_p 'log'
+      @logger ||= logger_servise.new(File.join('log', 'statscloud.log')).tap do |log|
+        log.progname = 'StatsCloud'
+      end
+    end
+
+    private
+
+    def logger_servise
+      Logger
+    end
+
+    def file_utils
+      FileUtils
+    end
+  end
+end

data/lib/statscloud/helpers/parsed_response_helper.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'active_support/all'
+
+module StatsCloud
+  # This helper works to parse response from the server to convenient object.
+  class ParsedResponseHelper
+    # RestClient json-parsed response body.
+    #
+    # Type: *Hash*
+    attr_reader :body
+
+    # RestClient response code.
+    #
+    # Type: *Integer*
+    attr_reader :code
+
+    # Creates new helper object with parsed response body as json.
+    #
+    # @param [+RestClient::Response+] response
+    #   response from the cluster.
+    def initialize(response)
+      @code = response&.code
+      @body = parse_json(response.body)
+    end
+
+    private
+
+    def parse_json(json, default = nil)
+      JSON.parse(json).with_indifferent_access
+    rescue JSON::ParserError
+      default
+    end
+  end
+end