elasticgraph-health_check 1.0.0.rc3 → 1.0.0.rc4

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.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +38 -11
  3. metadata +22 -23
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6469fba8a54630d5234cef20ef2a03d5b2d492adf91fa96131ec84c356dbe81f
4
- data.tar.gz: 956d60b20b60eb61ea64be07e6d7308eee1e4ebf2a69d8374603d40a1cf19468
3
+ metadata.gz: c82c38dddb94e50e23d69cf1ba9d3c2b91e47112a1cf729c5ebef5457340cdea
4
+ data.tar.gz: 1934b9028367317aabd8303116a1ef58f94b7cfc198e6cfc9fc2748800110578
5
5
  SHA512:
6
- metadata.gz: fa297c8db9a744cc1cda617f04a03f179873ec021d732fe3d83d216425fb434d9b2f0f2dd1a8a3b4b7c1a3fadbc12da4224c94b800bd0e7664edbdffeb940335
7
- data.tar.gz: 23882ae7576fa84760bcd17786826271c4d509054d2c2e4e3cc2c432b81c02952e7f143ef032a779d85bdf5f3f44a98070a2d7d9cd3858a33598d7e281d12441
6
+ metadata.gz: d7b9e855e27199cc489746388824e01b24ec4af29e0ac0a60cbcfff43be202864d0b577fbaf506a995e00325b9a905e0bca65fb971c9d0b7d2f7f34e8718d2e9
7
+ data.tar.gz: ebdcbc1e9a92d0460373940a2db2948b945c65b33a03fb585b26a366eb938d853bccdaf3c1858f7493f5faf85d569a0e1ca84b84890c942116cfe4d28aec4904
data/README.md CHANGED
@@ -11,7 +11,7 @@ down/should not be used under any circumstances".
11
11
 
12
12
  The returned status is the worst of the status values from the individual sub-checks:
13
13
  1. The datastore clusters' own health statuses. The datastore clusters reflect their status as green/yellow/red. See
14
- [the Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html#cluster-health-api-response-body)
14
+ [the Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html)
15
15
  for details on the meaning of these statuses.
16
16
  - `green` maps to `healthy`, `yellow` to `degraded`, and `red` to `unhealthy`.
17
17
 
@@ -44,22 +44,49 @@ graph LR;
44
44
 
45
45
  ## Integration
46
46
 
47
- To use, simply register the `EnvoyExtension` when defining your schema:
47
+ To use, add the gem to your bundle:
48
48
 
49
- ```ruby
50
- require(envoy_extension_path = "elastic_graph/health_check/envoy_extension")
51
- schema.register_graphql_extension ElasticGraph::HealthCheck::EnvoyExtension,
52
- defined_at: envoy_extension_path,
53
- http_path_segment: "/_status"
54
- ```
49
+ ```diff
50
+ diff --git a/Gemfile b/Gemfile
51
+ index 4a5ef1e..5e9251d 100644
52
+ --- a/Gemfile
53
+ +++ b/Gemfile
54
+ @@ -8,6 +8,7 @@ gem "elasticgraph-query_registry", *elasticgraph_details
55
+
56
+ # Can be elasticgraph-elasticsearch or elasticgraph-opensearch based on the datastore you want to use.
57
+ gem "elasticgraph-opensearch", *elasticgraph_details
58
+ +gem "elasticgraph-health_check", *elasticgraph_details
55
59
 
56
- ## Configuration
60
+ gem "httpx", "~> 1.3"
57
61
 
58
- These checks are configurable. The following configuration will be used as an example:
62
+ ```
59
63
 
64
+ Then register the `EnvoyExtension` when defining your schema:
65
+
66
+ ```diff
67
+ diff --git a/config/schema.rb b/config/schema.rb
68
+ index 015c5fa..e3e60c6 100644
69
+ --- a/config/schema.rb
70
+ +++ b/config/schema.rb
71
+ @@ -12,6 +12,11 @@ ElasticGraph.define_schema do |schema|
72
+ # If you don't want to use this extension, you can remove these lines.
73
+ require(query_registry_path = "elastic_graph/query_registry/graphql_extension")
74
+ schema.register_graphql_extension ElasticGraph::QueryRegistry::GraphQLExtension, defined_at: query_registry_path
75
+ +
76
+ + require(envoy_extension_path = "elastic_graph/health_check/envoy_extension")
77
+ + schema.register_graphql_extension ElasticGraph::HealthCheck::EnvoyExtension,
78
+ + defined_at: envoy_extension_path,
79
+ + http_path_segment: "/_status"
80
+ end
81
+
82
+ # Load the rest of the schema from files at config/schema/**/*.rb.
60
83
  ```
84
+
85
+ Finally, configure it:
86
+
87
+ ```yaml
61
88
  health_check:
62
- clusters_to_consider: ["widgets-cluster"]
89
+ clusters_to_consider: ["main"]
63
90
  data_recency_checks:
64
91
  Widget:
65
92
  timestamp_field: createdAt
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: elasticgraph-health_check
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0.rc3
4
+ version: 1.0.0.rc4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Myron Marston
@@ -17,112 +17,112 @@ dependencies:
17
17
  requirements:
18
18
  - - '='
19
19
  - !ruby/object:Gem::Version
20
- version: 1.0.0.rc3
20
+ version: 1.0.0.rc4
21
21
  type: :runtime
22
22
  prerelease: false
23
23
  version_requirements: !ruby/object:Gem::Requirement
24
24
  requirements:
25
25
  - - '='
26
26
  - !ruby/object:Gem::Version
27
- version: 1.0.0.rc3
27
+ version: 1.0.0.rc4
28
28
  - !ruby/object:Gem::Dependency
29
29
  name: elasticgraph-graphql
30
30
  requirement: !ruby/object:Gem::Requirement
31
31
  requirements:
32
32
  - - '='
33
33
  - !ruby/object:Gem::Version
34
- version: 1.0.0.rc3
34
+ version: 1.0.0.rc4
35
35
  type: :runtime
36
36
  prerelease: false
37
37
  version_requirements: !ruby/object:Gem::Requirement
38
38
  requirements:
39
39
  - - '='
40
40
  - !ruby/object:Gem::Version
41
- version: 1.0.0.rc3
41
+ version: 1.0.0.rc4
42
42
  - !ruby/object:Gem::Dependency
43
43
  name: elasticgraph-support
44
44
  requirement: !ruby/object:Gem::Requirement
45
45
  requirements:
46
46
  - - '='
47
47
  - !ruby/object:Gem::Version
48
- version: 1.0.0.rc3
48
+ version: 1.0.0.rc4
49
49
  type: :runtime
50
50
  prerelease: false
51
51
  version_requirements: !ruby/object:Gem::Requirement
52
52
  requirements:
53
53
  - - '='
54
54
  - !ruby/object:Gem::Version
55
- version: 1.0.0.rc3
55
+ version: 1.0.0.rc4
56
56
  - !ruby/object:Gem::Dependency
57
57
  name: elasticgraph-admin
58
58
  requirement: !ruby/object:Gem::Requirement
59
59
  requirements:
60
60
  - - '='
61
61
  - !ruby/object:Gem::Version
62
- version: 1.0.0.rc3
62
+ version: 1.0.0.rc4
63
63
  type: :development
64
64
  prerelease: false
65
65
  version_requirements: !ruby/object:Gem::Requirement
66
66
  requirements:
67
67
  - - '='
68
68
  - !ruby/object:Gem::Version
69
- version: 1.0.0.rc3
69
+ version: 1.0.0.rc4
70
70
  - !ruby/object:Gem::Dependency
71
71
  name: elasticgraph-elasticsearch
72
72
  requirement: !ruby/object:Gem::Requirement
73
73
  requirements:
74
74
  - - '='
75
75
  - !ruby/object:Gem::Version
76
- version: 1.0.0.rc3
76
+ version: 1.0.0.rc4
77
77
  type: :development
78
78
  prerelease: false
79
79
  version_requirements: !ruby/object:Gem::Requirement
80
80
  requirements:
81
81
  - - '='
82
82
  - !ruby/object:Gem::Version
83
- version: 1.0.0.rc3
83
+ version: 1.0.0.rc4
84
84
  - !ruby/object:Gem::Dependency
85
85
  name: elasticgraph-indexer
86
86
  requirement: !ruby/object:Gem::Requirement
87
87
  requirements:
88
88
  - - '='
89
89
  - !ruby/object:Gem::Version
90
- version: 1.0.0.rc3
90
+ version: 1.0.0.rc4
91
91
  type: :development
92
92
  prerelease: false
93
93
  version_requirements: !ruby/object:Gem::Requirement
94
94
  requirements:
95
95
  - - '='
96
96
  - !ruby/object:Gem::Version
97
- version: 1.0.0.rc3
97
+ version: 1.0.0.rc4
98
98
  - !ruby/object:Gem::Dependency
99
99
  name: elasticgraph-opensearch
100
100
  requirement: !ruby/object:Gem::Requirement
101
101
  requirements:
102
102
  - - '='
103
103
  - !ruby/object:Gem::Version
104
- version: 1.0.0.rc3
104
+ version: 1.0.0.rc4
105
105
  type: :development
106
106
  prerelease: false
107
107
  version_requirements: !ruby/object:Gem::Requirement
108
108
  requirements:
109
109
  - - '='
110
110
  - !ruby/object:Gem::Version
111
- version: 1.0.0.rc3
111
+ version: 1.0.0.rc4
112
112
  - !ruby/object:Gem::Dependency
113
113
  name: elasticgraph-schema_definition
114
114
  requirement: !ruby/object:Gem::Requirement
115
115
  requirements:
116
116
  - - '='
117
117
  - !ruby/object:Gem::Version
118
- version: 1.0.0.rc3
118
+ version: 1.0.0.rc4
119
119
  type: :development
120
120
  prerelease: false
121
121
  version_requirements: !ruby/object:Gem::Requirement
122
122
  requirements:
123
123
  - - '='
124
124
  - !ruby/object:Gem::Version
125
- version: 1.0.0.rc3
125
+ version: 1.0.0.rc4
126
126
  email:
127
127
  - myron@squareup.com
128
128
  executables: []
@@ -142,10 +142,10 @@ licenses:
142
142
  - MIT
143
143
  metadata:
144
144
  bug_tracker_uri: https://github.com/block/elasticgraph/issues
145
- changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0.rc3
146
- documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0.rc3/
145
+ changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0.rc4
146
+ documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0.rc4/
147
147
  homepage_uri: https://block.github.io/elasticgraph/
148
- source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0.rc3/elasticgraph-health_check
148
+ source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0.rc4/elasticgraph-health_check
149
149
  gem_category: extension
150
150
  rdoc_options: []
151
151
  require_paths:
@@ -164,8 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
164
164
  - !ruby/object:Gem::Version
165
165
  version: '0'
166
166
  requirements: []
167
- rubygems_version: 3.6.7
167
+ rubygems_version: 3.6.9
168
168
  specification_version: 4
169
- summary: An ElasticGraph extension that provides a health check for high availability
170
- deployments.
169
+ summary: Provides a health check for high availability ElasticGraph deployments.
171
170
  test_files: []