Helper to handle exception message #2305

dhivyaganesan · 2021-07-14T22:27:13Z

New function in textutil class to format exception message.
All the traceback now uses traceback.format_exc()

Issue #

PR information

The title of the PR is clear and informative.
There are a small number of commits, each of which has an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
If applicable, the PR references the bug/issue that it fixes in the description.
New Unit tests were added for the changes made

Quality of Code and Contribution Guidelines

I have read the contribution guidelines.

… helper-to-handle-exception

codecov · 2021-07-14T22:30:58Z

Codecov Report

Merging #2305 (e2eb2bc) into develop (f6e384e) will increase coverage by 0.03%.
The diff coverage is 68.18%.

@@             Coverage Diff             @@
##           develop    #2305      +/-   ##
===========================================
+ Coverage    70.69%   70.72%   +0.03%     
===========================================
  Files           96       96              
  Lines        13953    13952       -1     
  Branches      2001     2001              
===========================================
+ Hits          9864     9868       +4     
+ Misses        3648     3645       -3     
+ Partials       441      439       -2

Impacted Files	Coverage Δ
azurelinuxagent/common/event.py	`85.22% <ø> (ø)`
azurelinuxagent/ga/exthandlers.py	`86.16% <22.22%> (+0.22%)`	⬆️
azurelinuxagent/agent.py	`58.20% <50.00%> (-0.17%)`	⬇️
azurelinuxagent/common/persist_firewall_rules.py	`76.92% <50.00%> (-0.14%)`	⬇️
azurelinuxagent/common/protocol/wire.py	`78.75% <50.00%> (-0.03%)`	⬇️
azurelinuxagent/common/utils/textutil.py	`62.50% <63.63%> (+0.05%)`	⬆️
azurelinuxagent/common/utils/restutil.py	`85.04% <100.00%> (-0.05%)`	⬇️
azurelinuxagent/daemon/main.py	`70.00% <100.00%> (ø)`
azurelinuxagent/ga/collect_telemetry_events.py	`91.43% <100.00%> (+1.71%)`	⬆️
azurelinuxagent/ga/remoteaccess.py	`89.47% <100.00%> (ø)`
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f6e384e...e2eb2bc. Read the comment docs.

narrieta · 2021-07-14T23:33:46Z

azurelinuxagent/common/event.py

@@ -320,7 +320,7 @@ def report_dropped_events_error(count, errors, operation_name):
    def _update_errors_and_get_count(error_count, errors, error):
        error_count += 1
        if len(errors) < CollectOrReportEventDebugInfo.__MAX_ERRORS_TO_REPORT:
-            errors.add("{0}: {1}".format(ustr(error), traceback.format_exc()))
+            errors.add("{0}: {1}".format(ustr(error), textutil.format_exception()))


I think textutil.format_exception should take the exception as parameter, otherwise we have an (implicit) requirement that is must be called within an exception handler and in some case, as this one, that is not clear/enforced in the code.

kevinclark19a

Overall, looks good. Would like to see the exception be parameterized like @narrieta said, but I'm fine other than that.

narrieta · 2021-07-19T19:43:34Z

azurelinuxagent/common/utils/textutil.py

+
+
+def format_exception(exception):
+    # Placeholder function to format exception message


minor: remove "Placeholder" from comment

narrieta · 2021-07-19T19:47:07Z

azurelinuxagent/ga/collect_telemetry_events.py

@@ -116,8 +116,8 @@ def _operation(self):
            # the telemetry service comes back up
            delete_all_event_files = False
        except Exception as error:
-            msg = "Unknown error occurred when trying to collect extension events. Error: {0}, Stack: {1}".format(
-                ustr(error), traceback.format_exc())
+            msg = "Unknown error occurred when trying to collect extension events.:\n{0}".format(


"...extension events: {0}" (remove '.' and '\n')

narrieta · 2021-07-19T19:48:13Z

azurelinuxagent/ga/collect_telemetry_events.py

@@ -204,8 +204,8 @@ def _capture_extension_events(self, handler_name, handler_event_dir_path):
                    # This is a trade-off between data replication vs data loss.
                    raise
                except Exception as error:
-                    msg = "Failed to process event file {0}: {1}, {2}".format(event_file, ustr(error),
-                                                                              traceback.format_exc())
+                    msg = "Failed to process event file {0}: \n, {1}".format(event_file,


I don't think we need these extra \n. The message should display on the same line. as in the previous code.

narrieta · 2021-07-19T19:49:03Z

azurelinuxagent/ga/send_telemetry_events.py

@@ -135,8 +135,8 @@ def _process_telemetry_thread(self):
                    self._send_events_in_queue(first_event)

        except Exception as error:
-            err_msg = "An unknown error occurred in the {0} thread main loop, stopping thread. Error: {1}, Stack: {2}".format(
-                self.get_thread_name(), ustr(error), traceback.format_exc())
+            err_msg = "An unknown error occurred in the {0} thread main loop, stopping thread.\n {1}".format(


narrieta · 2021-07-19T19:49:24Z

azurelinuxagent/ga/exthandlers.py

@@ -351,7 +342,7 @@ def goal_state_debug_info(duration=None):
            self.__process_and_handle_extensions(etag)
            self._cleanup_outdated_handlers()
        except Exception as error:
-            error = u"ProcessExtensionsInGoalState - Exception processing extension handlers: {0}\n{1}".format(ustr(error), traceback.extract_tb(get_traceback(error)))
+            error = u"ProcessExtensionsInGoalState - Exception processing extension handlers:\n {0}".format(textutil.format_exception(error))


narrieta · 2021-07-19T19:49:45Z

azurelinuxagent/common/protocol/wire.py

@@ -1207,7 +1206,7 @@ def _send_event(provider_id, debug_info):
                events_per_provider[event.providerId] += 1

            except Exception as error:
-                logger.warn("Unexpected error when generating Events: {0}, {1}", ustr(error), traceback.format_exc())
+                logger.warn("Unexpected error when generating Events:\n {0}", textutil.format_exception(error))


narrieta · 2021-07-19T19:49:57Z

azurelinuxagent/common/protocol/wire.py

@@ -808,7 +807,7 @@ def try_update_goal_state(self):
                self._last_try_update_goal_state_failed = True
                message = u"An error occurred while retrieving the goal state: {0}".format(ustr(e))
                add_event(AGENT_NAME, op=WALAEventOperation.FetchGoalState, version=CURRENT_VERSION, is_success=False, message=message, log_event=False)
-                message = u"An error occurred while retrieving the goal state: {0}".format(ustr(traceback.format_exc()))
+                message = u"An error occurred while retrieving the goal state:\n {0}".format(textutil.format_exception(e))


dhivyaganesan and others added 4 commits July 14, 2021 13:13

Created a helper function to format exceptions

3c5bdc8

Merge branch 'Azure:develop' into helper-to-handle-exception

e81850c

Fixed Pylint error

d8890fc

Merge remote-tracking branch 'origin/helper-to-handle-exception' into…

bae126a

… helper-to-handle-exception

dhivyaganesan requested review from ZhidongPeng, narrieta, kevinclark19a, larohra and nagworld9 July 14, 2021 22:27

narrieta reviewed Jul 14, 2021

View reviewed changes

kevinclark19a reviewed Jul 15, 2021

View reviewed changes

dhivyaganesan added 5 commits July 16, 2021 11:08

Updated the format_exception function to accept exception as a parameter

06ef0a7

Removed logger

a786281

Fixed Pylint error

011cc2f

Fixed logging and updated logic to process exceptions

a24056d

Fixed logging and updated logic to process exceptions

5478638

narrieta reviewed Jul 19, 2021

View reviewed changes

dhivyaganesan added 2 commits July 19, 2021 13:22

Fixed minor PR comments

e83d335

Fixed minor PR comments

e2eb2bc

narrieta approved these changes Jul 19, 2021

View reviewed changes

kevinclark19a approved these changes Jul 19, 2021

View reviewed changes

dhivyaganesan merged commit f6699cd into Azure:develop Jul 19, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Helper to handle exception message #2305

Helper to handle exception message #2305

dhivyaganesan commented Jul 14, 2021

codecov bot commented Jul 14, 2021 •

edited

Loading

narrieta Jul 14, 2021

kevinclark19a left a comment

narrieta Jul 19, 2021

narrieta Jul 19, 2021

narrieta Jul 19, 2021

narrieta Jul 19, 2021

narrieta Jul 19, 2021

narrieta Jul 19, 2021

narrieta Jul 19, 2021



		def format_exception(exception):
		# Placeholder function to format exception message

Helper to handle exception message #2305

Helper to handle exception message #2305

Conversation

dhivyaganesan commented Jul 14, 2021

PR information

Quality of Code and Contribution Guidelines

codecov bot commented Jul 14, 2021 • edited Loading

Codecov Report

Choose a reason for hiding this comment

kevinclark19a left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jul 14, 2021 •

edited

Loading