Version information
released Dec 7th 2015
This version is compatible with:
Start using this module
Add this module to your Puppetfile:
mod 'yelp-monitoring_check', '0.0.5'Learn more about managing modules with a PuppetfileDocumentation
yelp/monitoring_check — version 0.0.5 Dec 7th 2015
##Overview
monitoring_check is a puppet module to create Sensu checks.
These are special Sensu checks, that are designed to operate with the
Yelp sensu_handlers, for multi-team environments.
The monitoring_check definition allows applications to define their behavior,
including how noisy they are, which teams get notified, and how.
Examples
# Page if operations if cron isn't running
monitoring_check { 'cron':
alert_after => '5m',
check_every => '1m',
page => true,
team => 'operations',
runbook => 'http://lmgtfy.com/?q=cron',
command => "/usr/lib/nagios/plugins/check_procs -C crond -c 1:30 -t 30 ",
require => Class['cron']
}
Parameters
Please see init.pp for a full list of parameters. They are documented
in the standard puppet doc format.
Team Data JSON
By default, monitoring_check will expose the Team Data as JSON in
/etc/sensu/team_data.json by accessing the team_data key. This file is
designed to be used by non-puppet clients, to help with validation.
However, it could potentially contain sensitive information. It can be disabled by
setting monitoring_check::params::expose_team_data to false.
Note: Team data is always exposed on the sensu-server.
Limitations / Explanation
This wrapper only works with the Yelp handlers. The secret is that a sensu check can declare arbitrary key-value pairs in its event data.
Then, the special handlers can pick up these key-values and make decisions based on them.
For example, monitoring_check can set a notification_email entry, and
the Yelp email handler can pick up on this entry and send emails specifically
to the specified email address.
Contrast this with traditional sensu handlers, where the destination email address is configuration the handler, not the check.
License
Apache 2.
Contributing
Open an issue or fork and open a Pull Request
Please do not attempt to use monitoring_check without Yelp's sensu_handlers
unless you intend to write your own custom handlers.
Change Log
Unreleased
Closed issues:
- Release to the forge? #86
- possible race condition in check-cluster.rb? #74
- Arbitrary tags in checks #71
- cluster checks don't exclude themselves from the aggregate check #65
- revisit new_check['status'] in monitoring_check::server_side #44
- fix tests the right way #40
- Fix or remove cluster_check tests #34
- Deploy monitoring_check::cluster to a wider net #30
- Build sensu watchdog meta-check #28
- So..... aggregates doesn't work the way I thought they did #26
- Aggregate Timelimits... probably shouldn't exist #25
- Sensu::VERSION is undefined? #24
- CRITICAL: Releasing lock due to error: undefined local variable or method `percent_non_zero' #22
- Cluster checked monitoring_checks should be able to be sent to the aggregate api *and* get handled as normal #21
- cluster_check should ignore checks or hosts that have been silenced #20
- cluster_check should fail with Unknown if deployed to a .12 cluster #19
- cluster_check cannot assume that it has access to the check settings #18
- check_cluster lacks puppet or ruby tests #17
- Return codes for check_cluster.rb never get sent out #15
- cluster_check should emit debug information to stdout if it got a lock and ran the check #14
- Better error message when check is not defined #13
- check-cluster.rb crashes when trying to load sensu/settings #12
- cluster_check should use "undef" as much as possible to reduce default duplication #11
- Make runbook an optional parameter on the cluster_check #10
- monitoring_check depends on annotate() which is not in this module and not open source #9
- Use the params class to allow defaults to be overriden #8
- Rename monitoring_check::check_cluster #7
- Remove config_dir param in cluster check stuff #6
Merged pull requests:
- team override option in fleet check #85 (somic)
- Making this work for windows. #84 (liamjbennett)
- fix api endpoint in fleet check #83 (somic)
- add name to generated event #82 (somic)
- fix more bugs in fleet check #81 (somic)
- fleet_check.rb fixes #80 (somic)
- better compat with sensu-puppet for subdue param #79 (somic)
- Adding support to pass the subdue option into sensu::check #78 (liamjbennett)
- add fleet_check.rb #77 (somic)
- more flexible way to manage how events are handled #76 (somic)
- include number of stale values in cluster check output #75 (somic)
- make source param work with newer sensu-puppet #73 (somic)
- Adding arbitrary tags (FIXED #71) #72 (jaxxstorm)
- Minimum nodes #70 (jaxxstorm)
- Fixing failing host output #69 (jaxxstorm)
- Display hosts in output #68 (jaxxstorm)
- raise meaningful error when no servers found for cluster check #67 (keymone)
- Omit check results with same name as cluster_name FIXES #65 #66 (jaxxstorm)
- If the lock expires sooner than rtt to redis server, return ok #63 (jglukasik)
- Default interval #62 (jglukasik)
- Removing comments on runbook, tip passthru #61 (jglukasik)
- repoint apt in fixtures to proper upstream #60 (somic)
- Debug help #58 (jglukasik)
- add some unit tests for check_sever_side.rb #57 (somic)
- suppress notifications from server-side placeholder #56 (somic)
- Remove cluster name from params, use generic defaults #55 (jglukasik)
- Use a host's region as the default cluster #54 (jglukasik)
- add source parameter to monitoring_check class #52 (Rob-Johnson)
- To spawn no handers, send an empty array in the "handlers" param #51 (jglukasik)
- Make send-test-sensu-alert respect check ttl #50 (solarkennedy)
- Add option to not use handlers for a monitoring check #49 (jglukasik)
- Removed annotation feature #48 (solarkennedy)
- add event_name to server side check #47 (somic)
- several improvements in server side check #46 (somic)
- workaround for bug in upstream - require json in check_server_side.rb #45 (somic)
- Make the teams.json file depend on the sensu package existing #42 (solarkennedy)
- fix tests the quick way #39 (somic)
- monitoring_check::synchronized #37 (somic)
- Fixup docstrings #35 (kmosher)
- Added send-test-sensu-alert script #32 (solarkennedy)
- Remove the ensure option, as monitoring_checks are purged #31 (hashbrowncipher)
- Add override_sensu_checks_to feature #27 (bobtfish)
- Brought in annotation references to make the module depend on less Yelp infrastructure. Closes #9 #23 (solarkennedy)
- Added params class to start potentially handling default cases. Closes #8 #16 (solarkennedy)
- Give each check a timeout by default #5 (hashbrowncipher)
- Better error if we have no teams data #4 (bobtfish)
- Initial stab at monitoring_check::cluster #3 (keymone)
- Added validation to the command if we are running sudo #2 (solarkennedy)
- Add the ability to auto-annotate monitoring_checks #1 (hashbrowncipher)
* This Change Log was automatically generated by github_changelog_generator
Dependencies
- puppetlabs-stdlib (>= 1.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.