diplomat 2.6.0 → 2.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25c0b2769edc31ef7e21ce9a27bb80640ad924e8c7e5d3941ad85a7cf94605da
-  data.tar.gz: b42997b367d7a4f17358823e773c5ade86789677c273d02f02ca799baba8c79f
+  metadata.gz: 5d140133bd3a6e625d15be77e1c851348e71c3a2ebf573d64d7542f1b68e8745
+  data.tar.gz: cb73d392f2a10f9999b43000c52a2064a892c83ba1ed802fc07597ab102bc496
 SHA512:
-  metadata.gz: cd6483e59dd18715f52bb783d4cdfaaa4ba3f0b16e5f045c3a7bfea6cfea5f002bda8f3ca85fe33854be9e69e1ae523ba3277699204bcf07c07a8476c84af980
-  data.tar.gz: 0c92e00358566383f63105d6c656db1b641199fefe03aefdabed592dd4efdf6eceeaa5e7e1a5a1c8ad8538bdf6ed5fdbc48ecd4400a9b556d40a5ab42b1bbeaf
+  metadata.gz: f223217f2580e3264164c61e9cfe42284714d853a5d111b330b46891cc3ea3348ccf455dd84446e87b67c92043ae0aef9733803be6a9e1446d8412fea4f41eef
+  data.tar.gz: 0d4e0f56a7bc839d1b284a76af995f1a698d092549672ec40c56fd37983d711652c9f4ca671c7d12772d1906147848f272e29cac02cd7c317b4a473c741a2046

data/README.md

@@ -331,6 +331,40 @@ Get the health status from autopilot
 Diplomat::Autopilot.get_health()
 ```
 
+### Health
+
+Retrieve health of a node
+
+```ruby
+Diplomat::Health.node('fooNode', :dc => 'abc')
+```
+
+Retrieve health of a given check
+
+```ruby
+Diplomat::Health.checks('fooCheck', :dc => 'abc')
+```
+
+Retrieve health of a given service
+
+```ruby
+Diplomat::Health.service('fooService', :dc => 'abc')
+```
+
+Retrieve a list of anything that correspond to the state ("any", "passing", "warning", or "critical")
+You can use filters too !
+
+```ruby
+Diplomat::Health.state("critical", {:dc => 'abc', :filter => 'Node==foo'})
+```
+
+You also have some convenience method (`any`, `passing`, `warning`, `critical`)
+That can be filtered
+
+```ruby
+Diplomat::Health.critical({:dc => 'abc', :filter => 'ServiceName==foo'})
+```
+
 ### Maintenance mode
 
 Enable maintenance mode on a host, with optional reason and DC (requires access to local agent)

data/lib/diplomat/health.rb

@@ -8,11 +8,12 @@ module Diplomat
 
     # Get node health
     # @param n [String] the node
-    # @param options [Hash] :dc string for dc specific query
+    # @param options [Hash] :dc, :filter string for specific query
     # @return [OpenStruct] all data associated with the node
     def node(n, options = {})
       custom_params = []
       custom_params << use_named_parameter('dc', options[:dc]) if options[:dc]
+      custom_params << use_named_parameter('filter', options[:filter]) if options[:filter]
 
       ret = send_get_request(@conn, ["/v1/health/node/#{n}"], options, custom_params)
       JSON.parse(ret.body).map { |node| OpenStruct.new node }
@@ -20,11 +21,12 @@ module Diplomat
 
     # Get service checks
     # @param s [String] the service
-    # @param options [Hash] :dc string for dc specific query
+    # @param options [Hash] :dc, :filter string for specific query
     # @return [OpenStruct] all data associated with the node
     def checks(s, options = {})
       custom_params = []
       custom_params << use_named_parameter('dc', options[:dc]) if options[:dc]
+      custom_params << use_named_parameter('filter', options[:filter]) if options[:filter]
 
       ret = send_get_request(@conn, ["/v1/health/checks/#{s}"], options, custom_params)
       JSON.parse(ret.body).map { |check| OpenStruct.new check }
@@ -44,6 +46,7 @@ module Diplomat
       custom_params << use_named_parameter('near', options[:near]) if options[:near]
       custom_params << use_named_parameter('node-meta', options[:node_meta]) if options[:node_meta]
       custom_params << use_named_parameter('index', options[:index]) if options[:index]
+      custom_params << use_named_parameter('filter', options[:filter]) if options[:filter]
 
       ret = send_get_request(@conn, ["/v1/health/service/#{s}"], options, custom_params)
       if meta && ret.headers
@@ -59,35 +62,44 @@ module Diplomat
 
     # Get service health
     # @param s [String] the state ("any", "passing", "warning", or "critical")
-    # @param options [Hash] :dc string for dc specific query
+    # @param options [Hash] :dc, :near, :filter string for specific query
     # @return [OpenStruct] all data associated with the node
     def state(s, options = {})
       custom_params = []
       custom_params << use_named_parameter('dc', options[:dc]) if options[:dc]
       custom_params << use_named_parameter('near', options[:near]) if options[:near]
+      custom_params << use_named_parameter('filter', options[:filter]) if options[:filter]
 
       ret = send_get_request(@conn, ["/v1/health/state/#{s}"], options, custom_params)
       JSON.parse(ret.body).map { |status| OpenStruct.new status }
     end
 
     # Convenience method to get services in any state
-    def any
-      state('any')
+    # @param options [Hash] :dc, :near, :filter string for specific query
+    # @return [OpenStruct] all data associated with the node
+    def any(options = {})
+      state('any', options)
     end
 
     # Convenience method to get services in passing state
-    def passing
-      state('passing')
+    # @param options [Hash] :dc, :near, :filter string for specific query
+    # @return [OpenStruct] all data associated with the node
+    def passing(options = {})
+      state('passing', options)
     end
 
     # Convenience method to get services in warning state
-    def warning
-      state('warning')
+    # @param options [Hash] :dc, :near, :filter string for specific query
+    # @return [OpenStruct] all data associated with the node
+    def warning(options = {})
+      state('warning', options)
     end
 
     # Convenience method to get services in critical state
-    def critical
-      state('critical')
+    # @param options [Hash] :dc, :near, :filter string for specific query
+    # @return [OpenStruct] all data associated with the node
+    def critical(options = {})
+      state('critical', options)
     end
   end
 end

data/lib/diplomat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Diplomat
-  VERSION = '2.6.0'
+  VERSION = '2.6.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.6.3
 platform: ruby
 authors:
 - John Hamelink
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-26 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -187,6 +187,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -194,6 +197,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Diplomat is a simple wrapper for Consul
 email:
 - john@johnhamelink.com