rails_health_checks 1.0.0 → 1.0.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 +12 -1
- data/lib/rails_health_checks/version.rb +1 -1
- metadata +8 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d1ee34c7b5d51ecbfbd7f1f8571daad21f2aea68d68b6ae3abb2013692e4d25b
|
|
4
|
+
data.tar.gz: 067bba6faa5b8276e1d7e190e5ddeaac050cbf218d8093b00ef865492c640560
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7b224e9749a4cecbe92353f278f6d162ee8cca979301754d887f97d76bb004b4ef8305a2cc93aa2ecb7aff21cb7f3bf1e4381daa1ca8f17a32841c19019f14de
|
|
7
|
+
data.tar.gz: 5c514cdf7dff0471562ad1b4fc549348ea49b2ee1b816fdb730962e9eb3688b94a4750185f06d7cf16102ce00eea326a58be599edcea05b34c6998e511ce0fca
|
data/README.md
CHANGED
|
@@ -6,7 +6,18 @@
|
|
|
6
6
|
[](https://www.ruby-lang.org)
|
|
7
7
|
[](https://codecov.io/gh/eclectic-coding/rails_health_checks)
|
|
8
8
|
|
|
9
|
-
A Rails engine
|
|
9
|
+
A Rails engine that adds production-grade health check endpoints to any Rails app. Goes well beyond the built-in `/up` endpoint with 11 built-in checks, parallel execution, structured JSON responses, Prometheus metrics, and a clean configuration DSL.
|
|
10
|
+
|
|
11
|
+
**Built-in checks:** database · cache · Redis · SMTP · Sidekiq · SolidQueue · GoodJob · Resque · disk · memory · HTTP
|
|
12
|
+
|
|
13
|
+
**Key features:**
|
|
14
|
+
- Parallel check execution via `Concurrent::Future` — response time bounded by the slowest check, not the sum
|
|
15
|
+
- Result caching (`config.cache_duration`) to absorb high-frequency probe traffic
|
|
16
|
+
- Prometheus text exposition at `GET /health/metrics` (always HTTP 200)
|
|
17
|
+
- Check groups (`config.group`) expose subsets at `/health/:group`
|
|
18
|
+
- Per-environment toggling, boot-time validation, and bearer token / IP / custom auth
|
|
19
|
+
- `rails generate rails_health_checks:initializer` scaffolds a fully-commented config file
|
|
20
|
+
- Drop-in replacement for OkComputer — see [MIGRATING_FROM_OKCOMPUTER.md](MIGRATING_FROM_OKCOMPUTER.md)
|
|
10
21
|
|
|
11
22
|
## Table of Contents
|
|
12
23
|
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: rails_health_checks
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.
|
|
4
|
+
version: 1.0.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Chuck Smith
|
|
@@ -23,8 +23,12 @@ dependencies:
|
|
|
23
23
|
- - ">="
|
|
24
24
|
- !ruby/object:Gem::Version
|
|
25
25
|
version: '8.0'
|
|
26
|
-
description: A Rails engine
|
|
27
|
-
|
|
26
|
+
description: A Rails engine that adds structured, pluggable health check endpoints
|
|
27
|
+
to any Rails app. Includes 11 built-in checks (database, cache, Redis, SMTP, Sidekiq,
|
|
28
|
+
SolidQueue, GoodJob, Resque, disk, memory, HTTP), parallel execution via Concurrent::Future,
|
|
29
|
+
result caching, Prometheus metrics, check groups, per-environment toggling, boot-time
|
|
30
|
+
validation, and a Prometheus-compatible /metrics endpoint. Drop-in replacement for
|
|
31
|
+
OkComputer.
|
|
28
32
|
email:
|
|
29
33
|
- chuck@eclecticcoding.com
|
|
30
34
|
executables: []
|
|
@@ -91,5 +95,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
91
95
|
requirements: []
|
|
92
96
|
rubygems_version: 3.6.9
|
|
93
97
|
specification_version: 4
|
|
94
|
-
summary:
|
|
98
|
+
summary: Production-grade health check endpoints for Rails applications.
|
|
95
99
|
test_files: []
|