From d1d1e6a4348bc5ae3c310af4a506290116685d22 Mon Sep 17 00:00:00 2001 From: Henne Vogelsang Date: Tue, 23 Mar 2021 12:50:01 +0100 Subject: [PATCH] Release 1.0.1 This took a while but it's awesome, don't you think? :smile: --- CHANGELOG.md | 11 ++++++++++- README.md | 34 ++++++++++++---------------------- lib/influxdb/rails/version.rb | 2 +- 3 files changed, 23 insertions(+), 24 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3e9658a..3be365c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,16 +2,23 @@ For the full commit log, [see here](https://github.com/influxdata/influxdb-rails/commits/master). -## v1.0.1.beta3, release 2020-10-16 +## v1.0.1, released 2021-03-23 + +The final release, no code changes. + +## v1.0.1.beta3, released 2020-10-16 + - Drop `perform_start.active_job` subscriber, it's rather useless on dashboards. ## v1.0.1.beta2, released 2020-09-14 + - Implement [`deliver.action_mailer`](https://guides.rubyonrails.org/active_support_instrumentation.html#deliver-action-mailer) subscriber - Add missing Active Job documentation - Drop support for Ruby 2.4 - Drop support for Rails < 5.2 ## v1.0.1.beta1, released 2020-08-21 + - Drop support for Ruby 2.3 - Drop support for Rails 4.x - Add `auth_method` to client configuration (#96, @anlek) @@ -26,9 +33,11 @@ For the full commit log, [see here](https://github.com/influxdata/influxdb-rails - Record unhandled exceptions as tags for process_action.action_controller ## v1.0.0, released 2019-10-23 + The Final release, no code changes. ## v1.0.0.beta5, unreleased + - Silently eat all dropped configuration options and do not crash - Add per action view to the sample dashboard diff --git a/README.md b/README.md index 2273853..f1d9052 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,14 @@ > :warning: You are looking at the README for the master branch of this gem. -> See the latest [released version (1.0.0)](https://github.com/influxdata/influxdb-rails/tree/v1.0.0#readme) +> See the latest [released version (1.0.1)](https://github.com/influxdata/influxdb-rails/tree/v1.0.1#readme) > instead. # 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) +[![Build Status](https://github.com/influxdata/influxdb-rails/actions/workflows/spec.yml/badge.svg)](https://github.com/influxdata/influxdb-rails/actions) -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+. +Automatically instrument your Ruby on Rails applications and write the metrics directly into +[InfluxDB](https://www.influxdata.com/). ## Table of contents @@ -41,8 +39,8 @@ configuration of this gem. ## Usage -Out of the box, you'll automatically get reporting for sql, model, view and -controller Rails instrumentation for every request. +Out of the box, you'll automatically get reporting for the Ruby on Rails components mentioned +below. ### Action Controller @@ -76,10 +74,7 @@ Reported tags: } ``` -*Note*: If an exception happens during that particular instrumentation the -`status` will be blank and the tag `exception` will contain the name of the -exception class. The status is blank because we can't know how you handle it -outside the action. +*Note*: If an exception happens during that particular action the `status` will be blank and the tag `exception` will contain the name of the exception class. The status is blank because we can't know how you handle the exception outside the action. ### Action View @@ -209,9 +204,7 @@ InfluxDB::Rails.configure do |config| end ``` -You'll find *most* of the configuration settings in the initializer file. The -canonical list of default values is located in `lib/influxdb/rails/configuration.rb` -(`InfluxDB::Rails::Configuration::DEFAULTS`). +You'll find all of the configuration settings in the initializer file. ### Custom Tags @@ -268,7 +261,7 @@ Reported tags: Reported values: ```ruby - value: 100 # execution time of the block + value: 100 # execution time of the block in ms ``` You can also overwrite the `value` @@ -351,7 +344,7 @@ might cause performance issues on traffic intensive applications. Disable it in the configuration if you are not willing to tolerate this. By default, this gem performs writes to InfluxDB asynchronously. A single -hooks usually only performs some time delta calculations, and then enqueues +hook usually only performs some time delta calculations, and then enqueues the data point into a worker queue (which is processed by a background thread). @@ -375,8 +368,7 @@ implications, depending on the value of `config.client.async`: cycle), it might block all available request threads In both cases, your application server might become unresponsive and needs -to be restarted (which can happen automatically in `cgroups` contexts, -like Docker containers). +to be restarted. If you setup a maximum retry value (`Integer === config.client.retry`), the client will try up to that amount of times to send the data to the server @@ -407,13 +399,11 @@ The data points are simply discarded. rake test:all ``` - - or wait for [Travis][travis-pr] to pick up your changes, *after* + - or wait for [our CI](https://github.com/influxdata/influxdb-rails/actions) to pick up your changes, *after* you made a pull request. - Send a pull request. - If your changes are looking good, we'll merge them. -[travis-pr]: https://travis-ci.org/influxdata/influxdb-rails/pull_requests - ### Testing Tasks ```console diff --git a/lib/influxdb/rails/version.rb b/lib/influxdb/rails/version.rb index 04c521c..9de925b 100644 --- a/lib/influxdb/rails/version.rb +++ b/lib/influxdb/rails/version.rb @@ -1,5 +1,5 @@ module InfluxDB module Rails - VERSION = "1.0.1.beta3".freeze + VERSION = "1.0.1".freeze end end