Chef Cookbook for Uptime Cloud Monitor services

Chef cookbook for the Uptime Cloud Monitor collector agent and website / port probes.
Requires a Uptime Cloud Monitor account to use. Free trial available.

Requirements

Chef 12.5 and up. For Chef 10 to 12.4 you can use version [v1.0.1] (https://github.com/CopperEgg/chef-copperegg/tree/v1.0.1)

The following cookbooks are direct dependencies because they're used for common "default" functionality.

curl(for copperegg::default)

The following cookbooks are direct dependencies

On RHEL family distros, recipe[yum::epel] might be required.
On Ubuntu, recipe[apt::default] and recipe[curl] might be required to install and update curl.

Platform

Any Linux 2.6+ OS, including: Ubuntu, Debian, Vyatta, RedHat Enterprise, CentOS, Fedora, Amazon, SuSE, openSuSE, Gentoo, and many derivatives.
Windows

Attributes

default['copperegg']['apikey'] = Your API Key available from the Uptime Cloud Monitor App Settings Page.
default['copperegg']['tags'] = A comma separated list of tags to apply. Optional. Manage your tags.
default['copperegg']['label'] = Label to apply in place of hostname when displaying in the dashboard. WARNING: If you want the same label applied to multiple systems, you may want to consider tags instead. This is most useful if you intend a recipe for a single server. Optional.
default['copperegg']['oom_protect'] = Flag for determining if the Linux Out Of Memory manager (OOM) should be allowed to kill the RevealCloud process. Default false (allow OOM to kill the process). Optional.
default['copperegg']['proxy'] = Proxy server required to talk to the revealcloud api servers, such as myproxy.mycorp.com:8080. Optional. Leave blank unless you know what you are doing.
default['copperegg']['use_fqdn'] = Flag for using the fqdn as the uuid. true => Agent will be started with -U node.fqdn . Default false. Optional.
default['copperegg']['include_node_tags'] = Propagate Chef node tags to Uptime Cloud Monitor tags. Default true.
default['copperegg']['include_roles_astags'] = Propagate Chef node Roles to Uptime Cloud Monitor tags. Default true.
default['copperegg']['include_env_astag'] = Propagate the Chef environment to a Uptime Cloud Monitor tag. Default true.
default['copperegg']['annotate_chefrun_success'] = Send Uptime Cloud Monitor an annotation for each successful chef run. Default false.
default['copperegg']['annotate_chefrun_fail'] = Send Uptime Cloud Monitor an annotation for each failed chef run. Default true.
default['copperegg']['create_sshprobe'] = Create an external SSH probe for this node. Default false.

Collector Specific Attributes

default['copperegg']['update_latest'] = Updates collector to latest version if any. Default true.
default['copperegg']['uninstall_collector'] = Uninstall collector on the node. Default false.
default['copperegg']['remove_on_uninstall'] = Uninstall collector and remove it's data from Uptime Cloud Monitor. Default false.

Usage

Download the Uptime Cloud Monitor cookbook into your chef-repo/cookbooks/copperegg directory: (the cookbook directory name must be copperegg)
- git clone https://github.com/CopperEgg/chef-copperegg.git ./copperegg, or
- manually download from the Opscode community site http://community.opscode.com/cookbooks/copperegg, or
- knife cookbook site install copperegg
Set your apikey as described in the Attributes section.
- edit copperegg/attributes/default.rb and change YOUR_USER_API_KEY to be correct.
- or override node['copperegg']['apikey'] within role or environment.
Set any other optional attributes described above, as desired.
Upload the cookbook to your chef server or hosted chef:
- knife cookbook upload -a to upload all cookbooks or
- knife cookbook upload copperegg --include-dependencies
- To install dependencies, run knife cookbook site install curl 2.0.3 and knife cookbook site install apt 3.0.0
Include recipe[copperegg] in the run_list for all of your servers.
- knife node run_list add NODES 'recipe[copperegg]'
Run chef-client on your nodes in whatever manner suits you, such as sudo chef-client or a batch job.
View your systems within 10 seconds in the RevealCloud App

Creating and managing website and port probes

The Uptime Cloud Monitor Cookbook contains a LightWeight Resource Provider (LWRP) for simplifying the automation of Uptime Cloud Monitor probes.
To create a copperegg probe, you need to include something similar to the following example:

  copperegg_probe "ChefProbe2" do
    probe_desc 'ChefProbe2'               # the 'name' of the probe
    probe_dest "http://yoursite.com"      # the URL to test
    type 'GET'                            # the test type; in this case, an HTTP GET request
    stations ['dal','nrk']                # override the defaults and specify testing from Dallas and Fremont
    tags ["production",'load_balancer']   # The tags to apply to this probe
    action :update                        # update will create or updatee
  end

You can find descriptions of all required and optional fields in copperegg/resources/probe.rb.
Refer to the Probe section of the Uptime Cloud Monitor API for further details: Uptime Cloud Monitor Probe API

Creating Annotations in the Uptime Cloud Monitor UI for chef run events.

The Uptime Cloud Monitor Cookbook includes integration with the Chef Report and Exception Handlers. To enable this functionality choose one of the following:

Include the recipe copperegg-handler.rb in your run_list, or
Include the recipe copperegg-handler in your application cookbook with include_recipe.

That's it!

Note:

By default, each chef run will create an annotation at copperegg only when the chef run fails.
You can change this behavior by changing the ['copperegg']['annotate_chefrun_success'] and ['copperegg']['annotate_chefrun_fail'] attributes in the default attributes file or by overriding them in your application cookbook.

License and Author

Authors:: Ross Dickey, Scott Johnson With Contributions from Drew Oliner (https://github.com/Drewzar)

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

CopperEgg / chef-copperegg

readme