diplomat 2.6.1 → 2.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a7d8de13c2c322771e2077560a34336a92744122540db247dc5ee8f4c97a7f1
-  data.tar.gz: a13421e5a4c9672f8f8410065ee5f4ab38833acc027f8cfb0edc6c2c0bfd30fd
+  metadata.gz: 602c9e392d4e521d6b749aa0b9cfb46cead8e1a16547c6e62f480e12230bbde5
+  data.tar.gz: 67fac5cfa5529c346e3a7deb2108dda46aeda3c728b4376b347a34b9781edded
 SHA512:
-  metadata.gz: c1f93bed5e1bf7d1ebd3a62dc3fb0a869c34ce774ae0e992bd0efdbb6a0004ab57e757e5e8d850456032c739bc86ae86bbc1e9b1cd3e7a64e8d5635402f7d851
-  data.tar.gz: 332e033972fc6e8aed716800553edcab761320eea3d2353647102310e199a0eadcdba85a926b2dedbfdc8f4348b7cc3a1d0ed94562dffeacc24251d852d2f698
+  metadata.gz: e75b590b288dec5984484dca08ae682459fae2855cad9e09566b9d6f5cff151a53522b698e19542d986a8b1a6682f57f567e353f17d1c8166212d92e19f41a6c
+  data.tar.gz: 1d0f7b3878d1431a2e45525cd9ac74d11965a051141ef245e4fd884a8848ee8f1bf09ab356daa10914392152f5be7b10c81880ce934f0a6775a8e91e54163870

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 => 'Service==foo'})
+```
+
 ### Maintenance mode
 
 Enable maintenance mode on a host, with optional reason and DC (requires access to local agent)

data/lib/diplomat/health.rb

@@ -59,35 +59,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.1'
+  VERSION = '2.6.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.6.2
 platform: ruby
 authors:
 - John Hamelink
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-05 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler