From 519c6ac8eeeed9d2438c1cc705fbf49f0ad75fdf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9na=C3=AFc=20Huard?= Date: Mon, 22 Jun 2015 17:16:07 +0200 Subject: Add a --profile option to spot which task takes more time --- ansible-profile/LICENSE | 20 +++++++++ ansible-profile/README.rst | 34 ++++++++++++++++ ansible-profile/callback_plugins/profile_tasks.py | 49 +++++++++++++++++++++++ 3 files changed, 103 insertions(+) create mode 100644 ansible-profile/LICENSE create mode 100644 ansible-profile/README.rst create mode 100644 ansible-profile/callback_plugins/profile_tasks.py (limited to 'ansible-profile') diff --git a/ansible-profile/LICENSE b/ansible-profile/LICENSE new file mode 100644 index 000000000..1c0495384 --- /dev/null +++ b/ansible-profile/LICENSE @@ -0,0 +1,20 @@ +The MIT License (MIT) + +Copyright (c) 2014 Jharrod LaFon + +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 NONINFRINGEMENT. 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. diff --git a/ansible-profile/README.rst b/ansible-profile/README.rst new file mode 100644 index 000000000..5c2e9069f --- /dev/null +++ b/ansible-profile/README.rst @@ -0,0 +1,34 @@ +=============== +ansible-profile +=============== + +An Ansible plugin for timing tasks. + + +Usage +^^^^^ + +Make a directory called `callback_plugins` next to your playbook and put `profile_tasks.py` inside of it. + +.. code-block:: bash + + mkdir callback_plugins + cd callback_plugins + wget https://raw.githubusercontent.com/jlafon/ansible-profile/master/callback_plugins/profile_tasks.py + +Now, run your playbook just as you normally would! + +.. code-block:: bash + + ansible + + PLAY RECAP ******************************************************************** + really slow task | Download project packages-----------------------------11.61s + security | Really slow security policies-----------------------------------7.03s + common-base | Install core system dependencies-----------------------------3.62s + common | Install pip-------------------------------------------------------3.60s + common | Install boto------------------------------------------------------3.57s + nginx | Install nginx------------------------------------------------------3.41s + serf | Install system dependencies-----------------------------------------3.38s + duo_security | Install Duo Unix SSH Integration----------------------------3.37s + loggly | Install TLS version-----------------------------------------------3.36s diff --git a/ansible-profile/callback_plugins/profile_tasks.py b/ansible-profile/callback_plugins/profile_tasks.py new file mode 100644 index 000000000..dc74ee291 --- /dev/null +++ b/ansible-profile/callback_plugins/profile_tasks.py @@ -0,0 +1,49 @@ +import time + + +class CallbackModule(object): + """ + A plugin for timing tasks + """ + def __init__(self): + self.stats = {} + self.current = None + + def playbook_on_task_start(self, name, is_conditional): + """ + Logs the start of each task + """ + if self.current is not None: + # Record the running time of the last executed task + self.stats[self.current] = time.time() - self.stats[self.current] + + # Record the start time of the current task + self.current = name + self.stats[self.current] = time.time() + + def playbook_on_stats(self, stats): + """ + Prints the timings + """ + # Record the timing of the very last task + if self.current is not None: + self.stats[self.current] = time.time() - self.stats[self.current] + + # Sort the tasks by their running time + results = sorted( + self.stats.items(), + key=lambda value: value[1], + reverse=True, + ) + + # Just keep the top 10 + results = results[:10] + + # Print the timings + for name, elapsed in results: + print( + "{0:-<70}{1:->9}".format( + '{0} '.format(name), + ' {0:.02f}s'.format(elapsed), + ) + ) -- cgit v1.2.3 From 10f59cf0dd4c89ead7244d61f0e91e5a43183cd0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9na=C3=AFc=20Huard?= Date: Thu, 25 Jun 2015 11:57:26 +0200 Subject: Put the license inside the source file and add pylint ignore statement for what the Ansible API imposes --- ansible-profile/LICENSE | 20 ------------- ansible-profile/README.rst | 34 ----------------------- ansible-profile/callback_plugins/profile_tasks.py | 34 +++++++++++++++++++++++ 3 files changed, 34 insertions(+), 54 deletions(-) delete mode 100644 ansible-profile/LICENSE delete mode 100644 ansible-profile/README.rst (limited to 'ansible-profile') diff --git a/ansible-profile/LICENSE b/ansible-profile/LICENSE deleted file mode 100644 index 1c0495384..000000000 --- a/ansible-profile/LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2014 Jharrod LaFon - -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 NONINFRINGEMENT. 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. diff --git a/ansible-profile/README.rst b/ansible-profile/README.rst deleted file mode 100644 index 5c2e9069f..000000000 --- a/ansible-profile/README.rst +++ /dev/null @@ -1,34 +0,0 @@ -=============== -ansible-profile -=============== - -An Ansible plugin for timing tasks. - - -Usage -^^^^^ - -Make a directory called `callback_plugins` next to your playbook and put `profile_tasks.py` inside of it. - -.. code-block:: bash - - mkdir callback_plugins - cd callback_plugins - wget https://raw.githubusercontent.com/jlafon/ansible-profile/master/callback_plugins/profile_tasks.py - -Now, run your playbook just as you normally would! - -.. code-block:: bash - - ansible - - PLAY RECAP ******************************************************************** - really slow task | Download project packages-----------------------------11.61s - security | Really slow security policies-----------------------------------7.03s - common-base | Install core system dependencies-----------------------------3.62s - common | Install pip-------------------------------------------------------3.60s - common | Install boto------------------------------------------------------3.57s - nginx | Install nginx------------------------------------------------------3.41s - serf | Install system dependencies-----------------------------------------3.38s - duo_security | Install Duo Unix SSH Integration----------------------------3.37s - loggly | Install TLS version-----------------------------------------------3.36s diff --git a/ansible-profile/callback_plugins/profile_tasks.py b/ansible-profile/callback_plugins/profile_tasks.py index dc74ee291..e9728a803 100644 --- a/ansible-profile/callback_plugins/profile_tasks.py +++ b/ansible-profile/callback_plugins/profile_tasks.py @@ -1,3 +1,31 @@ +# The MIT License (MIT) + +# Copyright (c) 2014 Jharrod LaFon + +# 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 NONINFRINGEMENT. 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. + +''' +A plugin for timing tasks + +This plugin records the time spent in each task. +At the end of the playbook, it displays the time spent in the 10 slowest tasks. +''' + import time @@ -9,6 +37,9 @@ class CallbackModule(object): self.stats = {} self.current = None + # Reason: The is_conditional parameter is part of the Ansible plugin API + # Status: permanently disabled + # pylint: disable=unused-argument def playbook_on_task_start(self, name, is_conditional): """ Logs the start of each task @@ -21,6 +52,9 @@ class CallbackModule(object): self.current = name self.stats[self.current] = time.time() + # Reason: The stats parameter is part of the Ansible plugin API + # Status: permanently disabled + # pylint: disable=unused-argument def playbook_on_stats(self, stats): """ Prints the timings -- cgit v1.2.3 From 1bab4edd3d8cd3201bf210312f18fc9841c339d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9na=C3=AFc=20Huard?= Date: Fri, 3 Jul 2015 15:03:32 +0200 Subject: Add README file to link to the upstream ansible-profile --- ansible-profile/README.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 ansible-profile/README.md (limited to 'ansible-profile') diff --git a/ansible-profile/README.md b/ansible-profile/README.md new file mode 100644 index 000000000..4f10817d4 --- /dev/null +++ b/ansible-profile/README.md @@ -0,0 +1,6 @@ +# Ansible profile + +This is a callback plugin for timing tasks. + +The upstream project lies in: +https://github.com/jlafon/ansible-profile -- cgit v1.2.3