Roy Golan has uploaded a new change for review.

Change subject: Documentation: document the mandatory field behavior
......................................................................

Documentation: document the mandatory field behavior

Make it clear how mandatory field absence should be affect the policy.

Change-Id: Iba2f96ec6edca93002dd79ca7c66c4f1ab411141
Bug-Url: https://bugzilla.redhat.com/1143992
Signed-off-by: Roy Golan <rgo...@redhat.com>
---
M mom/Collectors/Collector.py
1 file changed, 5 insertions(+), 0 deletions(-)


  git pull ssh://gerrit.ovirt.org:29418/mom refs/changes/11/35011/1

diff --git a/mom/Collectors/Collector.py b/mom/Collectors/Collector.py
index ed1d7bb..0908918 100644
--- a/mom/Collectors/Collector.py
+++ b/mom/Collectors/Collector.py
@@ -45,6 +45,11 @@
         """
         Used to query the names of mandatory statistics fields that this
         Collector will return.
+        A failure to collect mandatory fields must break the current cycle
+        as the policy expects all fields to return.
+        Collector authors should be aware that new collectors must guarantee
+        the fields to be reported otherwise they must use optional fields.
+        @see #getOptionalFields
         Override this method when creating new collectors.
         Return: A set containing the names of all statistics returned by 
collect()
         """


-- 
To view, visit http://gerrit.ovirt.org/35011
To unsubscribe, visit http://gerrit.ovirt.org/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: Iba2f96ec6edca93002dd79ca7c66c4f1ab411141
Gerrit-PatchSet: 1
Gerrit-Project: mom
Gerrit-Branch: master
Gerrit-Owner: Roy Golan <rgo...@redhat.com>
_______________________________________________
Engine-patches mailing list
Engine-patches@ovirt.org
http://lists.ovirt.org/mailman/listinfo/engine-patches

Reply via email to