From fa52620edeed0b7ab58fb575b7a0af03ecdebf17 Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Tue, 29 Oct 2019 16:35:01 +0100 Subject: [PATCH 1/3] Add changelog entry for changes in https://github.com/StackStorm/st2/pull/4803. --- docs/source/upgrade_notes.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/source/upgrade_notes.rst b/docs/source/upgrade_notes.rst index fded5067b..f98d0a88d 100644 --- a/docs/source/upgrade_notes.rst +++ b/docs/source/upgrade_notes.rst @@ -3,6 +3,28 @@ Upgrade Notes ============= +.. _ref-upgrade-notes-v3-2: + +|st2| v3.2 +---------- + +* We have switched from unbuffered to fully buffered output for Python runner actions. This should + result in better performance and smaller CPU utilization for actions which produce a lot of + output. + + If you experience issues with some Python runner actions hanging our the real time action output + is slower / less real-time than before, you can set ``actionrunner.stream_output_buffer_size`` + config option to ``-1`` and restart st2actionrunner processes (``sudo st2ctl restart-service + st2actionrunner``). + + This will switch back to the unbuffered output. + + This config directly controls ``bufsize`` argument which is passed to + ``st2common.util.green.shell.run_command()`` function so you can also + experiment with other values which are supported by Python + ``subprocess.Popen`` (https://docs.python.org/2/library/subprocess.html#popen-constructor) + function. + .. _ref-upgrade-notes-v3-0: |st2| v3.0 From a22572279fe83de1d18478d03e5c7589882c6fdc Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Tue, 29 Oct 2019 16:40:02 +0100 Subject: [PATCH 2/3] Fix typo. --- docs/source/upgrade_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/upgrade_notes.rst b/docs/source/upgrade_notes.rst index f98d0a88d..bb5655097 100644 --- a/docs/source/upgrade_notes.rst +++ b/docs/source/upgrade_notes.rst @@ -14,7 +14,7 @@ Upgrade Notes If you experience issues with some Python runner actions hanging our the real time action output is slower / less real-time than before, you can set ``actionrunner.stream_output_buffer_size`` - config option to ``-1`` and restart st2actionrunner processes (``sudo st2ctl restart-service + config option to ``-1`` and restart st2actionrunner processes (``sudo st2ctl restart-component st2actionrunner``). This will switch back to the unbuffered output. From c0a2586a96bacf2402fb86f59eb9a3e2f412025d Mon Sep 17 00:00:00 2001 From: Tomaz Muraus Date: Wed, 30 Oct 2019 16:39:17 +0100 Subject: [PATCH 3/3] Fix typo. --- docs/source/upgrade_notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/upgrade_notes.rst b/docs/source/upgrade_notes.rst index bb5655097..3e5951c29 100644 --- a/docs/source/upgrade_notes.rst +++ b/docs/source/upgrade_notes.rst @@ -12,7 +12,7 @@ Upgrade Notes result in better performance and smaller CPU utilization for actions which produce a lot of output. - If you experience issues with some Python runner actions hanging our the real time action output + If you experience issues with some Python runner actions hanging out the real time action output is slower / less real-time than before, you can set ``actionrunner.stream_output_buffer_size`` config option to ``-1`` and restart st2actionrunner processes (``sudo st2ctl restart-component st2actionrunner``).