feat(tracing): add Span.get_tags and Span.get_metrics (#3402)

Author: majorgreys

ddtrace/span.py

@@ -373,7 +373,7 @@ def get_tag(self, key):
         """Return the given tag or None if it doesn't exist."""
         return self._meta.get(key, None)
 
-    def _get_tags(self):
+    def get_tags(self):
         # type: () -> _MetaDictType
         """Return all tags."""
         return self._meta.copy()
@@ -462,10 +462,12 @@ def set_metrics(self, metrics):
 
     def get_metric(self, key):
         # type: (_TagNameType) -> Optional[NumericType]
+        """Return the given metric or None if it doesn't exist."""
         return self._metrics.get(key)
 
-    def _get_metrics(self):
+    def get_metrics(self):
         # type: () -> _MetricDictType
+        """Return all metrics."""
         return self._metrics.copy()
 
     @remove(message="Use getters for ``Span`` attributes instead.", version="1.0.0")

releasenotes/notes/add-span-get-tags-metrics-7969ba7843dcc24d.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    Add ``Span.get_tags`` and ``Span.get_metrics``.

tests/contrib/aiohttp/test_middleware.py

@@ -76,7 +76,7 @@ async def test_param_handler(app_tracer, aiohttp_client, loop, query_string, tra
     if app[CONFIG_KEY].get("trace_query_string"):
         assert query_string == span.get_tag(http.QUERY_STRING)
     else:
-        assert http.QUERY_STRING not in span._get_tags()
+        assert http.QUERY_STRING not in span.get_tags()
 
 
 async def test_404_handler(app_tracer, aiohttp_client):

tests/contrib/aredis/test_aredis.py

@@ -109,7 +109,7 @@ async def test_meta_override(tracer, test_spans):
     test_spans.assert_trace_count(1)
     test_spans.assert_span_count(1)
     assert test_spans.spans[0].service == "redis"
-    assert "cheese" in test_spans.spans[0]._get_tags() and test_spans.spans[0].get_tag("cheese") == "camembert"
+    assert "cheese" in test_spans.spans[0].get_tags() and test_spans.spans[0].get_tag("cheese") == "camembert"
 
 
 @pytest.mark.asyncio

tests/contrib/bottle/test.py

@@ -71,7 +71,7 @@ def hi(name):
         if ddtrace.config.bottle.trace_query_string:
             assert s.get_tag(http.QUERY_STRING) == query_string
         else:
-            assert http.QUERY_STRING not in s._get_tags()
+            assert http.QUERY_STRING not in s.get_tags()
 
     def test_query_string(self):
         return self.test_200("foo=bar")

tests/contrib/celery/test_utils.py

@@ -32,8 +32,8 @@ def test_tags_from_context(self):
 
         span = Span(None, "test")
         set_tags_from_context(span, context)
-        metas = span._get_tags()
-        metrics = span._get_metrics()
+        metas = span.get_tags()
+        metrics = span.get_metrics()
         sentinel = object()
         assert metas["celery.correlation_id"] == "44b7f305"
         assert metas["celery.delivery_info"] == '{"eager": "True"}'
@@ -56,7 +56,7 @@ def test_tags_from_context_empty_keys(self):
             "timelimit": (None, None),
             "retries": 0,
         }
-        tags = span._get_tags()
+        tags = span.get_tags()
 
         set_tags_from_context(span, context)
         assert {} == tags

tests/contrib/cherrypy/test_middleware.py

@@ -195,7 +195,7 @@ def test_fatal(self):
         assert_span_http_status_code(s, 500)
         assert s.error == 1
         assert s.get_tag(http.METHOD) == "GET"
-        assert "ZeroDivisionError" in s.get_tag(ERROR_TYPE), s._get_tags()
+        assert "ZeroDivisionError" in s.get_tag(ERROR_TYPE), s.get_tags()
         assert "by zero" in s.get_tag(ERROR_MSG)
         assert re.search('File ".*/contrib/cherrypy/web.py", line [0-9]+, in fatal', s.get_tag(ERROR_STACK))
 

tests/contrib/django/test_django.py

@@ -75,7 +75,7 @@ def test_django_v2XX_request_root_span(client, test_spans):
     if django.VERSION >= (2, 2, 0):
         meta["http.route"] = "^$"
 
-    assert http.QUERY_STRING not in root._get_tags()
+    assert http.QUERY_STRING not in root.get_tags()
     root.assert_matches(
         name="django.request",
         service="django",
@@ -116,7 +116,7 @@ def test_django_v2XX_alter_root_resource(client, test_spans):
     if django.VERSION >= (2, 2, 0):
         meta["http.route"] = "^alter-resource/$"
 
-    assert http.QUERY_STRING not in root._get_tags()
+    assert http.QUERY_STRING not in root.get_tags()
     root.assert_matches(
         name="django.request",
         service="django",
@@ -729,7 +729,7 @@ def test_cache_get(test_spans):
         "django.cache.key": "missing_key",
     }
 
-    assert_dict_issuperset(span._get_tags(), expected_meta)
+    assert_dict_issuperset(span.get_tags(), expected_meta)
 
 
 def test_cache_set(test_spans):
@@ -754,7 +754,7 @@ def test_cache_set(test_spans):
         "django.cache.key": "a_new_key",
     }
 
-    assert_dict_issuperset(span._get_tags(), expected_meta)
+    assert_dict_issuperset(span.get_tags(), expected_meta)
 
 
 def test_cache_delete(test_spans):
@@ -778,7 +778,7 @@ def test_cache_delete(test_spans):
         "django.cache.key": "an_existing_key",
     }
 
-    assert_dict_issuperset(span._get_tags(), expected_meta)
+    assert_dict_issuperset(span.get_tags(), expected_meta)
 
 
 @pytest.mark.skipif(django.VERSION >= (2, 1, 0), reason="")
@@ -813,8 +813,8 @@ def test_cache_incr_1XX(test_spans):
         "django.cache.key": "value",
     }
 
-    assert_dict_issuperset(span_get._get_tags(), expected_meta)
-    assert_dict_issuperset(span_incr._get_tags(), expected_meta)
+    assert_dict_issuperset(span_get.get_tags(), expected_meta)
+    assert_dict_issuperset(span_incr.get_tags(), expected_meta)
 
 
 @pytest.mark.skipif(django.VERSION < (2, 1, 0), reason="")
@@ -843,7 +843,7 @@ def test_cache_incr_2XX(test_spans):
         "django.cache.key": "value",
     }
 
-    assert_dict_issuperset(span_incr._get_tags(), expected_meta)
+    assert_dict_issuperset(span_incr.get_tags(), expected_meta)
 
 
 @pytest.mark.skipif(django.VERSION >= (2, 1, 0), reason="")
@@ -884,9 +884,9 @@ def test_cache_decr_1XX(test_spans):
         "django.cache.key": "value",
     }
 
-    assert_dict_issuperset(span_get._get_tags(), expected_meta)
-    assert_dict_issuperset(span_incr._get_tags(), expected_meta)
-    assert_dict_issuperset(span_decr._get_tags(), expected_meta)
+    assert_dict_issuperset(span_get.get_tags(), expected_meta)
+    assert_dict_issuperset(span_incr.get_tags(), expected_meta)
+    assert_dict_issuperset(span_decr.get_tags(), expected_meta)
 
 
 @pytest.mark.skipif(django.VERSION < (2, 1, 0), reason="")
@@ -921,8 +921,8 @@ def test_cache_decr_2XX(test_spans):
         "django.cache.key": "value",
     }
 
-    assert_dict_issuperset(span_incr._get_tags(), expected_meta)
-    assert_dict_issuperset(span_decr._get_tags(), expected_meta)
+    assert_dict_issuperset(span_incr.get_tags(), expected_meta)
+    assert_dict_issuperset(span_decr.get_tags(), expected_meta)
 
 
 def test_cache_get_many(test_spans):
@@ -960,7 +960,7 @@ def test_cache_get_many(test_spans):
         "django.cache.key": str(["missing_key", "another_key"]),
     }
 
-    assert_dict_issuperset(span_get_many._get_tags(), expected_meta)
+    assert_dict_issuperset(span_get_many.get_tags(), expected_meta)
 
 
 def test_cache_set_many(test_spans):
@@ -1081,8 +1081,8 @@ def test_cached_view(client, test_spans):
         "django.cache.key": "views.decorators.cache.cache_header..03cdc1cc4aab71b038a6764e5fcabb82.en-us",
     }
 
-    assert span_view._get_tags() == expected_meta_view
-    assert span_header._get_tags() == expected_meta_header
+    assert span_view.get_tags() == expected_meta_view
+    assert span_header.get_tags() == expected_meta_header
 
 
 @pytest.mark.django_db
@@ -1118,7 +1118,7 @@ def test_cached_template(client, test_spans):
         "django.cache.key": "template.cache.users_list.d41d8cd98f00b204e9800998ecf8427e",
     }
 
-    assert span_template_cache._get_tags() == expected_meta
+    assert span_template_cache.get_tags() == expected_meta
 
 
 """
@@ -1494,7 +1494,7 @@ def test_user_name_excluded(client, test_spans):
 
     # user name should not be present in root span tags
     root = test_spans.get_root_span()
-    assert "django.user.name" not in root._get_tags()
+    assert "django.user.name" not in root.get_tags()
     assert root.get_tag("django.user.is_authenticated") == "True"
 
 
@@ -1772,7 +1772,7 @@ def start_response(status, headers):
         if django.VERSION >= (2, 2, 0):
             meta["http.route"] = "^$"
 
-        assert http.QUERY_STRING not in root._get_tags()
+        assert http.QUERY_STRING not in root.get_tags()
         root.assert_matches(
             name="django.request",
             service="django",

tests/contrib/falcon/test_suite.py

@@ -40,7 +40,7 @@ def test_404(self):
         assert span.resource == "GET 404"
         assert_span_http_status_code(span, 404)
         assert span.get_tag(httpx.URL) == "http://falconframework.org/fake_endpoint"
-        assert httpx.QUERY_STRING not in span._get_tags()
+        assert httpx.QUERY_STRING not in span.get_tags()
         assert span.parent_id is None
         assert span.error == 0
 
@@ -86,7 +86,7 @@ def test_200(self, query_string="", trace_query_string=False):
         if config.falcon.trace_query_string:
             assert span.get_tag(httpx.QUERY_STRING) == query_string
         else:
-            assert httpx.QUERY_STRING not in span._get_tags()
+            assert httpx.QUERY_STRING not in span.get_tags()
         assert span.parent_id is None
         assert span.span_type == "web"
         assert span.error == 0

tests/contrib/flask/test_blueprint.py

@@ -103,7 +103,7 @@ def test():
         self.assertEqual(span.service, "flask")
         self.assertEqual(span.name, "bp.test")
         self.assertEqual(span.resource, "/")
-        self.assertEqual(span._get_tags(), dict())
+        self.assertEqual(span.get_tags(), dict())
 
     def test_blueprint_request_pin_override(self):
         """
@@ -130,7 +130,7 @@ def test():
         self.assertEqual(span.service, "flask-bp")
         self.assertEqual(span.name, "bp.test")
         self.assertEqual(span.resource, "/")
-        self.assertEqual(span._get_tags(), dict())
+        self.assertEqual(span.get_tags(), dict())
 
     def test_blueprint_request_pin_disabled(self):
         """