cookbook 'gelf_handler', '~> 1.0.6', :supermarket
gelf_handler (5) Versions 1.0.6 Follow1
Installs/Configures a Chef handler which reports run failures and to a GELF server. Derived from Jon Woods gem.
cookbook 'gelf_handler', '~> 1.0.6'
knife supermarket install gelf_handler
knife supermarket download gelf_handler
Description
A cookbook that a handler that sends chef run results to a GELF server such as Logstash or Graylog. If you have the ohai-system_pacakges plugin installed, it will also send package statistics.
Requirements
The chef_handler cookbook.
Attributes
This cookbook uses the following attributes to configure how it is installed.
-
node['chef_client']['handler']['gelf']['host']- The gelf server host. Defaults to nil. -
node['chef_client']['handler']['gelf']['port']- The gelf server port. Defaults to 12201. -
node['chef_client']['handler']['gelf']['facility']- The facility under which to report. Defaults to 'chef-client'. -
node['chef_client']['handler']['gelf']['report_host']- The host to report messages as coming from. Defaults tonode['fqdn']. -
node['chef_client']['handler']['gelf']['blacklist']- A hash of cookbooks, resources and actions to ignore in the change list.. Defaults to{}.
Usage
Set the host and port properties on the node and include the "gelf_handler::default" recipe.
Blacklisting
Some resources report themselves as having updated on every run even if nothing changed, or are just things you don't care about. To reduce the amount of noise in your logs these can be ignored by providing a blacklist. In this example we don't want to be told about the GELF handler being activated:
node['chef_client']['handler']['gelf']['blacklist'] = {"chef_handler" => {"chef_handler" => [ "nothing", "enable" ]}
Credits
The handler was originally written by Jon Wood and was converted to a cookbook by Peter Donald.
Dependent cookbooks
| chef_handler >= 0.0.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Collaborator Number Metric
1.0.6 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
1.0.6 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
1.0.6 failed this metric
FC052: Metadata uses the deprecated "suggests" keyword: gelf_handler/metadata.rb:10
FC064: Ensure issues_url is set in metadata: gelf_handler/metadata.rb:1
FC065: Ensure source_url is set in metadata: gelf_handler/metadata.rb:1
FC066: Ensure chef_version is set in metadata: gelf_handler/metadata.rb:1
FC067: Ensure at least one platform supported in metadata: gelf_handler/metadata.rb:1
FC069: Ensure standardized license defined in metadata: gelf_handler/metadata.rb:1
Run with Foodcritic Version 14.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
1.0.6 passed this metric
Publish Metric
1.0.6 passed this metric
Supported Platforms Metric
1.0.6 failed this metric
gelf_handler should declare what platform(s) it supports.
Testing File Metric
1.0.6 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.0.6 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.0.6 failed this metric
1.0.6 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
1.0.6 failed this metric
FC052: Metadata uses the deprecated "suggests" keyword: gelf_handler/metadata.rb:10
FC064: Ensure issues_url is set in metadata: gelf_handler/metadata.rb:1
FC065: Ensure source_url is set in metadata: gelf_handler/metadata.rb:1
FC066: Ensure chef_version is set in metadata: gelf_handler/metadata.rb:1
FC067: Ensure at least one platform supported in metadata: gelf_handler/metadata.rb:1
FC069: Ensure standardized license defined in metadata: gelf_handler/metadata.rb:1
Run with Foodcritic Version 14.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
1.0.6 passed this metric
Publish Metric
1.0.6 passed this metric
Supported Platforms Metric
1.0.6 failed this metric
gelf_handler should declare what platform(s) it supports.
Testing File Metric
1.0.6 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.0.6 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.0.6 failed this metric
FC064: Ensure issues_url is set in metadata: gelf_handler/metadata.rb:1
FC065: Ensure source_url is set in metadata: gelf_handler/metadata.rb:1
FC066: Ensure chef_version is set in metadata: gelf_handler/metadata.rb:1
FC067: Ensure at least one platform supported in metadata: gelf_handler/metadata.rb:1
FC069: Ensure standardized license defined in metadata: gelf_handler/metadata.rb:1
Run with Foodcritic Version 14.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
1.0.6 passed this metric
Publish Metric
1.0.6 passed this metric
Supported Platforms Metric
1.0.6 failed this metric
gelf_handler should declare what platform(s) it supports.
Testing File Metric
1.0.6 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.0.6 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.0.6 passed this metric
1.0.6 failed this metric
gelf_handler should declare what platform(s) it supports.
Testing File Metric
1.0.6 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.0.6 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.0.6 failed this metric
1.0.6 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
