Merge pull request #1488 from newrelic/merge-main-develop-11.0.0

Merge main into develop-11.0.0

Author: TimPansino

.github/workflows/deploy.yml

@@ -113,7 +113,7 @@ jobs:
           persist-credentials: false
           fetch-depth: 0
 
-      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # 5.6.0
+      - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # 6.0.0
         with:
           python-version: "3.12"
 
@@ -175,13 +175,15 @@ jobs:
           AWS_DEFAULT_REGION: us-west-2
 
       - name: Upload Package
-        uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # 1.12.4
+        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # 1.13.0
 
       - name: Attest
-        uses: actions/attest-build-provenance@e8998f949152b193b063cb0ec769d69d929409be # 2.4.0
+        uses: actions/attest-build-provenance@977bb373ede98d70efdf65b84cb5f73e068dcc2a # 3.0.0
         id: attest
         with:
-          subject-path: ./dist/*
+          subject-path: |
+            ./dist/*.whl
+            ./dist/*.tar.gz
 
       - name: Wait for release to be available
         id: wait

.github/workflows/tests.yml

@@ -82,7 +82,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0
-      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # 5.6.0
+      - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # 6.0.0
         with:
           python-version: "3.10"
           architecture: x64
@@ -100,7 +100,7 @@ jobs:
           coverage xml
 
       - name: Upload Coverage to Codecov
-        uses: codecov/codecov-action@fdcc8476540edceab3de004e990f80d881c6cc00 # 5.5.0
+        uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # 5.5.1
         with:
           files: coverage.xml
           fail_ci_if_error: true

.github/workflows/trivy.yml

@@ -39,7 +39,7 @@ jobs:
 
       - name: Run Trivy vulnerability scanner in repo mode
         if: ${{ github.event_name == 'pull_request' }}
-        uses: aquasecurity/trivy-action@dc5a429b52fcf669ce959baa2c2dd26090d2a6c4 # v0.32.0
+        uses: aquasecurity/trivy-action@b6643a29fecd7f34b3597bc6acb0a98b03d33ff8 # v0.33.1
         with:
           scan-type: "fs"
           ignore-unfixed: true
@@ -50,7 +50,7 @@ jobs:
 
       - name: Run Trivy vulnerability scanner in repo mode
         if: ${{ github.event_name == 'schedule' }}
-        uses: aquasecurity/trivy-action@dc5a429b52fcf669ce959baa2c2dd26090d2a6c4 # v0.32.0
+        uses: aquasecurity/trivy-action@b6643a29fecd7f34b3597bc6acb0a98b03d33ff8 # v0.33.1
         with:
           scan-type: "fs"
           ignore-unfixed: true
@@ -61,6 +61,6 @@ jobs:
 
       - name: Upload Trivy scan results to GitHub Security tab
         if: ${{ github.event_name == 'schedule' }}
-        uses: github/codeql-action/upload-sarif@3c3833e0f8c1c83d449a7478aa59c036a9165498 # 3.29.11
+        uses: github/codeql-action/upload-sarif@f1f6e5f6af878fb37288ce1c627459e94dbf7d01 # 3.30.1
         with:
           sarif_file: "trivy-results.sarif"

newrelic/api/datastore_trace.py

@@ -17,6 +17,7 @@
 from newrelic.api.time_trace import TimeTrace, current_trace
 from newrelic.common.async_wrapper import async_wrapper as get_async_wrapper
 from newrelic.common.object_wrapper import FunctionWrapper, wrap_object
+from newrelic.core.config import global_settings
 from newrelic.core.datastore_node import DatastoreNode
 
 
@@ -86,7 +87,8 @@ def __enter__(self):
             self.port_path_or_id = transaction._intern_string(self.port_path_or_id)
             self.database_name = transaction._intern_string(self.database_name)
 
-            datastore_tracer_settings = transaction.settings.datastore_tracer
+            settings = transaction.settings or global_settings()
+            datastore_tracer_settings = settings.datastore_tracer
             self.instance_reporting_enabled = datastore_tracer_settings.instance_reporting.enabled
             self.database_name_enabled = datastore_tracer_settings.database_name_reporting.enabled
         return result

newrelic/api/graphql_trace.py

@@ -18,6 +18,7 @@
 from newrelic.api.transaction import current_transaction
 from newrelic.common.async_wrapper import async_wrapper as get_async_wrapper
 from newrelic.common.object_wrapper import FunctionWrapper, wrap_object
+from newrelic.core.config import global_settings
 from newrelic.core.graphql_node import GraphQLOperationNode, GraphQLResolverNode
 
 
@@ -49,7 +50,7 @@ def formatted(self):
         transaction = current_transaction(active_only=False)
 
         # Record SQL settings
-        settings = transaction.settings
+        settings = transaction.settings or global_settings()
         tt = settings.transaction_tracer
         self.graphql_format = tt.record_sql
 

newrelic/api/transaction.py

@@ -285,6 +285,7 @@ def __init__(self, application, enabled=None, source=None):
         self.tracestate = ""
         self._priority = None
         self._sampled = None
+        self._traceparent_sampled = None
 
         self._distributed_trace_state = 0
 
@@ -1003,16 +1004,36 @@ def _update_agent_attributes(self):
     def user_attributes(self):
         return create_attributes(self._custom_params, DST_ALL, self.attribute_filter)
 
-    def _compute_sampled_and_priority(self):
+    def sampling_algo_compute_sampled_and_priority(self):
         if self._priority is None:
-            # truncate priority field to 6 digits past the decimal
+            # Truncate priority field to 6 digits past the decimal.
             self._priority = float(f"{random.random():.6f}")  # noqa: S311
-
         if self._sampled is None:
             self._sampled = self._application.compute_sampled()
             if self._sampled:
                 self._priority += 1
 
+    def _compute_sampled_and_priority(self):
+        if self._traceparent_sampled is None:
+            config = "default"  # Use sampling algo.
+        elif self._traceparent_sampled:
+            setting_path = "distributed_tracing.sampler.remote_parent_sampled"
+            config = self.settings.distributed_tracing.sampler.remote_parent_sampled
+        else:  # self._traceparent_sampled is False.
+            setting_path = "distributed_tracing.sampler.remote_parent_not_sampled"
+            config = self.settings.distributed_tracing.sampler.remote_parent_not_sampled
+
+        if config == "always_on":
+            self._sampled = True
+            self._priority = 2.0
+        elif config == "always_off":
+            self._sampled = False
+            self._priority = 0
+        else:
+            if config != "default":
+                _logger.warning("%s=%s is not a recognized value. Using 'default' instead.", setting_path, config)
+            self.sampling_algo_compute_sampled_and_priority()
+
     def _freeze_path(self):
         if self._frozen_path is None:
             self._name_priority = None
@@ -1311,6 +1332,7 @@ def accept_distributed_trace_headers(self, headers, transport_type="HTTP"):
                     else:
                         self._record_supportability("Supportability/TraceContext/TraceState/NoNrEntry")
 
+            self._traceparent_sampled = data.get("sa")
             self._accept_distributed_trace_data(data, transport_type)
             self._record_supportability("Supportability/TraceContext/Accept/Success")
             return True

newrelic/common/encoding_utils.py

@@ -34,6 +34,7 @@
 DELIMITER_FORMAT_RE = re.compile("[ \t]*,[ \t]*")
 PARENT_TYPE = {"0": "App", "1": "Browser", "2": "Mobile"}
 BASE64_DECODE_STR = getattr(base64, "decodestring", None)
+FLAG_SAMPLED = 1
 
 
 # Functions for encoding/decoding JSON. These wrappers are used in order
@@ -455,7 +456,10 @@ def decode(cls, payload):
         if parent_id == "0" * 16 or trace_id == "0" * 32:
             return None
 
-        return cls(tr=trace_id, id=parent_id)
+        # Sampled flag
+        sa = bool(int(fields[3], 2) & FLAG_SAMPLED)
+
+        return cls(tr=trace_id, id=parent_id, sa=sa)
 
 
 class W3CTraceState(OrderedDict):

newrelic/config.py

@@ -401,6 +401,8 @@ def _process_configuration(section):
     _process_setting(section, "ml_insights_events.enabled", "getboolean", None)
     _process_setting(section, "distributed_tracing.enabled", "getboolean", None)
     _process_setting(section, "distributed_tracing.exclude_newrelic_header", "getboolean", None)
+    _process_setting(section, "distributed_tracing.sampler.remote_parent_sampled", "get", None)
+    _process_setting(section, "distributed_tracing.sampler.remote_parent_not_sampled", "get", None)
     _process_setting(section, "span_events.enabled", "getboolean", None)
     _process_setting(section, "span_events.max_samples_stored", "getint", None)
     _process_setting(section, "span_events.attributes.enabled", "getboolean", None)

newrelic/core/config.py

@@ -332,6 +332,10 @@ class DistributedTracingSettings(Settings):
     pass
 
 
+class DistributedTracingSamplerSettings(Settings):
+    pass
+
+
 class ServerlessModeSettings(Settings):
     pass
 
@@ -501,6 +505,7 @@ class EventHarvestConfigHarvestLimitSettings(Settings):
 _settings.datastore_tracer.instance_reporting = DatastoreTracerInstanceReportingSettings()
 _settings.debug = DebugSettings()
 _settings.distributed_tracing = DistributedTracingSettings()
+_settings.distributed_tracing.sampler = DistributedTracingSamplerSettings()
 _settings.error_collector = ErrorCollectorSettings()
 _settings.error_collector.attributes = ErrorCollectorAttributesSettings()
 _settings.event_harvest_config = EventHarvestConfigSettings()
@@ -825,6 +830,12 @@ def default_otlp_host(host):
 _settings.ml_insights_events.enabled = False
 
 _settings.distributed_tracing.enabled = _environ_as_bool("NEW_RELIC_DISTRIBUTED_TRACING_ENABLED", default=True)
+_settings.distributed_tracing.sampler.remote_parent_sampled = os.environ.get(
+    "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_SAMPLED", "default"
+)
+_settings.distributed_tracing.sampler.remote_parent_not_sampled = os.environ.get(
+    "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_NOT_SAMPLED", "default"
+)
 _settings.distributed_tracing.exclude_newrelic_header = False
 _settings.span_events.enabled = _environ_as_bool("NEW_RELIC_SPAN_EVENTS_ENABLED", default=True)
 _settings.span_events.attributes.enabled = True

newrelic/hooks/datastore_elasticsearch.py

@@ -16,6 +16,7 @@
 from newrelic.api.transaction import current_transaction
 from newrelic.common.object_wrapper import function_wrapper, wrap_function_wrapper
 from newrelic.common.package_version_utils import get_package_version_tuple
+from newrelic.core.config import global_settings
 
 # An index name can be a string, None or a sequence. In the case of None
 # an empty string or '*', it is the same as using '_all'. When a string
@@ -139,7 +140,8 @@ def _nr_wrapper_Elasticsearch_method_(wrapped, instance, args, kwargs):
         with trace:
             result = wrapped(*args, **kwargs)
 
-            tracer_settings = trace.settings.datastore_tracer
+            settings = trace.settings or global_settings()
+            tracer_settings = settings.datastore_tracer
 
             if tracer_settings.instance_reporting.enabled:
                 try:
@@ -182,7 +184,8 @@ async def _nr_wrapper_AsyncElasticsearch_method_(wrapped, instance, args, kwargs
         with trace:
             result = await wrapped(*args, **kwargs)
 
-            tracer_settings = trace.settings.datastore_tracer
+            settings = trace.settings or global_settings()
+            tracer_settings = settings.datastore_tracer
 
             if tracer_settings.instance_reporting.enabled:
                 try:
@@ -267,7 +270,6 @@ async def _nr_wrapper_AsyncElasticsearch_method_(wrapped, instance, args, kwargs
     ("msearch_template", _extract_args_search_templates_index),
     ("mtermvectors", _extract_args_index),
     ("open_point_in_time", _extract_args_index),
-    ("options", None),
     ("ping", None),
     ("put_script", None),
     ("rank_eval", _extract_args_requests_index),
@@ -783,7 +785,8 @@ def _nr_get_connection_wrapper(wrapped, instance, args, kwargs):
 
     host = port_path_or_id = "unknown"
     try:
-        tracer_settings = trace.settings.datastore_tracer
+        settings = trace.settings or global_settings()
+        tracer_settings = settings.datastore_tracer
 
         if tracer_settings.instance_reporting.enabled:
             host, port_path_or_id = conn._nr_host_port