Remove unnecessary warning when (not) setting status description (open-telemetry#1721)

owais · web-flow · commit 0c0466e4cd2c · 2021-04-02T08:17:00.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Adjust `B3Format` propagator to be spec compliant by not modifying context
   when propagation headers are not present/invalid/empty
   ([#1728](https://github.com/open-telemetry/opentelemetry-python/pull/1728))
+- Silence unnecessary warning when creating a new Status object without description.
+  ([#1721](https://github.com/open-telemetry/opentelemetry-python/pull/1721))
 - Update bootstrap cmd to use exact version when installing instrumentation packages. 
   ([#1722](https://github.com/open-telemetry/opentelemetry-python/pull/1722))
 
diff --git a/opentelemetry-api/src/opentelemetry/trace/status.py b/opentelemetry-api/src/opentelemetry/trace/status.py
@@ -49,15 +49,15 @@ def __init__(
         self._status_code = status_code
         self._description = None
 
-        if description is not None and not isinstance(description, str):
-            logger.warning("Invalid status description type, expected str")
-            return
-
-        if status_code is not StatusCode.ERROR:
-            logger.warning(
-                "description should only be set when status_code is set to StatusCode.ERROR"
-            )
-            return
+        if description:
+            if not isinstance(description, str):
+                logger.warning("Invalid status description type, expected str")
+                return
+            if status_code is not StatusCode.ERROR:
+                logger.warning(
+                    "description should only be set when status_code is set to StatusCode.ERROR"
+                )
+                return
 
         self._description = description
 
diff --git a/opentelemetry-api/tests/trace/test_status.py b/opentelemetry-api/tests/trace/test_status.py
@@ -30,8 +30,8 @@ def test_constructor(self):
 
     def test_invalid_description(self):
         with self.assertLogs(level=WARNING) as warning:
-            status = Status(description={"test": "val"})  # type: ignore
-            self.assertIs(status.status_code, StatusCode.UNSET)
+            status = Status(status_code=StatusCode.ERROR, description={"test": "val"})  # type: ignore
+            self.assertIs(status.status_code, StatusCode.ERROR)
             self.assertEqual(status.description, None)
             self.assertIn(
                 "Invalid status description type, expected str",
