Remove sensu_check_config #764
Comments
|
Related to #759 but is a separate task unrelated to the reference for provider spec testing. |
Without this patch there are no rspec examples of how providers should behave. This is a problem because there should be a reference to build from when changing the providers. This patch addresses the problem by adding rspec coverage for the sensu_check_config json provider. Note: Garrett and I decided to remove the sensu_check_config type and provider. It doesn't operate as expected in the master branch, is not used anywhere in the module, and the custom configuration map in sensu_check provides the same behavior for checks. Each specific type will implement the generic configuration map similar to sensu_check. The reference implementation of the spec tests will move to sensu_check in a subsequent patch. sensu_check_config will be removed in a subsequent patch. Relates to sensu#764
Sensu is agnostic of custom configuration scopes, so plugins and extensions of all sorts can load Sensu's config on disk and read their settings from arbitrary keys. For example, handler-mailer, handler-mailer-ses and handler-mailer-mailgun plugins in the sensu-plugins-mailer project look for their configuration under
I think it's worth noting that this configuration convention isn't specific to check plugins. It can apply to handler plugins, mutator plugins and extensions of all sorts, be they check, filter, mutator or handler. With this in mind, I think instructing users of this module to provide custom configuration using |
|
Working on this now, I'm going to proceed with the approach of adding a |
Without this patch there is no way to specify arbitrary configuration at the top level of the sensu check configuration object. This patch addresses the problem by adding a new properto to sensu::check and sensu_check named `config`. This property accepts a Hash map and merges all other configuration on top of this base starting point. This patch also adds a new mix-in method, `PuppetX::Sensu::SortHash#sort_hash`. This method returns a hash sorted recursively, meaning all nested hash values are sorted in the same manner. This method is intended for use in the #flush method of all Sensu providers. See sensu#764
Without this patch there is no way to specify arbitrary configuration at the top level of the sensu check configuration object. This patch addresses the problem by adding a new properto to sensu::check and sensu_check named `config`. This property accepts a Hash map and merges all other configuration on top of this base starting point. This patch also adds a new mix-in method, `PuppetX::Sensu::SortHash#sort_hash`. This method returns a hash sorted recursively, meaning all nested hash values are sorted in the same manner. This method is intended for use in the #flush method of all Sensu providers. See sensu#764
Without this patch there is no way to specify arbitrary configuration at the top level of the sensu check configuration object. This patch addresses the problem by adding a new properto to sensu::check and sensu_check named `config`. This property accepts a Hash map and merges all other configuration on top of this base starting point. This patch also adds a new mix-in method, `PuppetX::Sensu::SortHash#sort_hash`. This method returns a hash sorted recursively, meaning all nested hash values are sorted in the same manner. This method is intended for use in the #flush method of all Sensu providers. See sensu#764
Without this patch there is no way to specify arbitrary configuration at the top level of the sensu check configuration object. This patch addresses the problem by adding a new properto to sensu::check and sensu_check named `config`. This property accepts a Hash map and merges all other configuration on top of this base starting point. This patch also adds a new mix-in method, `PuppetX::Sensu::SortHash#sort_hash`. This method returns a hash sorted recursively, meaning all nested hash values are sorted in the same manner. This method is intended for use in the #flush method of all Sensu providers. See sensu#764
Without this patch there is no way to specify arbitrary configuration at the top level of the sensu check configuration object. This patch addresses the problem by adding a new properto to sensu::check and sensu_check named `config`. This property accepts a Hash map and merges all other configuration on top of this base starting point. This patch also adds a new mix-in method, `PuppetX::Sensu::SortHash#sort_hash`. This method returns a hash sorted recursively, meaning all nested hash values are sorted in the same manner. This method is intended for use in the #flush method of all Sensu providers. See sensu#764
|
@cwjohnston After spending a little time looking into a config property, I think you're suggestion of using sensu_write_json() is way better. There are a bunch of edge cases around the merging of an arbitrary config map with all the other properties, especially the I'm going to close the WIP related to the config property and switch over to refactoring the defined types to use sensu_write_json(). |
|
Next steps on this are to get #785 merged, let it bake in the community, then remove |
|
In order to preserve semver, this will wait until the module is redone for Sensu 2. |
Garrett and I discussed this today. There is confusion surrounding sensu_check_config, the JSON provider doesn't seem to be well-behaved, the type isn't used anywhere in the module, there isn't any documentation, and the sensu::check type appears to provide all the necessary functionality for checks.
One possible situation is sensu_check_config is able to set keys and values at the same level as "checks" in the target file, whereas sensu::check can only set custom configuration nested under checks['mycheck'].
If it is necessary to add configuration in the top-level map of the JSON files in
conf.d/checks/, then sensu::check should take aconfigproperty which is merged together with thecheckstop level key.The text was updated successfully, but these errors were encountered: