experimental-influxdb-rails 1.0.0.beta5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a954571f679bcc769801cba122d184de5cec35a9e5a41f148f7a0cef447fcae
+  data.tar.gz: 49d45ca15c6dd1e0e63985e30715c6e0369f97f56cd87cb4cb31b0f4a609f9d9
+SHA512:
+  metadata.gz: 6621fb5502ac68ef2d7e8f303a7abe04172d41ba37edc26f61778b1522ff30624a98fb9f3ff1a20c554fd6705bad5c9cf13461ba19ce9f16882554fdf6ffaec5
+  data.tar.gz: 2bfc11c99880dd8d68f38ad56ad0d61b8f076c4bf6c692a2136caa80f113d5411f70d13d16c656676c4dab2d03d4dcb0a21d65bc8c1fbae7714d517000bb6820

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle
+.rvmrc
+*.gem
+Gemfile.lock
+Gemfile.local
+gemfiles/*.lock
+pkg/*
+spec/support/rails*/log/*
+.ruby-*
+vendor/bundle

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--order rand

data/.rubocop.yml

@@ -0,0 +1,78 @@
+AllCops:
+  Include:
+  - 'Rakefile'
+  - '*.gemspec'
+  - 'lib/**/*.rb'
+  - 'spec/**/*.rb'
+  Exclude:
+  - 'bin/**/*'
+  - 'smoke/**/*'
+  - 'Gemfile'
+  - 'vendor/bundle/**/*'
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.3
+
+Rails:
+  Enabled: false
+
+Layout/EmptyLinesAroundArguments:
+  Enabled: false
+
+Layout/SpaceBeforeBlockBraces:
+  EnforcedStyleForEmptyBraces: space
+
+Layout/AlignHash:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+  - 'spec/**/*.rb'
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+  - 'spec/**/*.rb'
+
+Metrics/ModuleLength:
+  CountComments: false  # count full line comments?
+  Max: 120
+
+Metrics/ParameterLists:
+  Max: 6
+
+Naming/UncommunicativeMethodParamName:
+  AllowedNames: [io, id, db, ex]
+
+Naming/FileName:
+  Exclude:
+  - lib/influxdb-rails.rb
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+  Exclude:
+  - "spec/**/*.rb"
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+  Exclude:
+  - "spec/**/*.rb"

data/.travis.yml

@@ -0,0 +1,37 @@
+sudo: required
+dist: trusty
+language: ruby
+before_install:
+  - gem update --system --no-doc
+  - gem install bundler --no-doc
+  - gem update bundler --no-doc
+rvm:
+  - ruby-head
+  - "2.6"
+  - "2.5"
+  - "2.4"
+  - "2.3"
+gemfile:
+  - gemfiles/Gemfile.rails-5.2.x
+  - gemfiles/Gemfile.rails-5.1.x
+  - gemfiles/Gemfile.rails-5.0.x
+  - gemfiles/Gemfile.rails-4.2.x
+env:
+  - TEST_TASK=spec
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  include:
+    - { rvm: "2.6",   gemfile: "Gemfile", env: [TEST_TASK=rubocop] }
+  exclude:
+    # Rails < 5 not on MRI 2.4+
+    - { rvm: ruby-head, gemfile: "gemfiles/Gemfile.rails-4.2.x" }
+    - { rvm: "2.6",   gemfile: "gemfiles/Gemfile.rails-4.2.x" }
+    - { rvm: "2.5",   gemfile: "gemfiles/Gemfile.rails-4.2.x" }
+    - { rvm: "2.4",   gemfile: "gemfiles/Gemfile.rails-4.2.x" }
+addons:
+  apt:
+    packages:
+      - haveged
+      - libgmp-dev
+script: bundle exec rake $TEST_TASK

data/CHANGELOG.md

@@ -0,0 +1,133 @@
+# Changelog
+
+For the full commit log, [see here](https://github.com/influxdata/influxdb-rails/commits/master).
+
+
+## v1.0.0.beta4, released 2019-01-13
+- Remove empty tags (#64 @ChrisBr)
+- Add default location :raw to SQL subscriber (#64 @ChrisBr)
+- Add dynamic values (#65 @ChrisBr)
+- Add start time value to request subscriber (#65 @ChrisBr)
+
+## v1.0.0.beta3, released 2019-01-07
+
+- Add dynamic tags (#62, @ChrisBr)
+- Reduce cardinality of resulting InfluxDB measurement by moving
+  some tags to values (#63, @ChrisBr)
+- Remove SCHEMA queries from SQL instrumentation (#61, @ChrisBr)
+
+
+## v1.0.0.beta2, released 2018-12-07
+
+- Added `tags_middleware` config option (#47, @Kukunin)
+- Removed path tag from metrics (introduced with #50), because it
+  potentially produces "exceed tag value limit" (#54, @ChrisBr)
+- Added render instrumentation (#53, @ChrisBr)
+- Added SQL instrumentation (#55, @ChrisBr)
+
+## v1.0.0.beta1, released 2018-11-22
+
+- Added app name to the measurement's tag sets (#44, @stefanhorning)
+- Added config parameters for additional series:
+  - `InfluxDB::Rails::Configuration#series_name_for_instrumentation`
+  - `InfluxDB::Rails::Configuration#series_name_for_exceptions`
+- Added method, status and format tags to metrics (#50, @ChrisBr)
+
+### Breaking changes
+
+- Support for Ruby <= 2.2.x has been removed
+- Support for Rails <= 4.1.x has been removed
+- Changed keys for exceptions (#43, @vassilevsky & @kkentzo)
+  - Exception message and backtrace are now InfluxDB values (changed from tags).
+  - The keys changed from `message` to `exception_message` and from
+    `backtrace` to `exception_backtrace`, since a single shard does not
+    allow for tags and values to share the same key
+  - To convert existing exception traces into the new format for
+    consistency, see [this gist][migrate].
+- Removed `time` key from InfluxDB::Rails::ExceptionPresenter#context`
+  - use `InfluxDB::Rails.current_timestamp` directly
+- Removed previously deprecated methods:
+  - `InfluxDB::Rails::Configuration#reraise_global_exceptions`
+  - `InfluxDB::Rails::Configuration#database_name`
+  - `InfluxDB::Rails::Configuration#application_id`
+
+[migrate]: https://gist.github.com/dmke/2d0f4ccf9f43faf82e732dc041e90ca2
+
+## v0.4.3, released 2017-12-12
+
+- Added `time_precision` config option (#42, @kkentzo)
+
+## v0.4.2, released 2017-11-28
+
+- Added `open_timeout`, `read_timeout`, and `max_delay` config options
+  (#41, @emaxi)
+- Deprecate unused method (`#reraise_global_exceptions` in
+  `InfluxDB::Rails::Configuration`, #37, @vassilevsky)
+
+## v0.4.1, released 2017-10-23
+
+- Bump `influx` version dependency (#40, @rockclimber73)
+
+## v0.4.0, released 2017-08-19
+
+- Drop support for Rails 3, Ruby < 2.2
+- Sync version with `influxdb` gem
+
+## v0.1.12, released 2017-06-06
+
+- Added Rails 5.1 compatibility (#31, @djgould).
+- Added `retry` config option (#17, @scambra and #18, @bcantin).
+
+## v0.1.11, released 2016-11-24
+
+- Bumped `influxdb` Rubygem dependency (#28, #32, @agx).
+
+**Note:** The real changelog starts here. Previous entries are reconstructed
+from the commit history by correlating release version with Git tags, which
+may or may not reflect what was really released.
+
+## v0.1.10, released 2014-10-08
+
+- Lazy loading of `InfluxDB::Client` (#15, @chingo13).
+- Various test fixes.
+
+## v0.1.9, released 2014-06-18
+
+- v0.1.8 was yanked
+- Initializer now allows multiple hosts.
+
+## v0.1.7, released 2014-04-09
+
+- Added logger.
+
+## v0.1.6, released 2014-04-08
+
+- No changes (?)
+
+## v0.1.5, released 2014-04-02
+
+- No changes (?)
+
+## v0.1.4, released 2014-03-26
+
+- Added docs
+- Made `async` option default to `true`.
+
+## v0.1.3, released 2014-02-11
+
+- Set series name defaults.
+- Fixed a configuration bug.
+
+## v0.1.2, released 2014-02-11
+
+- Graceful handling of authentication errors.
+- Fixes in documentation.
+
+## v0.1.1, released 2014-02-06
+
+- Refactoring of `ActiveSupport::Notification` handling.
+- Added more initializer options.
+
+## v0.1.0, released 2014-02-06
+
+- Larger refactoring.

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gemspec
+
+local_gemfile = 'Gemfile.local'
+
+if File.exist?(local_gemfile)
+  eval(File.read(local_gemfile)) # rubocop:disable Lint/Eval
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Todd Persen
+
+MIT License
+
+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,292 @@
+> You are looking at the README for the master branch of this gem.
+> The latest released version lives in the stable-04 branch,
+> [see here](https://github.com/influxdata/influxdb-rails/tree/stable-04#readme)
+> for an online version.
+
+# influxdb-rails
+
+[![Gem Version](https://badge.fury.io/rb/influxdb-rails.svg)](https://badge.fury.io/rb/influxdb-rails)
+[![Build Status](https://travis-ci.org/influxdata/influxdb-rails.svg?branch=master)](https://travis-ci.org/influxdata/influxdb-rails)
+
+Automatically instrument your Ruby on Rails applications and write the
+metrics directly into [InfluxDB](http://influxdb.org/).
+
+This gem is designed for Rails 4.2+, Ruby 2.3+ and InfluxDB 0.9+.
+
+
+## Installation
+
+```
+$ [sudo] gem install influxdb-rails
+```
+
+Or add it to your `Gemfile`, etc.
+
+
+## Usage
+
+To get things set up, just create an initializer:
+
+```
+$ cd /to/you/rails/application
+$ touch config/initializers/influxdb_rails.rb
+```
+
+In this file, you can configure the `InfluxDB::Rails` adapter. The default
+config should look something like this:
+
+``` ruby
+InfluxDB::Rails.configure do |config|
+  config.influxdb_database = "rails"
+  config.influxdb_username = "root"
+  config.influxdb_password = "root"
+  config.influxdb_hosts    = ["localhost"]
+  config.influxdb_port     = 8086
+
+  # config.retry = false
+  # config.async = false
+  # config.open_timeout = 5
+  # config.read_timeout = 30
+  # config.max_delay = 300
+  # config.time_precision = 'ms'
+
+  # config.tags_middleware = ->(tags) { tags }
+
+  # config.series_name_for_controller_runtimes = "rails.controller"
+  # config.series_name_for_view_runtimes       = "rails.view"
+  # config.series_name_for_db_runtimes         = "rails.db"
+  # config.series_name_for_render_template     = "rails.render_template"
+  # config.series_name_for_render_partial      = "rails.render_partial"
+  # config.series_name_for_render_collection   = "rails.render_collection"
+  # config.series_name_for_sql                 = nil
+  # config.series_name_for_exceptions          = "rails.exceptions"
+  # config.series_name_for_instrumentation     = "instrumentation"
+
+  # Set the application name to something meaningful, by default we
+  # infer the app name from the Rails.application class name.
+  # config.application_name = Rails.application.class.parent_name
+end
+```
+
+To see all default values, take a look into `InfluxDB::Rails::Configuration::DEFAULTS`,
+defined in `lib/influxdb/rails/configuration.rb`
+
+Out of the box, you'll automatically get reporting of your controller,
+view, and db runtimes and rendering of template, partial and collection for each request.
+Reporting of SQL queries is disabled by default because it is still in experimental mode
+and currently requires String parsing which might cause performance issues on query
+intensive applications. You can enable it by setting the `series_name_for_sql`
+configuration.
+
+It is possible to disable the rendering series by setting the series_name to nil.
+
+```ruby
+  # config.series_name_for_render_template     = nil
+  # config.series_name_for_render_partial      = nil
+  # config.series_name_for_render_collection   = nil
+```
+
+You can also call through to the underlying `InfluxDB::Client` object to write arbitrary data.
+If you do that, it might be usefull to add the current context to these custom data points which can get
+accessed with ``InfluxDB::Rails.current.location``.
+
+
+``` ruby
+InfluxDB::Rails.client.write_point "events",
+  tags:   { url: "/foo", user_id: current_user.id, location: InfluxDB::Rails.current.location },
+  values: { value: 0 }
+```
+
+Additional documentation for `InfluxDB::Client` lives in the
+[influxdb-ruby](http://github.com/influxdata/influxdb-ruby) repo.
+
+
+### Tags
+
+You can modify the tags sent to InfluxDB by defining a middleware, which
+receives the current tag set (`Hash` with `Symbol` keys and `String`
+values) as argument and returns a hash in the same form. The middleware
+can be any object, as long it responds to `#call` (like a `Proc`):
+
+```ruby
+InfluxDB::Rails.configure do |config|
+  config.tags_middleware = lambda do |tags|
+    tags.merge(env: Rails.env)
+  end
+end
+```
+
+If you want to add dynamically tags or fields per request, you can access ``InfluxDB::Rails.current`` to
+do so. For instance, you could add the current user as tag and the request id to every data point.
+
+```ruby
+class ApplicationController
+
+  before_action :set_influx_data
+
+  def set_influx_data
+    InfluxDB::Rails.current.tags = { user: current_user.id }
+    InfluxDB::Rails.current.values = { id: request.request_id }
+  end
+end
+
+```
+
+By default, the following tags are sent for *non-exception series*
+(`rails.controller`, `rails.view`, `rails.db` and `instrumentation`):
+
+```ruby
+{
+  method:      "#{payload[:controller]}##{payload[:action]}",
+  server:      Socket.gethostname,
+  app_name:    configuration.application_name,
+  http_method: payload[:method],
+  format:      payload[:format],
+  status:      payload[:status]
+}
+```
+For the render series (``rails.render_partial``, ``rails.render_view`` and ``rails.render_collection``)
+
+```ruby
+  server:     Socket.gethostname,
+  app_name:   configuration.application_name,
+  location:   "#{payload[:controller]}##{payload[:action]}",
+  filename:   payload[:identifier],
+  count:      payload[:count],
+  cache_hits: payload[:cache_hits],
+```
+
+For the SQL series (``rails.sql``, disabled by default)
+
+```ruby
+  server:     Socket.gethostname,
+  app_name:   configuration.application_name,
+  location:   "#{payload[:controller]}##{payload[:action]}",,
+  operation:  "SELECT",
+  class_name: "USER",
+  name:       payload[:name],
+```
+
+For more information about the payload, have a look at the [official ActiveSupport documentation](https://guides.rubyonrails.org/active_support_instrumentation.html#process-action-action-controller).
+
+
+For the exceptions (series name `rails.exceptions`):
+
+```ruby
+{
+  application_name:   InfluxDB::Rails.configuration.application_name,
+  application_root:   InfluxDB::Rails.configuration.application_root,
+  framework:          InfluxDB::Rails.configuration.framework,
+  framework_version:  InfluxDB::Rails.configuration.framework_version,
+  language:           "Ruby",
+  language_version:   "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}",
+  custom_data:        @custom_data,
+  class:              @exception.class.to_s,
+  method:             "#{@controller}##{@action}",
+  filename:           File.basename(@backtrace.lines.first.try(:file)),
+  server:             Socket.gethostname,
+  status:             "open",
+}
+```
+
+
+## Frequently Asked Questions
+
+
+**Q: I'm seeing far less requests recorded in InfluxDB than my logs suggest.**
+
+By default, this gem only sends data points with *second time precision*
+to the InfluxDB server. If you experience multiple requests per second,
+**only the last** point (with the same tag set) is stored.
+
+See [InfluxDB server docs][duplicate-points] for further details.
+To work around this limitation, set the `config.time_precision` to one
+of `"ms"` (milliseconds, 1·10<sup>-3</sup>s), `"us"` (microseconds,
+1·10<sup>-6</sup>s) or `"ns"` (nanoseconds, 1·10<sup>-9</sup>s).
+
+[duplicate-points]: https://docs.influxdata.com/influxdb/v1.4/troubleshooting/frequently-asked-questions/#how-does-influxdb-handle-duplicate-points
+
+
+**Q: How does the measurement influence the response time?**
+
+This gem subscribes to the `process_action.action_controller` controller
+notification (via `ActiveSupport::Notifications` · [guide][arn-guide] ·
+[docs][arn-docs] · [impl][arn-impl]), i.e. it runs *after* a controller
+action has finished.
+
+The thread processing incoming HTTP requests however is blocked until
+the notification is processed. By default, this means calculating and
+enqueueing some data points for later processing (`config.async = true`),
+which usually is negligible. The asynchronuous sending happens in a seperate
+thread, which batches multiple data points.
+
+If you, however, use a synchronous client (`config.async = false`), the
+data points are immediately sent to the InfluxDB server. Depending on
+the network link, this might cause the HTTP thread to block a lot longer.
+
+[arn-guide]: http://guides.rubyonrails.org/v5.1/active_support_instrumentation.html#process-action-action-controller
+[arn-docs]: http://api.rubyonrails.org/v5.1/classes/ActiveSupport/Notifications.html
+[arn-impl]: https://github.com/rails/rails/blob/5-1-stable/actionpack/lib/action_controller/metal/instrumentation.rb#L30-L38
+
+
+**Q: How does this gem handle an unreachable InfluxDB server?**
+
+By default, the InfluxDB client will retry indefinetly, until a write
+succeedes (see [client docs][] for details). This has two important
+implcations, depending on the value of `config.async`:
+
+- if the client runs asynchronously (i.e. in a seperate thread), the queue
+  might fill up with hundrets of megabytes of data points
+- if the client runs synchronously (i.e. inline in the request/response
+  cycle), it might block all available request threads
+
+In both cases, your application server might become inresponsive and needs
+to be restarted (which can happen automatically in `cgroups` contexts).
+
+If you setup a maximum retry value (`Integer === config.retry`), the
+client will try upto that amount of times to send the data to the server
+and (on final error) log an error and discard the values.
+
+[client docs]: https://github.com/influxdata/influxdb-ruby#retry
+
+
+**Q: What happens with unwritten points, when the application restarts?**
+
+The data points are simply discarded.
+
+
+**Q: What happens, when the InfluxDB client or this gem throws an exception? Will the user see 500 errors?**
+
+No. The controller instrumentation is wrapped in a `rescue StandardError`
+clause, i.e. this gem will only write the error to the `client.logger`
+(`Rails.logger` by default) and not disturb the user experience.
+
+
+## Testing
+
+```
+git clone git@github.com:influxdata/influxdb-rails.git
+cd influxdb-rails
+bundle
+bundle exec rake
+```
+
+
+## Contributing
+
+- Fork this repository on GitHub.
+- Make your changes.
+  - Add tests.
+  - Add an entry in the `CHANGELOG.md` in the "unreleased" section on top.
+- Run the tests:
+  - Either run them manually:
+    ```console
+    $ rake test:all
+    ```
+  - or wait for [Travis][travis-pr] to pick up your changes, *after*
+    you made a pull request.
+- Send a pull request.
+  - Please rebase against the master branch.
+- If your changes look good, we'll merge them.
+
+[travis-pr]: https://travis-ci.org/influxdata/influxdb-rails/pull_requests