fix: use unique unnamed service name value [backport 2.0] (#7441)

Backport f86ac69 from #7414 to 2.0.

In some places, a literal string was being used when a service name is
not provided via the configuration interface. This value however
differed from the DEFAULT_SERVICE_NAME constant, resulting in multiple
service names being used in different parts of the library. This change
ensures that only one default service name is used across the library.

## Checklist

- [x] Change(s) are motivated and described in the PR description.
- [x] Testing strategy is described if automated tests are not included
in the PR.
- [x] Risk is outlined (performance impact, potential for breakage,
maintainability, etc).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] [Library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
are followed. If no release note is required, add label
`changelog/no-changelog`.
- [x] Documentation is included (in-code, generated user docs, [public
corp docs](https://github.com/DataDog/documentation/)).
- [x] Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist

- [x] Title is accurate.
- [x] No unnecessary changes are introduced.
- [x] Description motivates each change.
- [x] Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes unless absolutely necessary.
- [x] Testing strategy adequately addresses listed risk(s).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] Release note makes sense to a user of the library.
- [x] Reviewer has explicitly acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment.
- [x] Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
- [x] If this PR touches code that signs or publishes builds or
packages, or handles credentials of any kind, I've requested a review
from `@DataDog/security-design-and-guidance`.
- [x] This PR doesn't touch any of that.

Co-authored-by: Gabriele N. Tornetta <[email protected]>

Author: github-actions[bot]

ddtrace/internal/constants.py

@@ -23,7 +23,7 @@
 W3C_TRACESTATE_SAMPLING_PRIORITY_KEY = "s"
 DEFAULT_SAMPLING_RATE_LIMIT = 100
 SAMPLING_DECISION_TRACE_TAG_KEY = "_dd.p.dm"
-DEFAULT_SERVICE_NAME = "unnamed_python_service"
+DEFAULT_SERVICE_NAME = "unnamed-python-service"
 # Used to set the name of an integration on a span
 COMPONENT = "component"
 HIGHER_ORDER_TRACE_ID_BITS = "_dd.p.tid"

ddtrace/internal/datastreams/processor.py

@@ -22,6 +22,7 @@
 import ddtrace
 from ddtrace import config
 from ddtrace.internal.atexit import register_on_exit_signal
+from ddtrace.internal.constants import DEFAULT_SERVICE_NAME
 from ddtrace.internal.utils.retry import fibonacci_backoff_with_jitter
 
 from .._encoding import packb
@@ -128,7 +129,7 @@ def __init__(self, agent_url, interval=None, timeout=1.0, retry_attempts=3):
             "Content-Encoding": "gzip",
         }  # type: Dict[str, str]
         self._hostname = six.ensure_text(get_hostname())
-        self._service = six.ensure_text(config._get_service("unnamed-python-service"))
+        self._service = six.ensure_text(config._get_service(DEFAULT_SERVICE_NAME))
         self._lock = Lock()
         self._current_context = threading.local()
         self._enabled = True
@@ -361,7 +362,7 @@ def __init__(self, processor, hash_value, pathway_start_sec, current_edge_start_
         self.pathway_start_sec = pathway_start_sec
         self.current_edge_start_sec = current_edge_start_sec
         self.hash = hash_value
-        self.service = six.ensure_text(config._get_service("unnamed-python-service"))
+        self.service = six.ensure_text(config._get_service(DEFAULT_SERVICE_NAME))
         self.env = six.ensure_text(config.env or "none")
         # loop detection logic
         self.previous_direction = ""

ddtrace/internal/schema/span_attribute_schema.py

@@ -1,5 +1,7 @@
 from enum import Enum
 
+from ddtrace.internal.constants import DEFAULT_SERVICE_NAME
+
 
 class SpanDirection(Enum):
     INBOUND = "inbound"
@@ -110,4 +112,4 @@ def url_operation_v1(v0_operation, protocol=None, direction=None):
 }
 
 
-_DEFAULT_SPAN_SERVICE_NAMES = {"v0": None, "v1": "unnamed-python-service"}
+_DEFAULT_SPAN_SERVICE_NAMES = {"v0": None, "v1": DEFAULT_SERVICE_NAME}

releasenotes/notes/fix-default-unnamed-service-name-500026e5a134bc54.yaml

@@ -0,0 +1,5 @@
+---
+fixes:
+  - |
+    Use a unique default service name across all the products provided by the
+    library when one is not given via the configuration interface.

tests/internal/service_name/test_imports.py

@@ -50,6 +50,7 @@ def test_service_names_import_and_v0():
     parametrize={"DD_TRACE_REMOVE_INTEGRATION_SERVICE_NAMES_ENABLED": ["False", "True"]},
 )
 def test_service_name_imports_v1():
+    from ddtrace.internal.constants import DEFAULT_SERVICE_NAME
     from ddtrace.internal.schema import DEFAULT_SPAN_SERVICE_NAME
     from ddtrace.internal.schema import schematize_cache_operation
     from ddtrace.internal.schema import schematize_cloud_api_operation
@@ -62,7 +63,7 @@ def test_service_name_imports_v1():
     from ddtrace.internal.schema.span_attribute_schema import service_name_v1
     from ddtrace.internal.schema.span_attribute_schema import url_operation_v1
 
-    assert DEFAULT_SPAN_SERVICE_NAME == "unnamed-python-service"
+    assert DEFAULT_SPAN_SERVICE_NAME == DEFAULT_SERVICE_NAME
     assert schematize_service_name == service_name_v1
     assert schematize_database_operation == database_operation_v1
     assert schematize_cache_operation == cache_operation_v1
@@ -77,6 +78,7 @@ def test_service_name_import_with_client_service_names_enabled_v0():
     """
     Service name parameters are flipped when DD_TRACE_REMOVE_INTEGRATION_SERVICE_NAMES_ENABLED is True for v0
     """
+    from ddtrace.internal.constants import DEFAULT_SERVICE_NAME
     from ddtrace.internal.schema import DEFAULT_SPAN_SERVICE_NAME
     from ddtrace.internal.schema import schematize_cache_operation
     from ddtrace.internal.schema import schematize_cloud_api_operation
@@ -89,7 +91,7 @@ def test_service_name_import_with_client_service_names_enabled_v0():
     from ddtrace.internal.schema.span_attribute_schema import service_name_v1
     from ddtrace.internal.schema.span_attribute_schema import url_operation_v0
 
-    assert DEFAULT_SPAN_SERVICE_NAME == "unnamed-python-service"
+    assert DEFAULT_SPAN_SERVICE_NAME == DEFAULT_SERVICE_NAME
     assert schematize_service_name == service_name_v1
     assert schematize_database_operation == database_operation_v0
     assert schematize_cache_operation == cache_operation_v0

tests/telemetry/test_data.py

@@ -7,6 +7,7 @@
 
 import ddtrace
 from ddtrace.internal.compat import PY3
+from ddtrace.internal.constants import DEFAULT_SERVICE_NAME
 from ddtrace.internal.packages import get_distributions
 from ddtrace.internal.runtime.container import CGroupInfo
 from ddtrace.internal.telemetry.data import _format_version_info
@@ -27,7 +28,7 @@ def test_get_application():
         runtime_v = _format_version_info(sys.implementation.version)
 
     expected_application = {
-        "service_name": "unnamed_python_service",
+        "service_name": DEFAULT_SERVICE_NAME,
         "service_version": "",
         "env": "",
         "language_name": "python",