statscloud 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09e53f93e0256bdb1d7cca10342ca813c3f24ca2
-  data.tar.gz: 8908fbe41125fdd6360e67a1f14abc2118ae7a55
+  metadata.gz: c746267bab13cd8c99e02f033e224ebae2417796
+  data.tar.gz: 45a4b15bdd510a44f43ca8ab46af9d38b6fedef3
 SHA512:
-  metadata.gz: c5bd4090110b99032c7994729bae102d56a53b1479ff8ca0dad5e94ab3e2512a5ca8fa29b48cf20678048d78f3891f5c777c4f5f87b7bcd42c27f31b60f63e8d
-  data.tar.gz: 8c56520587fb19179306cd19dd52d49b3ad9ab5f964ef53b42ce7f013f40565b15c6cccbab964796f76f3ed1c39b384cfceff52afaf4179b3e965fcd72e3eb96
+  metadata.gz: af4f74b24c2a6d149de0d8bb48f19a5016dbdaa8cede112fbc3ce1b9e48507381b7d0cf9b0f9d703a93586f11407757e5faa77d367ff8e109d3aef910e7b253a
+  data.tar.gz: 5b8269f4d83d72e30fccbdefa03e4537947556dc7eb20da2751f3fcfefa455d206a32dfbaadbc5f9d61bf3d160f993368bb604b4f3b48544ce1c460d6d7ae9ec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    statscloud (1.1.2)
+    statscloud (1.2.0)
       crc32 (~> 1.0.1)
       eventmachine (~> 1.2)
       fileutils

data/LICENSE

@@ -0,0 +1,37 @@
+(c) Copyright 2018 Agilium Labs LLC, all rights reserved
+
+Certain inventions disclosed in this file may be claimed within
+patents owned or patent applications filed by Agilium Labs LLC or third
+parties.
+
+Subject to the terms of this notice, Agilium Labs LLC grants you a
+nonexclusive, nontransferable license, without the right to
+sublicense, to (a) install and execute one copy of these files on any
+number of workstations owned or controlled by you and (b) distribute
+verbatim copies of these files to third parties.  As a condition to the
+foregoing grant, you must provide this notice along with each copy you
+distribute and you must not remove, alter, or obscure this notice. All
+other use, reproduction, modification, distribution, or other
+exploitation of these files is strictly prohibited, except as may be set
+forth in a separate written license agreement between you and Agilium Labs LLC.
+The terms of any such license agreement will control over this
+notice.  The license stated above will be automatically terminated and
+revoked if you exceed its scope or violate any of the terms of this
+notice.
+
+This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of Agilium Labs LLC, except as
+required for reasonable and customary use in describing the origin of
+this file and reproducing the content of this notice.  You may not
+mark or brand this file with any trade name, trademarks, service
+marks, or product names other than the original brand (if any)
+provided by Agilium Labs LLC.
+
+Unless otherwise expressly agreed by Agilium Labs LLC in a separate written
+license agreement, these files are provided AS IS, WITHOUT WARRANTY OF
+ANY KIND, including without any implied warranties of MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, TITLE, or NON-INFRINGEMENT.  As a
+condition to your use of these files, you are solely responsible for
+such use. Agilium Labs LLC will have no liability to you for direct,
+indirect, consequential, incidental, special, or punitive damages or
+for lost profits or data.

data/README.md

@@ -1,7 +1,6 @@
-# StatsCloud
-StatsCloud module
-## Installation
+## statscloud.io Ruby client
 
+### Install
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -10,111 +9,81 @@ gem 'statscloud'
 
 And then execute:
 
-    $ bundle
+```bash
+bundle
+```
 
-Or install it yourself as:
+### Use
+Make sure you confgured statscloud via .statscloud.yml configuration file. Read https://medium.com/@roman.kisilenko/software-application-monitoring-how-to-or-how-not-to-let-your-production-fail-9481dd0ef6de for configuration options.
 
-    $ gem install statscloud
+```ruby
+# require gem
+require 'statscloud' 
 
-## Usage
+# use default client via StatsCloud module
+statscloud = StatsCloud
 
-### Rails
+# optionally, specify environment and/or tags
+statscloud.with_environment('staging').with_tags(['us-west-2', 'my-server'])
 
-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)). 
-   
-   StatsCloud auth token is a required parameter for getting access to StatsCloud service. The best way to configure this auth token in your application is using environment variable `STATSCLOUD_AUTH_TOKEN`. StatsCloud add-on at Heroku configures this environment variable automatically during adding this add-on to your application. If you want to use statscloud service in your development process (or somewhere else) you can [copy Heroku config vars to your local .env file](https://devcenter.heroku.com/articles/heroku-local).
+# start the StatsCloud client
+statscloud.start()
+
+# track events
+statscloud.record_event('statistics', 123)
+statscloud.record_events({name: 'gauge', measurement: 123}, {name: 'counter'})
+
+# stop the module (useful for tests)
+statscloud.stop()
+```
+
+### Creating multiple clients
+You can also create multiple clients with custom config files:
 
-3. You can change `statscloud.rb` intializer file if you want to start StatsCloud service with a different environment, create several instances of StatsCloud::Client with different configurations 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::Client.new.with_environment('production')
-    ```
-    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])`
-    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::Client.new.with_tags(['region', 'server_name'])
-    ```
-    #### `with_config_file(file)`
-    Also, it's available to set up several StatsCloud clients with different configuration files via `with_config_file` method.
-    ```ruby
-    StatsCloud::Client.new.with_config_file('.production_statscloud.yml')
-    ```
-    
-    You can combine these methods calling them as a chain.
-     
-4. StatsCloud initializer defines `StatsCloudClient` constant which you can use to record metrics with `record_event` method for recording one event or `record_events` to send multiple events to cluster from any place of your application:
-
-    ```ruby
-    StatsCloudClient.meter.record_event('event', 1)
-    StatsCloudClient.meter.record_events({name: 'gauge', measurement: 123}, {name: 'counter'})
-    ```
-    Also, you can use these methods directly from StatsCloudClient:
-    ```ruby
-    StatsCloudClient.record_event('event', 1)
-    StatsCloudClient.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`, `with_tags` and `with_config_file` methods and start it where you need it.
-
-    ```ruby
-    statscloud_client = StatsCloud::Client.new
-    statscloud_client.with_environment('test').with_tags(['usa', 'server_1']).start
-    ```
-4. Send metrics via statscloud_client.meter or directly via StatsCloud::Client instance:
-    
-    ```ruby
-    meter = statscloud_client.meter
-    meter.record_event('event', 1)
-    meter.record_events({name: 'gauge', measurement: 123}, {name: 'counter'})
-    
-    # also available and preferable
-        
-    statscloud_client.record_event('some_event', 4)
-    statscloud_client.record_events({name: 'some_gauge', measurement: 321})
- 
-    ```
-    
-5. Stop work of StatsCloud service when 'time is over':
-    ```ruby
-    statscloud_client.stop
-    ```
-    
-The full version of pure ruby example takes the form:
 ```ruby
-require 'statscloud' # import gem
+# require gem
+require 'statscloud' 
+
+# use default client via StatsCloud module
+statscloud = StatsCloud
 
-# start the module, returns a thread
-statscloud_client = StatsCloud::Client.new
-statscloud_client.start
+# optionally, specify environment and/or tags
+statscloud.with_environment('staging').with_tags(['us-west-2', 'my-server'])
 
-meter = statscloud_client.meter
-# track events (remember that you have to wait for the socket connection to the cluster before record any metrics)
-meter.record_event('numeric', 123)
-meter.record_events({name: 'gauge', measurement: 123}, {name: 'counter'})
+# start the StatsCloud client
+statscloud.start
 
-statscloud_client.record_event('some_event', 123)
+# create custom client, tags and environment will be copied from default client
+business_client = statscloud.clone_with_config_file('.business.statscloud.yml')
 
-# stop cluster work
-statscloud_client.stop
+# you can change tags and environment for custom client
+business_client.with_environment('production').with_tags('other-server')
 
+# and start as usual
+business_client.start
+
+# track events
+statscloud.record_event('statistics', 123)
+statscloud.record_events({name: 'gauge', measurement: 123}, {name: 'counter'})
+business_client.record_event('business-metric', 123)
+
+# stop the module (useful for tests)
+statscloud.stop
 ```
 
-## License
+### Specify token in environment variable
+If token is not specified in .statscloud.yml configuration file, then it will be retrieved from STATSCLOUD_AUTH_TOKEN environment variable.
+
+### Usage in Rails framework
 
-(c) Copyright 2018 Agilium Labs LLC, all rights reserved.
+You can use a generator for creatinig initializer file, statscloud.io configuration file and directory for saving your metrics configurations.
+```bash
+rails g stats_cloud:install
+```
+
+You can then change `statscloud.rb` intializer file as needed.
+    
+StatsCloud initializer exposes StatsCloud client as StatsCloud constant, so that you can use it from your Rails code as
+```ruby
+StatsCloud.record_event('statistic', 123)
+```

data/lib/statscloud/helpers/statscloud_client/statscloud_helper.rb

@@ -9,10 +9,11 @@ module StatsCloud
   module StatsCloudHelper
     private
 
-    def initialize_values
+    def initialize_values(environment = nil, client_tags = nil)
       @config = {}
+      @env ||= environment
+      @tags ||= client_tags
       @source_mappings = { metrics: [], admins: [], dashboards: [], alerts: [] }
-      update_config_file("statscloud.yml")
     end
 
     def generate_configuration(base_config)
@@ -90,7 +91,8 @@ module StatsCloud
     end
 
     def config_dir_file(file)
-      File.join("config", file)
+      file_name = file[0] == "." ? file.sub(/^./, "") : file
+      File.join("config", file_name)
     end
 
     def rails_environment

data/lib/statscloud/statscloud_client.rb

@@ -23,8 +23,9 @@ module StatsCloud
     # @return instance of StatsCloud::Client
     #
     # @api public
-    def initialize
-      initialize_values
+    def initialize(environment = nil, client_tags = nil)
+      initialize_values(environment, client_tags)
+      update_config_file(".statscloud.yml")
     end
 
     # Configures statsmeter.io support for application and initializes a statscloud.io client.
@@ -39,6 +40,7 @@ module StatsCloud
     #
     # @api public
     def start(base_config = nil)
+      initialize_values
       process_configuration(base_config)
       configure_statscloud_plugins
       configure_cluster
@@ -55,8 +57,8 @@ module StatsCloud
     # @return instance of StatsCloud::Client
     #
     # @api public
-    def with_environment(env)
-      config_environment(env)
+    def with_environment(environment)
+      config_environment(environment)
       self
     end
 
@@ -135,7 +137,7 @@ module StatsCloud
 
     # Returns cluster status.
     #
-    # @return [Hash]
+    # @return [+Hash+]
     #
     # @api public
     def cluster_status
@@ -148,6 +150,24 @@ module StatsCloud
       log_error error
     end
 
+    # Returns statscloud client environemnt.
+    #
+    # @return [+String+]
+    #
+    # @api public
+    def environment
+      @env
+    end
+
+    # Returns statscloud client tags.
+    #
+    # @return [Array[+String+]]
+    #
+    # @api public
+    def client_tags
+      @tags
+    end
+
     # Stops statscloud.io service.
     #
     # @return nil

data/lib/statscloud/version.rb

@@ -4,5 +4,5 @@ module StatsCloud
   # version of statscloud-ruby-client.
   #
   # Type: *String*
-  VERSION = "1.1.2"
+  VERSION = "1.2.0"
 end

data/lib/statscloud.rb

@@ -1,4 +1,31 @@
 # frozen_string_literal: true
 
+require "forwardable"
+
 require "statscloud/statscloud_client"
 require "statscloud/version"
+
+# StatsCloud.io ruby client
+module StatsCloud
+  class << self
+    include LoggerHelper
+    extend Forwardable
+
+    def_delegators :stats_cloud_instance, :start, :with_environment, :with_tags, :meter, :record_event, :record_events,
+                   :record_events_array, :cluster_status, :stop, :environment, :client_tags
+
+    def clone_with_config_file(file)
+      new_statscloud_instance(environment, client_tags).with_config_file(file)
+    end
+
+    private
+
+    def stats_cloud_instance
+      @stats_cloud_instance ||= new_statscloud_instance
+    end
+
+    def new_statscloud_instance(environment = nil, client_tags = nil)
+      StatsCloud::Client.new(environment, client_tags)
+    end
+  end
+end

data/lib/templates/statscloud/statscloud_template.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 unless defined?(::Rails::Console)
-  ::StatsCloudClient = StatsCloud::Client.new
-  StatsCloudClient.start
-  at_exit { StatsCloudClient.stop }
+  StatsCloud.start
+  at_exit { StatsCloud.stop }
 end

data/statscloud.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "StatsCloud service."
   spec.description   = "PaaS application monitoring system."
   spec.homepage      = "https://statscloud.io"
-  spec.license       = "MIT"
+  spec.license       = "Agilium Labs LLC"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statscloud
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Roman Ovcharov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-17 00:00:00.000000000 Z
+date: 2019-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: crc32
@@ -191,7 +191,7 @@ files:
 - ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -218,7 +218,7 @@ files:
 - statscloud.gemspec
 homepage: https://statscloud.io
 licenses:
-- MIT
+- Agilium Labs LLC
 metadata:
   allowed_push_host: https://rubygems.org
 post_install_message: 

data/LICENSE.txt

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