From debfca884bc7a1619fbf86488f84d402e6310169 Mon Sep 17 00:00:00 2001
From: Michele Tartara <mtartara@google.com>
Date: Thu, 7 Mar 2013 18:36:42 +0100
Subject: [PATCH] Change format of the empty status message
Having 'null' instead of an empty string for an empty status message
increases the complexity of the code with no real improvement.
This patch modifies the monitoring agent design document solving this issue.
Signed-off-by: Michele Tartara <mtartara@google.com>
Reviewed-by: Bernardo Dal Seno <bdalseno@google.com>
---
doc/design-monitoring-agent.rst | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/doc/design-monitoring-agent.rst b/doc/design-monitoring-agent.rst
index 8bcec6fcf..13702f53b 100644
--- a/doc/design-monitoring-agent.rst
+++ b/doc/design-monitoring-agent.rst
@@ -197,8 +197,9 @@ in its ``data`` section, at least the following field:
A message to better explain the reason of the status.
The exact format of the message string is data collector dependent.
- The field is mandatory, but the content can be ``null`` if the code is
- ``0`` (working as intended) or ``1`` (being fixed automatically).
+ The field is mandatory, but the content can be an empty string if the
+ ``code`` is ``0`` (working as intended) or ``1`` (being fixed
+ automatically).
If the status code is ``2``, the message should specify what has gone
wrong.
--
GitLab