poreted log_plays, syslog_json and osx_say callbacks to v2

renamed plugins to contrib (they are not really plugins)
rewrote README.md to reflect new usage
added new dir to setup.py so it gets copied with installation, in views
of making using inventory scripts easier in teh future

lib/ansible/plugins/callback/log_plays.py

@@ -0,0 +1,85 @@
+# (C) 2012, Michael DeHaan, <michael.dehaan@gmail.com>
+
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+import os
+import time
+import json
+
+from ansible.plugins.callback import CallbackBase
+
+# NOTE: in Ansible 1.2 or later general logging is available without
+# this plugin, just set ANSIBLE_LOG_PATH as an environment variable
+# or log_path in the DEFAULTS section of your ansible configuration
+# file.  This callback is an example of per hosts logging for those
+# that want it.
+
+
+class CallbackModule(CallbackBase):
+    """
+    logs playbook results, per host, in /var/log/ansible/hosts
+    """
+    CALLBACK_VERSION = 2.0
+    CALLBACK_TYPE = 'notification'
+
+    TIME_FORMAT="%b %d %Y %H:%M:%S"
+    MSG_FORMAT="%(now)s - %(category)s - %(data)s\n\n"
+
+    def __init__(self, display):
+
+        super(CallbackModule, self).__init__(display)
+
+        if not os.path.exists("/var/log/ansible/hosts"):
+            os.makedirs("/var/log/ansible/hosts")
+
+    def log(self, host, category, data):
+        if type(data) == dict:
+            if 'verbose_override' in data:
+                # avoid logging extraneous data from facts
+                data = 'omitted'
+            else:
+                data = data.copy()
+                invocation = data.pop('invocation', None)
+                data = json.dumps(data)
+                if invocation is not None:
+                    data = json.dumps(invocation) + " => %s " % data
+
+        path = os.path.join("/var/log/ansible/hosts", host)
+        now = time.strftime(self.TIME_FORMAT, time.localtime())
+        fd = open(path, "a")
+        fd.write(self.MSG_FORMAT % dict(now=now, category=category, data=data))
+        fd.close()
+
+    def runner_on_failed(self, host, res, ignore_errors=False):
+        self.log(host, 'FAILED', res)
+
+    def runner_on_ok(self, host, res):
+        self.log(host, 'OK', res)
+
+    def runner_on_skipped(self, host, item=None):
+        self.log(host, 'SKIPPED', '...')
+
+    def runner_on_unreachable(self, host, res):
+        self.log(host, 'UNREACHABLE', res)
+
+    def runner_on_async_failed(self, host, res, jid):
+        self.log(host, 'ASYNC_FAILED', res)
+
+    def playbook_on_import_for_host(self, host, imported_file):
+        self.log(host, 'IMPORTED', imported_file)
+
+    def playbook_on_not_import_for_host(self, host, missing_file):
+        self.log(host, 'NOTIMPORTED', missing_file)

lib/ansible/plugins/callback/osx_say.py

@@ -0,0 +1,87 @@
+
+# (C) 2012, Michael DeHaan, <michael.dehaan@gmail.com>
+
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+import subprocess
+import os
+
+from ansible.plugins.callback import CallbackBase
+
+FAILED_VOICE="Zarvox"
+REGULAR_VOICE="Trinoids"
+HAPPY_VOICE="Cellos"
+LASER_VOICE="Princess"
+SAY_CMD="/usr/bin/say"
+
+class CallbackModule(CallbackBase):
+    """
+    makes Ansible much more exciting on OS X.
+    """
+    CALLBACK_VERSION = 2.0
+    CALLBACK_TYPE = 'notification'
+
+    def __init__(self, display):
+
+        super(CallbackModule, self).__init__(display)
+
+        # plugin disable itself if say is not present
+        # ansible will not call any callback if disabled is set to True
+        if not os.path.exists(SAY_CMD):
+            self.disabled = True
+            self._display.warning("%s does not exist, plugin %s disabled" % (SAY_CMD, os.path.basename(__file__)) )
+
+    def say(self, msg, voice):
+        subprocess.call([SAY_CMD, msg, "--voice=%s" % (voice)])
+
+    def runner_on_failed(self, host, res, ignore_errors=False):
+        self.say("Failure on host %s" % host, FAILED_VOICE)
+
+    def runner_on_ok(self, host, res):
+        self.say("pew", LASER_VOICE)
+
+    def runner_on_skipped(self, host, item=None):
+        self.say("pew", LASER_VOICE)
+
+    def runner_on_unreachable(self, host, res):
+        self.say("Failure on host %s" % host, FAILED_VOICE)
+
+    def runner_on_async_ok(self, host, res, jid):
+        self.say("pew", LASER_VOICE)
+
+    def runner_on_async_failed(self, host, res, jid):
+        self.say("Failure on host %s" % host, FAILED_VOICE)
+
+    def playbook_on_start(self):
+        self.say("Running Playbook", REGULAR_VOICE)
+
+    def playbook_on_notify(self, host, handler):
+        self.say("pew", LASER_VOICE)
+
+    def playbook_on_task_start(self, name, is_conditional):
+        if not is_conditional:
+            self.say("Starting task: %s" % name, REGULAR_VOICE)
+        else:
+            self.say("Notifying task: %s" % name, REGULAR_VOICE)
+
+    def playbook_on_setup(self):
+        self.say("Gathering facts", REGULAR_VOICE)
+
+    def playbook_on_play_start(self, name):
+        self.say("Starting play: %s" % name, HAPPY_VOICE)
+
+    def playbook_on_stats(self, stats):
+        self.say("Play complete", HAPPY_VOICE)

lib/ansible/plugins/callback/syslog_json.py

@@ -0,0 +1,60 @@
+import os
+import json
+
+import logging
+import logging.handlers
+
+import socket
+
+from ansible.plugins.callback import CallbackBase
+
+class CallbackModule(CallbackBase):
+    """
+    logs ansible-playbook and ansible runs to a syslog server in json format
+    make sure you have in ansible.cfg:
+        callback_plugins   = <path_to_callback_plugins_folder>
+    and put the plugin in <path_to_callback_plugins_folder>
+    
+    This plugin makes use of the following environment variables:
+        SYSLOG_SERVER   (optional): defaults to localhost
+        SYSLOG_PORT     (optional): defaults to 514
+    """
+    CALLBACK_VERSION = 2.0
+    CALLBACK_TYPE = 'aggregate'
+
+    def __init__(self, display):
+
+        super(CallbackModule, self).__init__(display)
+
+        self.logger =  logging.getLogger('ansible logger')
+        self.logger.setLevel(logging.DEBUG)
+
+        self.handler = logging.handlers.SysLogHandler(
+            address = (os.getenv('SYSLOG_SERVER','localhost'),
+                       os.getenv('SYSLOG_PORT',514)), 
+            facility=logging.handlers.SysLogHandler.LOG_USER
+        )
+        self.logger.addHandler(self.handler)
+        self.hostname = socket.gethostname()
+
+
+    def runner_on_failed(self, host, res, ignore_errors=False):
+        self.logger.error('%s ansible-command: task execution FAILED; host: %s; message: %s' % (self.hostname,host,json.dumps(res, sort_keys=True)))
+
+    def runner_on_ok(self, host, res):
+        self.logger.info('%s ansible-command: task execution OK; host: %s; message: %s' % (self.hostname,host,json.dumps(res, sort_keys=True)))
+
+    def runner_on_skipped(self, host, item=None):
+        self.logger.info('%s ansible-command: task execution SKIPPED; host: %s; message: %s' % (self.hostname,host,json.dumps(res, sort_keys=True)))
+
+    def runner_on_unreachable(self, host, res):
+        self.logger.error('%s ansible-command: task execution UNREACHABLE; host: %s; message: %s' % (self.hostname,host,json.dumps(res, sort_keys=True)))
+
+    def runner_on_async_failed(self, host, res):
+        self.logger.error('%s ansible-command: task execution FAILED; host: %s; message: %s' % (self.hostname,host,json.dumps(res, sort_keys=True)))
+
+    def playbook_on_import_for_host(self, host, imported_file):
+        self.logger.info('%s ansible-command: playbook IMPORTED; host: %s; message: %s' % (self.hostname,host,json.dumps(res, sort_keys=True)))
+
+    def playbook_on_not_import_for_host(self, host, missing_file):
+        self.logger.info('%s ansible-command: playbook NOT IMPORTED; host: %s; message: %s' % (self.hostname,host,json.dumps(res, sort_keys=True)))