You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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/).
14
12
15
13
## Table of contents
16
14
@@ -41,8 +39,8 @@ configuration of this gem.
41
39
42
40
## Usage
43
41
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.
46
44
47
45
### Action Controller
48
46
@@ -76,10 +74,7 @@ Reported tags:
76
74
}
77
75
```
78
76
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.
83
78
84
79
### Action View
85
80
@@ -209,9 +204,7 @@ InfluxDB::Rails.configure do |config|
209
204
end
210
205
```
211
206
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.
215
208
216
209
### Custom Tags
217
210
@@ -268,7 +261,7 @@ Reported tags:
268
261
269
262
Reported values:
270
263
```ruby
271
-
value:100# execution time of the block
264
+
value:100# execution time of the block in ms
272
265
```
273
266
274
267
You can also overwrite the `value`
@@ -351,7 +344,7 @@ might cause performance issues on traffic intensive applications. Disable it in
351
344
the configuration if you are not willing to tolerate this.
352
345
353
346
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
355
348
the data point into a worker queue (which is processed by a background
356
349
thread).
357
350
@@ -375,8 +368,7 @@ implications, depending on the value of `config.client.async`:
375
368
cycle), it might block all available request threads
376
369
377
370
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.
380
372
381
373
If you setup a maximum retry value (`Integer === config.client.retry`),
382
374
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.
407
399
rake test:all
408
400
```
409
401
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*
411
403
you made a pull request.
412
404
- Send a pull request.
413
405
- If your changes are looking good, we'll merge them.
0 commit comments