From c8d3f99be84a4a04074a94c451387932bd086b26 Mon Sep 17 00:00:00 2001 From: Mike Russell Date: Wed, 16 Jun 2021 05:51:00 -0700 Subject: Small Doc Update for ReportEventStack and Test (#920) - small document update for ReportEventStack explaining post_files parameter - small unit test for test_reporting demonstrating the close of an event with optional post_files list --- cloudinit/reporting/events.py | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'cloudinit') diff --git a/cloudinit/reporting/events.py b/cloudinit/reporting/events.py index b8677c8b..9afad747 100644 --- a/cloudinit/reporting/events.py +++ b/cloudinit/reporting/events.py @@ -165,7 +165,15 @@ class ReportEventStack(object): :param result_on_exception: The result value to set if an exception is caught. default value is FAIL. + + :param post_files: + Can hold filepaths of files that are to get posted/created + regarding a given event. Something like success or failure information + in a given log file. For each filepath, if it's a valid regular file + it will get: read & encoded as base64 at the close of the event. + Default value, if None, is an empty list. """ + def __init__(self, name, description, message=None, parent=None, reporting_enabled=None, result_on_exception=status.FAIL, post_files=None): -- cgit v1.2.3