Forge Home

monitoring_check

Wrapper for sensu::check with Yelpisms

9,811 downloads

7,727 latest version

3.3 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.0.5 (latest)
  • 0.0.4
released Dec 7th 2015
This version is compatible with:

    Start using this module

    • r10k or Code Manager
    • Bolt
    • Manual installation
    • Direct download

    Add this module to your Puppetfile:

    mod 'yelp-monitoring_check', '0.0.5'
    Learn more about managing modules with a Puppetfile

    Add this module to your Bolt project:

    bolt module add yelp-monitoring_check
    Learn more about using this module with an existing project

    Manually install this module globally with Puppet module tool:

    puppet module install yelp-monitoring_check --version 0.0.5

    Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

    Download

    Documentation

    yelp/monitoring_check — version 0.0.5 Dec 7th 2015

    ##Overview

    Build Status

    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.