Skip to content

Commit 38d59b5

Browse files
authored
Merge pull request #167 from hennevogel/release/1.0.1
Release 1.0.1
2 parents de73969 + d1d1e6a commit 38d59b5

File tree

3 files changed

+23
-24
lines changed

3 files changed

+23
-24
lines changed

CHANGELOG.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,23 @@
22

33
For the full commit log, [see here](https://github.com/influxdata/influxdb-rails/commits/master).
44

5-
## v1.0.1.beta3, release 2020-10-16
5+
## v1.0.1, released 2021-03-23
6+
7+
The final release, no code changes.
8+
9+
## v1.0.1.beta3, released 2020-10-16
10+
611
- Drop `perform_start.active_job` subscriber, it's rather useless on dashboards.
712

813
## v1.0.1.beta2, released 2020-09-14
14+
915
- Implement [`deliver.action_mailer`](https://guides.rubyonrails.org/active_support_instrumentation.html#deliver-action-mailer) subscriber
1016
- Add missing Active Job documentation
1117
- Drop support for Ruby 2.4
1218
- Drop support for Rails < 5.2
1319

1420
## v1.0.1.beta1, released 2020-08-21
21+
1522
- Drop support for Ruby 2.3
1623
- Drop support for Rails 4.x
1724
- 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
2633
- Record unhandled exceptions as tags for process_action.action_controller
2734

2835
## v1.0.0, released 2019-10-23
36+
2937
The Final release, no code changes.
3038

3139
## v1.0.0.beta5, unreleased
40+
3241
- Silently eat all dropped configuration options and do not crash
3342
- Add per action view to the sample dashboard
3443

README.md

Lines changed: 12 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
> :warning: You are looking at the README for the master branch of this gem.
2-
> See the latest [released version (1.0.0)](https://github.com/influxdata/influxdb-rails/tree/v1.0.0#readme)
2+
> See the latest [released version (1.0.1)](https://github.com/influxdata/influxdb-rails/tree/v1.0.1#readme)
33
> instead.
44
55
# influxdb-rails
66

77
[![Gem Version](https://badge.fury.io/rb/influxdb-rails.svg)](https://badge.fury.io/rb/influxdb-rails)
8-
[![Build Status](https://travis-ci.org/influxdata/influxdb-rails.svg?branch=master)](https://travis-ci.org/influxdata/influxdb-rails)
8+
[![Build Status](https://github.com/influxdata/influxdb-rails/actions/workflows/spec.yml/badge.svg)](https://github.com/influxdata/influxdb-rails/actions)
99

10-
Automatically instrument your Ruby on Rails applications and write the
11-
metrics directly into [InfluxDB](http://influxdb.org/).
12-
13-
This gem is designed for Rails 4.2+, Ruby 2.3+ and InfluxDB 0.9+.
10+
Automatically instrument your Ruby on Rails applications and write the metrics directly into
11+
[InfluxDB](https://www.influxdata.com/).
1412

1513
## Table of contents
1614

@@ -41,8 +39,8 @@ configuration of this gem.
4139

4240
## Usage
4341

44-
Out of the box, you'll automatically get reporting for sql, model, view and
45-
controller Rails instrumentation for every request.
42+
Out of the box, you'll automatically get reporting for the Ruby on Rails components mentioned
43+
below.
4644

4745
### Action Controller
4846

@@ -76,10 +74,7 @@ Reported tags:
7674
}
7775
```
7876

79-
*Note*: If an exception happens during that particular instrumentation the
80-
`status` will be blank and the tag `exception` will contain the name of the
81-
exception class. The status is blank because we can't know how you handle it
82-
outside the action.
77+
*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.
8378

8479
### Action View
8580

@@ -209,9 +204,7 @@ InfluxDB::Rails.configure do |config|
209204
end
210205
```
211206

212-
You'll find *most* of the configuration settings in the initializer file. The
213-
canonical list of default values is located in `lib/influxdb/rails/configuration.rb`
214-
(`InfluxDB::Rails::Configuration::DEFAULTS`).
207+
You'll find all of the configuration settings in the initializer file.
215208

216209
### Custom Tags
217210

@@ -268,7 +261,7 @@ Reported tags:
268261

269262
Reported values:
270263
```ruby
271-
value: 100 # execution time of the block
264+
value: 100 # execution time of the block in ms
272265
```
273266

274267
You can also overwrite the `value`
@@ -351,7 +344,7 @@ might cause performance issues on traffic intensive applications. Disable it in
351344
the configuration if you are not willing to tolerate this.
352345

353346
By default, this gem performs writes to InfluxDB asynchronously. A single
354-
hooks usually only performs some time delta calculations, and then enqueues
347+
hook usually only performs some time delta calculations, and then enqueues
355348
the data point into a worker queue (which is processed by a background
356349
thread).
357350

@@ -375,8 +368,7 @@ implications, depending on the value of `config.client.async`:
375368
cycle), it might block all available request threads
376369

377370
In both cases, your application server might become unresponsive and needs
378-
to be restarted (which can happen automatically in `cgroups` contexts,
379-
like Docker containers).
371+
to be restarted.
380372

381373
If you setup a maximum retry value (`Integer === config.client.retry`),
382374
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.
407399
rake test:all
408400
```
409401

410-
- or wait for [Travis][travis-pr] to pick up your changes, *after*
402+
- or wait for [our CI](https://github.com/influxdata/influxdb-rails/actions) to pick up your changes, *after*
411403
you made a pull request.
412404
- Send a pull request.
413405
- If your changes are looking good, we'll merge them.
414406

415-
[travis-pr]: https://travis-ci.org/influxdata/influxdb-rails/pull_requests
416-
417407
### Testing Tasks
418408

419409
```console

lib/influxdb/rails/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
module InfluxDB
22
module Rails
3-
VERSION = "1.0.1.beta3".freeze
3+
VERSION = "1.0.1".freeze
44
end
55
end

0 commit comments

Comments
 (0)