NH-69217 sw.transaction attribute on otlp traces, metrics

solarwinds_apm/apm_constants.py

@@ -15,6 +15,7 @@
 INTL_SWO_OTEL_SCOPE_NAME = "otel.scope.name"
 INTL_SWO_OTEL_SCOPE_VERSION = "otel.scope.version"
 INTL_SWO_TRACESTATE_KEY = "sw"
+INTL_SWO_TRANSACTION_ATTR_KEY = "sw.transaction"
 INTL_SWO_X_OPTIONS_KEY = "sw_xtraceoptions"
 INTL_SWO_X_OPTIONS_RESPONSE_KEY = "xtrace_options_response"
 INTL_SWO_DEFAULT_TRACES_EXPORTER = "solarwinds_exporter"

solarwinds_apm/sampler.py

@@ -31,6 +31,7 @@
     INTL_SWO_COMMA_W3C_SANITIZED,
     INTL_SWO_EQUALS_W3C_SANITIZED,
     INTL_SWO_TRACESTATE_KEY,
+    INTL_SWO_TRANSACTION_ATTR_KEY,
     INTL_SWO_X_OPTIONS_KEY,
     INTL_SWO_X_OPTIONS_RESPONSE_KEY,
 )
@@ -69,6 +70,9 @@ def __init__(
         oboe_api: "OboeAPI",
     ):
         self.apm_config = apm_config
+        # SW_APM_TRANSACTION_NAME and AWS_LAMBDA_FUNCTION_NAME
+        self.env_transaction_name = apm_config.get("transaction_name")
+        self.lambda_function_name = apm_config.lambda_function_name
         self.context = apm_config.extension.Context
 
         if self.apm_config.get("tracing_mode") is not None:
@@ -415,6 +419,35 @@ def add_tracestate_capture_to_attributes_dict(
         )
         return attributes_dict
 
+    def calculate_otlp_transaction_name(
+        self,
+        span_name: str,
+    ) -> str:
+        """Calculate transaction name for OTLP trace following this order
+        of decreasing precedence:
+
+        1. SW_APM_TRANSACTION_NAME
+        2. AWS_LAMBDA_FUNCTION_NAME
+        3. automated naming from span name
+        4. "unknown_service" backup, to match OpenTelemetry SDK Resource default
+
+        Notes:
+        * Spans at time of sampling decision/on_start will not have access
+          to SDK-set names, nor all span attributes from instrumentors
+        * But they should have access to span `name`
+        * Spans at on_end are immutable
+        """
+        if self.env_transaction_name:
+            return self.env_transaction_name
+
+        if self.lambda_function_name:
+            return self.lambda_function_name
+
+        if span_name:
+            return span_name
+
+        return "unknown_service"
+
     def calculate_attributes(
         self,
         span_name: str,
@@ -462,6 +495,18 @@ def calculate_attributes(
             f"{decision['bucket_rate']}"
         )
 
+        # If `experimental` and `otel_collector`,
+        # always (root or is_remote) set sw.transaction
+        # TODO Clean up use of experimental trace flag
+        #      https://swicloud.atlassian.net/browse/NH-65067
+        if self.apm_config.get("experimental").get("otel_collector") is True:
+            logger.debug(
+                "Experimental otel_collector flag configured. Setting sw.transaction on span."
+            )
+            new_attributes[INTL_SWO_TRANSACTION_ATTR_KEY] = (
+                self.calculate_otlp_transaction_name(span_name)
+            )
+
         # sw.tracestate_parent_id is set if:
         #  1. the future span is the entry span of a service
         #  2. there exists a (remote) parent span

solarwinds_apm/trace/otlp_metrics_processor.py

@@ -7,6 +7,7 @@
 import logging
 from typing import TYPE_CHECKING
 
+from solarwinds_apm.apm_constants import INTL_SWO_TRANSACTION_ATTR_KEY
 from solarwinds_apm.apm_meter_manager import SolarWindsMeterManager
 from solarwinds_apm.apm_noop import SolarWindsMeterManager as NoopMeterManager
 from solarwinds_apm.trace.base_metrics_processor import _SwBaseMetricsProcessor
@@ -17,7 +18,6 @@
     from solarwinds_apm.apm_config import SolarWindsApmConfig
     from solarwinds_apm.apm_txname_manager import SolarWindsTxnNameManager
     from solarwinds_apm.extension.oboe import OboeAPI
-    from solarwinds_apm.trace.tnames import TransactionNames
 
 
 logger = logging.getLogger(__name__)
@@ -56,26 +56,28 @@ def __init__(
 
     def calculate_otlp_transaction_name(
         self,
-        tnames: "TransactionNames",
+        span_name: str,
     ) -> str:
         """Calculate transaction name for OTLP metrics following this order
         of decreasing precedence:
 
-        1. custom SDK name
-        2. SW_APM_TRANSACTION_NAME
-        3. AWS_LAMBDA_FUNCTION_NAME
-        4. automated naming from span name, attributes
-        """
-        if tnames.custom_name:
-            return tnames.custom_name
+        1. SW_APM_TRANSACTION_NAME
+        2. AWS_LAMBDA_FUNCTION_NAME
+        3. automated naming from span name
+        4. "unknown_service" backup, to match OpenTelemetry SDK Resource default
 
+        See also _SwSampler.calculate_otlp_transaction_name
+        """
         if self.env_transaction_name:
             return self.env_transaction_name
 
         if self.lambda_function_name:
             return self.lambda_function_name
 
-        return tnames.trans_name
+        if span_name:
+            return span_name
+
+        return "unknown_service"
 
     def on_end(self, span: "ReadableSpan") -> None:
         """Calculates and reports OTLP trace metrics"""
@@ -88,14 +90,7 @@ def on_end(self, span: "ReadableSpan") -> None:
         ):
             return
 
-        tnames = self.get_tnames(span)
-        if not tnames:
-            logger.error(
-                "Could not get transaction name. Not recording otlp metrics."
-            )
-            return
-
-        trans_name = self.calculate_otlp_transaction_name(tnames)
+        trans_name = self.calculate_otlp_transaction_name(span.name)
 
         meter_attrs = {}
         has_error = self.has_error(span)
@@ -119,11 +114,11 @@ def on_end(self, span: "ReadableSpan") -> None:
                 {
                     self._HTTP_STATUS_CODE: status_code,
                     self._HTTP_METHOD: request_method,
-                    "sw.transaction": trans_name,
+                    INTL_SWO_TRANSACTION_ATTR_KEY: trans_name,
                 }
             )
         else:
-            meter_attrs.update({"sw.transaction": trans_name})
+            meter_attrs.update({INTL_SWO_TRANSACTION_ATTR_KEY: trans_name})
         self.apm_meters.response_time.record(
             amount=span_time,
             attributes=meter_attrs,

tests/unit/test_processors/test_otlp_metrics_processor.py

@@ -88,70 +88,52 @@ def test__init_not_experimental(self, mocker, mock_meter_manager):
         assert processor.lambda_function_name == "foo-lambda-name"
         assert isinstance(processor.apm_meters, NoopMeterManager)
 
-    def test_calculate_otlp_transaction_name_custom(self, mocker, mock_meter_manager):
-        mock_apm_config = self.get_mock_apm_config(mocker)
-        tnames = TransactionNames(
-            "unused",
-            "unused",
-            "foo-custom-name",
-        )
-        assert "foo-custom-name" == SolarWindsOTLPMetricsSpanProcessor(
-            mocker.Mock(),
-            mock_apm_config,
-            mocker.Mock()
-        ).calculate_otlp_transaction_name(tnames)
-
     def test_calculate_otlp_transaction_name_env_trans(self, mocker, mock_meter_manager):
         mock_apm_config = self.get_mock_apm_config(
             mocker,
             "foo-env-trans-name",
         )
-        tnames = TransactionNames(
-            "unused",
-            "unused",
-            None,
-        )
         assert "foo-env-trans-name" == SolarWindsOTLPMetricsSpanProcessor(
             mocker.Mock(),
             mock_apm_config,
             mocker.Mock()
-        ).calculate_otlp_transaction_name(tnames)
+        ).calculate_otlp_transaction_name("foo-span")
 
     def test_calculate_otlp_transaction_name_env_lambda(self, mocker, mock_meter_manager):
         mock_apm_config = self.get_mock_apm_config(
             mocker,
             outer_txn_retval=None,
             lambda_function_name="foo-lambda-name",
         )
-        tnames = TransactionNames(
-            "unused",
-            "unused",
-            None,
-        )
         assert "foo-lambda-name" == SolarWindsOTLPMetricsSpanProcessor(
             mocker.Mock(),
             mock_apm_config,
             mocker.Mock()
-        ).calculate_otlp_transaction_name(tnames)
+        ).calculate_otlp_transaction_name("foo-span")
 
-    def test_calculate_otlp_transaction_name_default(self, mocker, mock_meter_manager):
+    def test_calculate_otlp_transaction_name_span_name(self, mocker, mock_meter_manager):
         mock_apm_config = self.get_mock_apm_config(
             mocker,
             outer_txn_retval=None,
             lambda_function_name=None,
         )
+        assert "foo-span" == SolarWindsOTLPMetricsSpanProcessor(
+            mocker.Mock(),
+            mock_apm_config,
+            mocker.Mock()
+        ).calculate_otlp_transaction_name("foo-span")
 
-        tnames = TransactionNames(
-            "foo-trans-name",
-            "unused",
-            None,
+    def test_calculate_otlp_transaction_name_empty(self, mocker, mock_meter_manager):
+        mock_apm_config = self.get_mock_apm_config(
+            mocker,
+            outer_txn_retval=None,
+            lambda_function_name=None,
         )
-
-        assert "foo-trans-name" == SolarWindsOTLPMetricsSpanProcessor(
+        assert "unknown_service" == SolarWindsOTLPMetricsSpanProcessor(
             mocker.Mock(),
             mock_apm_config,
             mocker.Mock()
-        ).calculate_otlp_transaction_name(tnames)
+        ).calculate_otlp_transaction_name("")
 
     def patch_for_on_end(
         self,

tests/unit/test_sampler/fixtures/sampler.py

@@ -12,15 +12,38 @@ def config_get(param) -> Any:
         return -1
     elif param == "transaction_filters":
         return []
+    elif param == "transaction_name":
+        return "foo-txn"
     else:
         return None
 
 @pytest.fixture(name="fixture_swsampler")
 def fixture_swsampler(mocker):
+    # mock `experimental` `otel_collector` when checked
+    mock_get_inner = mocker.Mock(return_value=True)
+    mock_inner = mocker.Mock()
+    mock_inner.configure_mock(
+        **{
+            "get": mock_get_inner,
+        }
+    )
+    def outer_side_effect(param) -> Any:
+        if param == "tracing_mode":
+            return -1
+        elif param == "transaction_filters":
+            return []
+        elif param == "transaction_name":
+            return "foo-txn"
+        elif param == "experimental":
+            return mock_inner
+        else:
+            return None
+
     mock_apm_config = mocker.Mock()
-    mock_get = mocker.Mock(
-        side_effect=config_get
+    mock_get_outer = mocker.Mock(
+        side_effect=outer_side_effect
     )
+
     mock_get_decisions = mocker.patch(
         "solarwinds_apm.extension.oboe.Context.getDecisions"
     )
@@ -43,9 +66,10 @@ def fixture_swsampler(mocker):
     mock_apm_config.configure_mock(
         **{
             "agent_enabled": True,
-            "get": mock_get,
+            "get": mock_get_outer,
             "extension": mock_extension,
             "is_lambda": False,
+            "lambda_function_name": "foo-lambda",
         }
     )
     return _SwSampler(mock_apm_config, mocker.Mock())

tests/unit/test_sampler/test_sampler.py

@@ -4,6 +4,8 @@
 #
 # Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 
+from typing import Any
+
 import pytest
 
 from opentelemetry.sdk.trace.sampling import (
@@ -199,11 +201,28 @@ def fixture_parent_span_context_valid_remote_no_tracestate():
 
 class Test_SwSampler():
     def test_init(self, mocker):
+        def config_get(param) -> Any:
+            if param == "transaction_name":
+                return "foo-txn"
+            else:
+                return "foo"
+
+        mock_get = mocker.Mock(
+            side_effect=config_get
+        )
         mock_apm_config = mocker.Mock()
+        mock_apm_config.configure_mock(
+            **{
+                "get": mock_get,
+                "lambda_function_name": "foo-lambda",
+            }
+        )
         mock_oboe_api = mocker.Mock()
         sampler = _SwSampler(mock_apm_config, mock_oboe_api)
         assert sampler.apm_config == mock_apm_config
         assert sampler.oboe_settings_api == mock_oboe_api
+        assert sampler.env_transaction_name == "foo-txn"
+        assert sampler.lambda_function_name == "foo-lambda"
 
     def test_calculate_liboboe_decision_is_lambda(
         self,