health-monitor-rails 7.1.0 → 7.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +10 -10
- data/app/controllers/health_monitor/health_controller.rb +2 -0
- data/lib/health_monitor/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: cb156b2729dc3b9485d53a68c7abb9f6ae8e690a
|
4
|
+
data.tar.gz: 27f6d1f555bcfef985a0196a29ebeb3e30c7b482
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cb09d045670e2ad1bb6cd42ac915291347a717bf47f858b64dd02d7494371af55e7e55ec0abd01e8b291a5b5b6af3fc913ea8ee97980aed73b66d61e1fd415de
|
7
|
+
data.tar.gz: 8283fb8dfbfd8e3aa2e388deb2c48490a1588d322f063a196c783ea5daffb08d33061b9d2095dd641ee3362d79636af030b5f04251f2f34cbcd6f044f49c0605
|
data/README.md
CHANGED
@@ -15,7 +15,7 @@ Mounting this gem will add a '/check' route to your application, which can be us
|
|
15
15
|
|
16
16
|

|
17
17
|
|
18
|
-
### JSON
|
18
|
+
### JSON Response
|
19
19
|
|
20
20
|
```bash
|
21
21
|
>> curl -s http://localhost:3000/check.json | json_pp
|
@@ -50,7 +50,7 @@ Mounting this gem will add a '/check' route to your application, which can be us
|
|
50
50
|
}
|
51
51
|
```
|
52
52
|
|
53
|
-
### XML
|
53
|
+
### XML Response
|
54
54
|
|
55
55
|
```bash
|
56
56
|
>> curl -s http://localhost:3000/check.xml
|
@@ -113,7 +113,7 @@ You can mount this inside your app routes by adding this to config/routes.rb:
|
|
113
113
|
mount HealthMonitor::Engine, at: '/'
|
114
114
|
```
|
115
115
|
|
116
|
-
## Supported
|
116
|
+
## Supported Service Providers
|
117
117
|
The following services are currently supported:
|
118
118
|
* DB
|
119
119
|
* Cache
|
@@ -123,7 +123,7 @@ The following services are currently supported:
|
|
123
123
|
|
124
124
|
## Configuration
|
125
125
|
|
126
|
-
### Adding
|
126
|
+
### Adding Providers
|
127
127
|
By default, only the database check is enabled. You can add more service providers by explicitly enabling them via an initializer:
|
128
128
|
|
129
129
|
```ruby
|
@@ -143,7 +143,7 @@ HealthMonitor.configure do |config|
|
|
143
143
|
end
|
144
144
|
```
|
145
145
|
|
146
|
-
###
|
146
|
+
### Provider Configuration
|
147
147
|
|
148
148
|
Some of the providers can also accept additional configuration:
|
149
149
|
|
@@ -174,7 +174,7 @@ The currently supported settings are:
|
|
174
174
|
* `url`: the url used to connect to your Redis instance - note, this is an optional configuration and will use the default connection if not specified
|
175
175
|
|
176
176
|
|
177
|
-
### Adding a
|
177
|
+
### Adding a Custom Provider
|
178
178
|
It's also possible to add custom health check providers suited for your needs (of course, it's highly appreciated and encouraged if you'd contribute useful providers to the project).
|
179
179
|
|
180
180
|
In order to add a custom provider, you'd need to:
|
@@ -196,7 +196,7 @@ HealthMonitor.configure do |config|
|
|
196
196
|
end
|
197
197
|
```
|
198
198
|
|
199
|
-
### Adding a
|
199
|
+
### Adding a Custom Error Callback
|
200
200
|
If you need to perform any additional error handling (for example, for additional error reporting), you can configure a custom error callback:
|
201
201
|
|
202
202
|
```ruby
|
@@ -209,7 +209,7 @@ HealthMonitor.configure do |config|
|
|
209
209
|
end
|
210
210
|
```
|
211
211
|
|
212
|
-
### Adding
|
212
|
+
### Adding Authentication Credentials
|
213
213
|
By default, the `/check` endpoint is not authenticated and is available to any user. You can authenticate using HTTP Basic Auth by providing authentication credentials:
|
214
214
|
|
215
215
|
```ruby
|
@@ -221,7 +221,7 @@ HealthMonitor.configure do |config|
|
|
221
221
|
end
|
222
222
|
```
|
223
223
|
|
224
|
-
### Adding
|
224
|
+
### Adding Environment Variables
|
225
225
|
By default, environment variables is `nil`, so if you'd want to include additional parameters in the results JSON, all you need is to provide a `Hash` with your custom environment variables:
|
226
226
|
|
227
227
|
```ruby
|
@@ -233,7 +233,7 @@ HealthMonitor.configure do |config|
|
|
233
233
|
end
|
234
234
|
```
|
235
235
|
|
236
|
-
### Monitoring
|
236
|
+
### Monitoring Script
|
237
237
|
|
238
238
|
A Nagios/Shinken/Icinga/Icinga2 plugin is available in `extra` directory.
|
239
239
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: health-monitor-rails
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 7.1.
|
4
|
+
version: 7.1.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Leonid Beder
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2017-
|
11
|
+
date: 2017-04-25 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rails
|