(GH-560) Add docs for $sensu::check::custom

Use the given example in the spec tests.
sensu · Jul 13, 2017 · 60885dc · 60885dc
1 parent b759184
commit 60885dc
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/manifests/check.pp b/manifests/check.pp
@@ -94,6 +94,11 @@
 #   Set this to 'absent' to remove it completely.
 #   Default: undef
 #
+# [*custom*]
+#   Hash. List of custom data to include in the check.
+#   Default: undef
+#   Example: { 'remediation' => { 'low_remediation' => { 'occurrences' => [1,2], 'severities' => [1], 'command' => "/bin/command", 'publish' => false, } } }
+#
 # [*ttl*]
 #   Integer. The time to live (TTL) in seconds until check results are considered stale.
 #   Set this to 'absent' to remove it completely.

diff --git a/spec/defines/sensu_check_spec.rb b/spec/defines/sensu_check_spec.rb
@@ -29,7 +29,7 @@
         :occurrences         => 5,
         :refresh             => 3600,
         :subscribers         => ['all'],
-        :custom              => { 'a' => 'b', 'array' => [ 'c', 'd']},
+        :custom              => { 'remediation' => { 'low_remediation' => { 'occurrences' => [1,2], 'severities' => [1], 'command' => "/bin/command", 'publish' => false, } } },
         :type                => 'metric',
         :standalone          => true,
         :low_flap_threshold  => 10,
@@ -49,7 +49,7 @@
         :occurrences         => 5,
         :refresh             => 3600,
         :subscribers         => ['all'],
-        :custom              => { 'a' => 'b', 'array' => [ 'c', 'd']},
+        :custom              => { 'remediation' => { 'low_remediation' => { 'occurrences' => [1,2], 'severities' => [1], 'command' => "/bin/command", 'publish' => false, } } },
         :type                => 'metric',
         :standalone          => true,
         :low_flap_threshold  => 10,