(#597) Add sensu::contact type (Enterprise Only) #728

jeffmccune · 2017-07-11T16:24:50Z

Without this patch the Puppet module doesn't provide an affordance for contact
routing This
patch addresses the problem by adding a new defined type, sensu::contact backed
by a custom type and provider for sensu_contact.

Example usage:

sensu::contact { 'support':
  config => { 'email'  => { 'to' => 'support@example.com' } },
}
sensu::contact { 'ops':
  config => { 'email'  => { 'to' => 'ops@example.com' } },
}
sensu::check { 'check_ntp':
  command  => 'PATH=$PATH:/usr/lib64/nagios/plugins check_ntp_time -H pool.ntp.org -w 30 -c 60',
  handlers => 'email',
  contacts => ['ops', 'support'],
}

Resolves #597

jeffmccune · 2017-07-11T16:26:08Z

Tested in Vagrant using sensu-server-enterprise

ghoneycutt · 2017-07-11T17:26:39Z

lib/puppet/type/sensu_check.rb

@@ -69,6 +69,15 @@ def insync?(is)
    end
  end

+  newproperty(:contacts, :array_matching => :all, :parent => SensuCheckArrayProperty) do
+    desc "Contact names to override handler configuration via Contact Routing"
+    newvalues(/.*/, :absent)


regex for valid contact name - https://sensuapp.org/docs/0.29/enterprise/contact-routing.html#contact-names

Regex has been added both to sensu_check's contacts property and sensu_contact's name parameter. Spec tests have been updated to exercise the expected behavior of invalid names throwing Puppet::ResourceError's.

ghoneycutt · 2017-07-11T17:32:08Z

manifests/contact.pp

+    before => Sensu_contact[$name],
+  }
+
+  sensu_contact { $name:


instead of a type/provider, what about using sensu_sorted_json() as is done in sensu::write_json? The current layout is to used defined types that then call custom type/providers. What about still calling defined types, but then replacing the type/provider code with sensu_sorted_json()? If possible, I think that would greatly simplify things.

Could we still use resources {} to purge?

I'll take a look. This also reminds me, self.instances needs to be implemented in the type if we don't implement this using sensu_sorted_json().

Filed #729 to track this independently of this PR and related enhancement.

Added this documentation to the sensu::contact defined type:

Note: If the sensu::purge_config class parameter is true, unmanaged sensu::contact resources located in /etc/sensu/conf.d/contacts will be purged.

ghoneycutt · 2017-07-11T17:33:39Z

tests/sensu-server-enterprise.pp

+    ensure => 'present',
+    config => { 'email'  => { 'to' => 'ops@example.com' } },
+  }
+  sensu::contact { 'hacker':


suggest using another name.

Changed to “departed"

ghoneycutt · 2017-07-11T17:59:34Z

manifests/package.pp

@@ -144,7 +144,7 @@
    }
  }

-  file { [ $::sensu::conf_dir, "${sensu::conf_dir}/handlers", "${sensu::conf_dir}/checks", "${sensu::conf_dir}/filters", "${sensu::conf_dir}/extensions", "${sensu::conf_dir}/mutators" ]:
+  file { [ $::sensu::conf_dir, "${sensu::conf_dir}/handlers", "${sensu::conf_dir}/checks", "${sensu::conf_dir}/filters", "${sensu::conf_dir}/extensions", "${sensu::conf_dir}/mutators", "${sensu::conf_dir}/contacts" ]:


purge is there

Got it, added documentation to sensu::contact to note this purge behavior.

ghoneycutt · 2017-07-11T18:00:20Z

manifests/contact.pp

+    ensure    => $ensure,
+    config    => $config,
+    base_path => $base_path,
+    require   => File['/etc/sensu/conf.d/contacts'],


Should this notify the service?

i see it is in the type.

ghoneycutt · 2017-07-11T18:01:56Z

Please add the example usage to the README. Besides that, else I think it's ready.

jeffmccune · 2017-07-11T18:37:56Z

Please add the example usage to the README. Besides that, else I think it's ready.

README updated with a similar example to the vagrant manifest in tests/sensu-server-enterprise.pp.

ghoneycutt · 2017-07-11T19:08:07Z

manifests/contact.pp

+# = Define: sensu::routing
+#
+# Manage [Contact
+# Routing](https://sensuapp.org/docs/0.26/enterprise/contact-routing.html)


we're on 0.29. Best to use latest here though

https://sensuapp.org/docs/latest/enterprise/contact-routing.html

Updated to latest.

Without this patch the Puppet module doesn't provide an affordance for [contact routing](https://sensuapp.org/docs/0.29/enterprise/contact-routing.html) This patch addresses the problem by adding a new defined type, sensu::contact backed by a custom type and provider for sensu_contact. Example usage: sensu::contact { 'support': config => { 'email' => { 'to' => 'support@example.com' } }, } sensu::contact { 'ops': config => { 'email' => { 'to' => 'ops@example.com' } }, } sensu::check { 'check_ntp': command => 'PATH=$PATH:/usr/lib64/nagios/plugins check_ntp_time -H pool.ntp.org -w 30 -c 60', handlers => 'email', contacts => ['ops', 'support'], } Resolves sensu#597

ghoneycutt · 2017-07-11T19:46:41Z

Released in v2.20.0

jeffmccune added the in progress label Jul 11, 2017

jeffmccune requested a review from ghoneycutt July 11, 2017 16:25

ghoneycutt reviewed Jul 11, 2017

View reviewed changes

jeffmccune force-pushed the 597_add_contact_routing_type branch from 2cd45f6 to 3cfe2a8 Compare July 11, 2017 17:36

ghoneycutt reviewed Jul 11, 2017

View reviewed changes

ghoneycutt approved these changes Jul 11, 2017

View reviewed changes

jeffmccune force-pushed the 597_add_contact_routing_type branch from 3cfe2a8 to 89e7918 Compare July 11, 2017 18:22

jeffmccune mentioned this pull request Jul 11, 2017

Consider replacing sensu_contact (and other types) with sensu_sorted_json() #729

Closed

3 tasks

jeffmccune force-pushed the 597_add_contact_routing_type branch from 89e7918 to fae56f7 Compare July 11, 2017 18:36

jeffmccune mentioned this pull request Jul 11, 2017

Unable to define Contact Routing for Sensu Enterprise #597

Closed

ghoneycutt requested changes Jul 11, 2017

View reviewed changes

jeffmccune force-pushed the 597_add_contact_routing_type branch from fae56f7 to 4d767b2 Compare July 11, 2017 19:19

ghoneycutt approved these changes Jul 11, 2017

View reviewed changes

ghoneycutt merged commit 1f46028 into sensu:master Jul 11, 2017

ghoneycutt removed the in progress label Jul 11, 2017

ghoneycutt added the sensu v1 label Sep 5, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(#597) Add sensu::contact type (Enterprise Only) #728

(#597) Add sensu::contact type (Enterprise Only) #728

jeffmccune commented Jul 11, 2017

jeffmccune commented Jul 11, 2017

ghoneycutt Jul 11, 2017

jeffmccune Jul 11, 2017

ghoneycutt Jul 11, 2017

ghoneycutt Jul 11, 2017

jeffmccune Jul 11, 2017

jeffmccune Jul 11, 2017

jeffmccune Jul 11, 2017

ghoneycutt Jul 11, 2017

jeffmccune Jul 11, 2017

ghoneycutt Jul 11, 2017

jeffmccune Jul 11, 2017

ghoneycutt Jul 11, 2017

ghoneycutt Jul 11, 2017

jeffmccune Jul 11, 2017

ghoneycutt commented Jul 11, 2017

jeffmccune commented Jul 11, 2017

ghoneycutt Jul 11, 2017

jeffmccune Jul 11, 2017

ghoneycutt commented Jul 11, 2017

(#597) Add sensu::contact type (Enterprise Only) #728

(#597) Add sensu::contact type (Enterprise Only) #728

Conversation

jeffmccune commented Jul 11, 2017

jeffmccune commented Jul 11, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghoneycutt commented Jul 11, 2017

jeffmccune commented Jul 11, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghoneycutt commented Jul 11, 2017