active_endpoint 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 346454b7c0b01487e60199e3f011c93240993054
+  data.tar.gz: f8ab721004f110a1f18ab81b5f408f1d418ccaea
+SHA512:
+  metadata.gz: ddcd450fa6e5ad910972196c914a8534012c785f7752647f3297826442ec139780b68b5cd8a84568f38cddf6ed65579d21c60ec3d0a30b78f17528b9105c1cde
+  data.tar.gz: c4274afb609b577a43754be3d21cbaf111badea6fecbf2059ef90a7ed37f5fb037b6fefbfb0758d6e33ed79acbfe956b9d7ccff2a0856e414a75c4cbedaa36d2

data/.gitignore

@@ -0,0 +1,55 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# other
+/.rspec_status
+/.byebug_history
+/dump.rdb

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,60 @@
+Documentation:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/AbcSize:
+  Max: 30
+
+Lint/DefEndAlignment:
+  # The value `def` means that `end` should be aligned with the def keyword.
+  # The value `start_of_line` means that `end` should be aligned with method
+  # calls like `private`, `public`, etc, if present in front of the `def`
+  # keyword on the same line.
+  EnforcedStyleAlignWith: start_of_line
+  SupportedStylesAlignWith:
+    - start_of_line
+    - def
+  AutoCorrect: true
+
+# Align ends correctly.
+Lint/EndAlignment:
+  # The value `keyword` means that `end` should be aligned with the matching
+  # keyword (`if`, `while`, etc.).
+  # The value `variable` means that in assignments, `end` should be aligned
+  # with the start of the variable on the left hand side of `=`. In all other
+  # situations, `end` should still be aligned with the keyword.
+  # The value `start_of_line` means that `end` should be aligned with the start
+  # of the line which the matching keyword appears on.
+  EnforcedStyleAlignWith: keyword
+  SupportedStylesAlignWith:
+    - keyword
+    - variable
+    - start_of_line
+  AutoCorrect: true
+
+Rails/UniqBeforePluck:
+  EnforcedStyle: conservative
+  SupportedStyles:
+    - conservative
+    - aggressive
+  AutoCorrect: true
+
+
+# Checks whether the source file has a utf-8 encoding comment or not
+# AutoCorrectEncodingComment must match the regex
+# /#.*coding\s?[:=]\s?(?:UTF|utf)-8/
+Style/Encoding:
+  EnforcedStyle: when_needed
+  SupportedStyles:
+    - when_needed
+    - always
+    - never
+  AutoCorrectEncodingComment: '# encoding: utf-8'

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at marat@khusnetdinov.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,25 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in active_endpoint.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+gem 'activesupport', '~> 4.1.11'
+gem 'rack', '~> 1.0'
+gem 'redis-activesupport'
+
+gem 'sass-rails'
+
+group :development do
+  gem 'bundler', '~> 1.14'
+  gem 'rake', '~> 10.0'
+  gem 'reek'
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop'
+end

data/Gemfile.lock

@@ -0,0 +1,140 @@
+PATH
+  remote: .
+  specs:
+    active_endpoint (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.1.16)
+      actionview (= 4.1.16)
+      activesupport (= 4.1.16)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.16)
+      activesupport (= 4.1.16)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activesupport (4.1.16)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    ast (2.3.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.3)
+    codeclimate-engine-rb (0.4.0)
+      virtus (~> 1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.0.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    equalizer (0.0.11)
+    erubis (2.7.0)
+    ffi (1.9.18)
+    i18n (0.8.6)
+    ice_nine (0.11.2)
+    json (1.8.6)
+    minitest (5.10.3)
+    parallel (1.12.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (1.5.5)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    railties (4.1.16)
+      actionpack (= 4.1.16)
+      activesupport (= 4.1.16)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    redis (3.3.3)
+    redis-activesupport (5.0.3)
+      activesupport (>= 3, < 6)
+      redis-store (~> 1.3.0)
+    redis-store (1.3.0)
+      redis (>= 2.2)
+    reek (4.7.2)
+      codeclimate-engine-rb (~> 0.4.0)
+      parser (>= 2.4.0.0, < 2.5)
+      rainbow (~> 2.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    sass (3.5.1)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    sass-rails (5.0.6)
+      railties (>= 4.0.0, < 6)
+      sass (~> 3.1)
+      sprockets (>= 2.8, < 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+      tilt (>= 1.1, < 3)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tilt (2.0.8)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_endpoint!
+  activesupport (~> 4.1.11)
+  bundler (~> 1.14)
+  rack (~> 1.0)
+  rake (~> 10.0)
+  redis-activesupport
+  reek
+  rspec (~> 3.0)
+  rubocop
+  sass-rails
+
+BUNDLED WITH
+   1.14.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Marat Khusnetdinov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,233 @@
+# ActiveEndpoint [![Build Status](https://travis-ci.org/khusnetdinov/active_endpoint.svg?branch=master)](https://travis-ci.org/khusnetdinov/active_endpoint) [![Gem Version](https://badge.fury.io/rb/active_endpoint.svg)](https://badge.fury.io/rb/active_endpoint)
+
+## Your request tracking tool for rails applications
+
+## Attention! Gem in under active test and is preparing for first release !
+
+![img](http://res.cloudinary.com/dtoqqxqjv/image/upload/c_scale,w_346/v1501331806/github/active_probe.jpg)
+
+
+## Usage
+
+ActiveEndpoint is middleware for Rails applications that collects and analyses requests and responses per request for endpoint. It works with minimal impact on application's response time.
+
+This gem uses `ActiveSupport::Notifications` and `Cache Storage` to reduce possible impact on application request / response processing time.
+
+## Features
+
+ - Metrics are stored in database for further tracking and analysis.
+ - History rotation with configurable limits of records amount and age.
+ - Routes filter (blacklist).
+ - Probes tagging by processing time.
+
+## Metrics
+
+These endpoint metrics are stored in DB:
+
+   - `:uuid` - uniq probe identifier
+   - `:endpoint` - requested endpoint
+   - `:path` - requested full path
+   - `:query_string` - request query string
+   - `:request_method` - http request method
+   - `:ip` - ip address asked request
+   - `:url` - request full url
+   - `:xhr` - is request ajax?
+   - `:started_at` - probe start time
+   - `:finished_at` - probe finish time
+   - `:duration` - probe request duration
+   - `:params` - parsed requested params
+   - `:response` - Base64 encoded html response
+   - `:body` - Base64 encoded request body
+
+Additional information is taken from Rack log:
+
+`:base_url, :content_charset, :content_length, :content_type, :fullpath, :http_version, :http_connection, :http_accept_encoding, :http_accept_language, :media_type, :media_type_params, :method, :path_info, :pattern, :port, :protocol, :server_name, :ssl`.
+
+Requests which are not recognized by rails router are stored as `unregistred`.
+
+## Requirements
+
+ - `redis` as cache storage
+
+Be sure that you have all requrements installed on you machine.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_endpoint'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_endpoint
+
+Setup project for using gem:
+
+    $ rails generate active_endpoint:install
+
+Migrate database for models:
+
+    $ rake db:migrate  # Rails <=4
+    $ rails db:migrate # Rails >=5
+
+Now project has all files and settings that allow you to use gem.
+
+## Configuration
+
+### Endpoints filter (blacklist)
+
+By default ActiveEndpoint treats all routes as `whitelist` routes. To filter some endpoints you can use `blackilist` configuration, as shown below:
+
+```ruby
+ActiveEndpoint.configure do |endpoint|
+  endpoint.blacklist.configure  do |blacklist|
+    # Ignore endpoint "welcome#index"
+    blacklist.add(endpoint: "welcome#index")
+
+    # Ignore "web/users" controller actions
+    blacklist.add(resources: ["web/users"])
+
+    # Ignore "web/users#show" action with scoped controller
+    blacklist.add(scope: "web", resources: "users", actions: ["show"])
+
+    # Ignore "admin" scope controllers
+    blacklist.add(scope: "admin")
+  end
+end
+```
+
+#### Ignore one endpoint
+
+`blacklist.add(endpoint: "users#index")` - Ignore one endpoint.
+
+#### Ignore controller actions
+
+`blacklist.add(resources: "users")` - Ignore all actions for `UsersController`.
+
+`blacklist.add(resources: ["users", "managers"])` - Ignore all actions in `UsersController` and `ManagersController`.
+
+`blacklist.add(resources: "users", actions: ["show"])` - Ignore only `show` action in `UsersController`.
+
+#### Ignore namespace or scope
+
+`blacklist.add(scope: "admin")` - Ignore all controllers and actions for `admin` namespace or scope.
+
+### Constraints
+
+You can specify the amount and period of request records to keep in database. Records which exceed these limits are automatically removed from database.
+See example below:
+
+ ```ruby
+ActiveEndpoint.configure do |endpoint|
+  # Defines default settings, 1 probe per 10 minutes for endpoint request
+  constraint_limit = 1
+  constraint_period = 10.minutes
+
+  endpoint.constraints.configure  do |constraints|
+    # Constraint endpoint "welcome#index" with 1 minute period and default limit
+    # and configure database constraints to keep 1000 probes per 1 week.
+    constraints.add(endpoint: "welcome#index",
+      rule: { 1.minute },
+      storage: { limit: 1000, period: 1.week })
+    # Constraints "web/users" controller actions with custom limit and period
+    # with defailt storage constraints
+    constraints.add(resources: ["web/users"], rule: { limit: 100, period: 5.minutes })
+  end
+end
+```
+NOTE: To define a constraint you should define at least one limit or period.
+
+### Storage settings
+
+ActiveEndpoint creates two models in you rails application: `Probe` and it's child `UnregistredProbe`.
+To prevent problems with database probes are removed when user defines custom period. Also you can limit storage probes in database.
+It is recommended to define own storage default to prevent unwanted probes deletion. See example below:
+
+```ruby
+ActiveEndpoint.configure do |endpoint|
+  # Define default limit for maximum probes amount
+  endpoint.storage_limit = 1000
+
+  # Define default period to keep probes in database.
+  endpoint.storage_period = 1.week
+
+  # Define amount of periods (constraint periods) that endpoints are kept in database.
+  endpoint.storage_keep_periods = 2
+end
+```
+
+### Tagging probes
+You can group probes by tags automatically assigned according to request processing time (ms). See example below:
+
+```ruby
+ActiveEndpoint.configure do |endpoint|
+  endpoint.tags.configure do |tags|
+    tags.add(:fast, { less_than: 250 })
+    tags.add(:normal, { greater_than_or_equal_to: 250, less_than: 500 })
+    tags.add(:slow, { greater_than_or_equal_to: 500, less_than: 750 })
+    tags.add(:acceptable, { greater_than_or_equal_to: 500, less_than: 1000 })
+    tags.add(:need_optimization, { greater_than_or_equal_to: 1000 })
+  end
+end
+```
+
+#### Mehods for conditions
+
+   - greater_than = '>'
+   - greater_than_or_equal_to = '>=',
+   - equal_to = '=',
+   - less_than = '<',
+   - less_than_or_equal_to = '<=',
+
+#### Tagged model scopes
+
+Defined tags are also usefull for scopes queries:
+
+```ruby
+ActiveEndpoint::Probe.tagged_as(:need_optimization)
+#=> Returns all probes having corresponding tag and thus matching the condition
+#   { greater_than_or_equal_to: 1000 }
+```
+
+#### Instance methods
+
+Check tag on model:
+
+```ruby
+ActiveEndpoint::Probe.last.tag
+#=> Returns probe's tag
+```
+### Logging
+
+Logger settings:
+
+```ruby
+ActiveEndpoint.configure do |endpoint|
+  # Logger
+  define_setting :logger, ActiveEndpoint::Logger
+  # Set to true if you want to log probe's additional information
+  define_setting :log_probe_info, false
+  # Set to true for debugging, recomended for development
+  define_setting :log_debug_info, false
+end
+```
+
+### Web UI
+
+ActiveEndpoint offer rails engine for managing probes. Mount it:
+
+```ruby
+  mount ActiveEndpoint::Engine => '/active_endpoint'
+```
+
+![img](http://res.cloudinary.com/dtoqqxqjv/image/upload/v1502260319/github/%D0%A1%D0%BD%D0%B8%D0%BC%D0%BE%D0%BA_%D1%8D%D0%BA%D1%80%D0%B0%D0%BD%D0%B0_2017-08-09_%D0%B2_9.06.08_mmwh5d.png)
+
+## License
+
+This gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).