scout-apm 3.1.0__tar.gz → 3.3.0__tar.gz

{scout_apm-3.1.0 → scout_apm-3.3.0}/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## Pending
 
+- Change to tz-aware dates internally (Issue #799)
+- psutil dependency un-pin (#790)
+
+## [3.3.0] 2025-01-07
+### Added
+- Added support for down-sampling via Scout configuration.
+  - Sample rates can be set globally or for specific jobs/endpoints
+  - Check out our [documentation](https://scoutapm.com/docs/python/configuration#sampling) for more information and example usage.
+
+## [3.2.0] 2024-09-12
+### Added
+- "Operation" attribute added to TrackedRequest class to better support development of [scout_apm_python_logging](https://github.com/scoutapp/scout_apm_python_logging)
+
 ## [3.1.0] 2023-12-18
 ### Added
 - Updates Core Agent to v1.5.0

{scout_apm-3.1.0 → scout_apm-3.3.0}/DEVELOPMENT.md

@@ -85,7 +85,7 @@ Running the test app
 --------------------
 
 Note: this has not been tested in a while. Instead, the
-[scout-test-apps repo](https://github.com/tim-schilling/scout-test-apps) has
+[scout-test-apps repo](https://github.com/scoutapp/scout-test-apps) has
 been used with many individual scout apps.
 
 Add the following env variables:
@@ -133,7 +133,6 @@ architectures. Its documentation is excellent.
 Documentation
 -------------
 
-The user documentation is stored in the [slate_apm_help
-repo](https://github.com/scoutapp/slate_apm_help) in the
-`source/_includes/python.md` file. Make relevant changes there when developing
-features.
+The user documentation is stored in the [scout-documentation](https://github.com/scoutapp/scout-documentation) repo.
+It is private to the Scout Monitoring team; if you want to submit a feature feel free to
+send us some Markdown and we will get it added.

{scout_apm-3.1.0 → scout_apm-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scout_apm
-Version: 3.1.0
+Version: 3.3.0
 Summary: Scout Application Performance Monitoring Agent
 Home-page: https://github.com/scoutapp/scout_apm_python
 Author: Scout
@@ -70,7 +70,7 @@ To use Scout, you'll need to
 
 For full installation instructions, including information on configuring Scout
 via environment variables and troubleshooting, see our
-[Python docs](https://docs.scoutapm.com/#python-agent).
+[Python docs](https://scoutapm.com/docs/python).
 
 ## Support
 

{scout_apm-3.1.0 → scout_apm-3.3.0}/README.md

@@ -35,7 +35,7 @@ To use Scout, you'll need to
 
 For full installation instructions, including information on configuring Scout
 via environment variables and troubleshooting, see our
-[Python docs](https://docs.scoutapm.com/#python-agent).
+[Python docs](https://scoutapm.com/docs/python).
 
 ## Support
 

{scout_apm-3.1.0 → scout_apm-3.3.0}/setup.py

@@ -33,7 +33,7 @@ else:
 
 setup(
     name="scout_apm",
-    version="3.1.0",
+    version="3.3.0",
     description="Scout Application Performance Monitoring Agent",
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -59,8 +59,8 @@ setup(
     },
     install_requires=[
         "asgiref",
-        "psutil>=5,<6",
-        "urllib3",
+        "psutil>=5",
+        "urllib3~=2.2.0",
         "certifi",
         "wrapt>=1.10,<2.0",
     ],

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/api/__init__.py

@@ -97,6 +97,7 @@ class Transaction(AsyncDecoratorMixin, ContextDecorator):
         operation = text(kind) + "/" + text(name)
 
         tracked_request = TrackedRequest.instance()
+        tracked_request.operation = operation
         tracked_request.is_real_request = True
         span = tracked_request.start_span(
             operation=operation, should_capture_backtrace=False

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/async_/starlette.py

@@ -40,6 +40,7 @@ class ScoutMiddleware:
                     endpoint.__module__,
                     endpoint.__qualname__,
                 )
+                tracked_request.operation = controller_span.operation
             else:
                 # Mark the request as not real
                 tracked_request.is_real_request = False
@@ -90,11 +91,11 @@ def install_background_instrumentation():
         tracked_request = TrackedRequest.instance()
         tracked_request.is_real_request = True
 
-        with tracked_request.span(
-            operation="Job/{}.{}".format(
-                instance.func.__module__, instance.func.__qualname__
-            )
-        ):
+        operation = "Job/{}.{}".format(
+            instance.func.__module__, instance.func.__qualname__
+        )
+        tracked_request.operation = operation
+        with tracked_request.span(operation=operation):
             return await wrapped(*args, **kwargs)
 
     BackgroundTask.__call__ = wrapped_background_call(BackgroundTask.__call__)

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/bottle.py

@@ -71,10 +71,10 @@ def wrap_callback(wrapped, instance, args, kwargs):
         "x-request-start", ""
     )
     track_request_queue_time(queue_time, tracked_request)
+    operation = "Controller{}".format(controller_name)
 
-    with tracked_request.span(
-        operation="Controller{}".format(controller_name), should_capture_backtrace=False
-    ):
+    with tracked_request.span(operation=operation):
+        tracked_request.operation = operation
         try:
             value = wrapped(*args, **kwargs)
         except Exception:

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/celery.py

@@ -29,7 +29,9 @@ logger = logging.getLogger(__name__)
 
 def before_task_publish_callback(headers=None, properties=None, **kwargs):
     if "scout_task_start" not in headers:
-        headers["scout_task_start"] = datetime_to_timestamp(dt.datetime.utcnow())
+        headers["scout_task_start"] = datetime_to_timestamp(
+            dt.datetime.now(dt.timezone.utc)
+        )
 
 
 def task_prerun_callback(task=None, **kwargs):
@@ -54,7 +56,9 @@ def task_prerun_callback(task=None, **kwargs):
         tracked_request.tag("routing_key", delivery_info.get("routing_key", "unknown"))
         tracked_request.tag("queue", delivery_info.get("queue", "unknown"))
 
-    tracked_request.start_span(operation=("Job/" + task.name))
+    operation = "Job/" + task.name
+    tracked_request.start_span(operation=operation)
+    tracked_request.operation = operation
 
 
 def task_postrun_callback(task=None, **kwargs):

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/core/agent/commands.py

@@ -1,5 +1,6 @@
 # coding=utf-8
 
+import datetime as dt
 import logging
 import re
 
@@ -10,6 +11,18 @@ logger = logging.getLogger(__name__)
 key_regex = re.compile(r"^[a-zA-Z0-9]{20}$")
 
 
+def format_dt_for_core_agent(event_time: dt.datetime) -> str:
+    """
+    Returns expected format for Core Agent compatibility.
+    Coerce any tz-aware datetime to UTC just in case.
+    """
+    # if we somehow got a naive datetime, convert it to UTC
+    if event_time.tzinfo is None:
+        logger.warning("Naive datetime passed to format_dt_for_core_agent")
+        event_time = event_time.astimezone(dt.timezone.utc)
+    return event_time.isoformat()
+
+
 class Register(object):
     __slots__ = ("app", "key", "hostname")
 
@@ -49,7 +62,7 @@ class StartSpan(object):
     def message(self):
         return {
             "StartSpan": {
-                "timestamp": self.timestamp.isoformat() + "Z",
+                "timestamp": format_dt_for_core_agent(self.timestamp),
                 "request_id": self.request_id,
                 "span_id": self.span_id,
                 "parent_id": self.parent,
@@ -69,7 +82,7 @@ class StopSpan(object):
     def message(self):
         return {
             "StopSpan": {
-                "timestamp": self.timestamp.isoformat() + "Z",
+                "timestamp": format_dt_for_core_agent(self.timestamp),
                 "request_id": self.request_id,
                 "span_id": self.span_id,
             }
@@ -86,7 +99,7 @@ class StartRequest(object):
     def message(self):
         return {
             "StartRequest": {
-                "timestamp": self.timestamp.isoformat() + "Z",
+                "timestamp": format_dt_for_core_agent(self.timestamp),
                 "request_id": self.request_id,
             }
         }
@@ -102,7 +115,7 @@ class FinishRequest(object):
     def message(self):
         return {
             "FinishRequest": {
-                "timestamp": self.timestamp.isoformat() + "Z",
+                "timestamp": format_dt_for_core_agent(self.timestamp),
                 "request_id": self.request_id,
             }
         }
@@ -121,7 +134,7 @@ class TagSpan(object):
     def message(self):
         return {
             "TagSpan": {
-                "timestamp": self.timestamp.isoformat() + "Z",
+                "timestamp": format_dt_for_core_agent(self.timestamp),
                 "request_id": self.request_id,
                 "span_id": self.span_id,
                 "tag": self.tag,
@@ -142,7 +155,7 @@ class TagRequest(object):
     def message(self):
         return {
             "TagRequest": {
-                "timestamp": self.timestamp.isoformat() + "Z",
+                "timestamp": format_dt_for_core_agent(self.timestamp),
                 "request_id": self.request_id,
                 "tag": self.tag,
                 "value": self.value,
@@ -162,7 +175,7 @@ class ApplicationEvent(object):
     def message(self):
         return {
             "ApplicationEvent": {
-                "timestamp": self.timestamp.isoformat() + "Z",
+                "timestamp": format_dt_for_core_agent(self.timestamp),
                 "event_type": self.event_type,
                 "event_value": self.event_value,
                 "source": self.source,

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/core/config.py

@@ -4,6 +4,7 @@ import logging
 import os
 import re
 import warnings
+from typing import Any, Dict, List, Optional, Union
 
 from scout_apm.core import platform_detection
 
@@ -30,13 +31,13 @@ class ScoutConfig(object):
             Null(),
         ]
 
-    def value(self, key):
+    def value(self, key: str) -> Any:
         value = self.locate_layer_for_key(key).value(key)
         if key in CONVERSIONS:
             return CONVERSIONS[key](value)
         return value
 
-    def locate_layer_for_key(self, key):
+    def locate_layer_for_key(self, key: str) -> Any:
         for layer in self.layers:
             if layer.has_config(key):
                 return layer
@@ -44,7 +45,7 @@ class ScoutConfig(object):
         # Should be unreachable because Null returns None for all keys.
         raise ValueError("key {!r} not found in any layer".format(key))
 
-    def log(self):
+    def log(self) -> None:
         logger.debug("Configuration Loaded:")
         for key in self.known_keys:
             if key in self.secret_keys:
@@ -76,13 +77,20 @@ class ScoutConfig(object):
         "framework",
         "framework_version",
         "hostname",
-        "ignore",
+        "ignore",  # Deprecated in favor of ignore_endpoints
+        "ignore_endpoints",
+        "ignore_jobs",
         "key",
         "log_level",
         "log_payload_content",
         "monitor",
         "name",
         "revision_sha",
+        "sample_rate",
+        "endpoint_sample_rate",
+        "sample_endpoints",
+        "sample_jobs",
+        "job_sample_rate",
         "scm_subdirectory",
         "shutdown_message_enabled",
         "shutdown_timeout_seconds",
@@ -90,7 +98,7 @@ class ScoutConfig(object):
 
     secret_keys = {"key"}
 
-    def core_agent_permissions(self):
+    def core_agent_permissions(self) -> int:
         try:
             return int(str(self.value("core_agent_permissions")), 8)
         except ValueError:
@@ -100,7 +108,7 @@ class ScoutConfig(object):
             return 0o700
 
     @classmethod
-    def set(cls, **kwargs):
+    def set(cls, **kwargs: Any) -> None:
         """
         Sets a configuration value for the Scout agent. Values set here will
         not override values set in ENV.
@@ -109,7 +117,7 @@ class ScoutConfig(object):
             SCOUT_PYTHON_VALUES[key] = value
 
     @classmethod
-    def unset(cls, *keys):
+    def unset(cls, *keys: str) -> None:
         """
         Removes a configuration value for the Scout agent.
         """
@@ -117,7 +125,7 @@ class ScoutConfig(object):
             SCOUT_PYTHON_VALUES.pop(key, None)
 
     @classmethod
-    def reset_all(cls):
+    def reset_all(cls) -> None:
         """
         Remove all configuration settings set via `ScoutConfig.set(...)`.
 
@@ -135,10 +143,10 @@ class Python(object):
     A configuration overlay that lets other parts of python set values.
     """
 
-    def has_config(self, key):
+    def has_config(self, key: str) -> bool:
         return key in SCOUT_PYTHON_VALUES
 
-    def value(self, key):
+    def value(self, key: str) -> Any:
         return SCOUT_PYTHON_VALUES[key]
 
 
@@ -151,15 +159,15 @@ class Env(object):
     environment variable
     """
 
-    def has_config(self, key):
+    def has_config(self, key: str) -> bool:
         env_key = self.modify_key(key)
         return env_key in os.environ
 
-    def value(self, key):
+    def value(self, key: str) -> Any:
         env_key = self.modify_key(key)
         return os.environ[env_key]
 
-    def modify_key(self, key):
+    def modify_key(self, key: str) -> str:
         env_key = ("SCOUT_" + key).upper()
         return env_key
 
@@ -169,27 +177,27 @@ class Derived(object):
     A configuration overlay that calculates from other values.
     """
 
-    def __init__(self, config):
+    def __init__(self, config: ScoutConfig):
         """
         config argument is the overall ScoutConfig var, so we can lookup the
         components of the derived info.
         """
         self.config = config
 
-    def has_config(self, key):
+    def has_config(self, key: str) -> bool:
         return self.lookup_func(key) is not None
 
-    def value(self, key):
+    def value(self, key: str) -> Any:
         return self.lookup_func(key)()
 
-    def lookup_func(self, key):
+    def lookup_func(self, key: str) -> Optional[Any]:
         """
         Returns the derive_#{key} function, or None if it isn't defined
         """
         func_name = "derive_" + key
         return getattr(self, func_name, None)
 
-    def derive_core_agent_full_name(self):
+    def derive_core_agent_full_name(self) -> str:
         triple = self.config.value("core_agent_triple")
         if not platform_detection.is_valid_triple(triple):
             warnings.warn(
@@ -201,7 +209,7 @@ class Derived(object):
             triple=triple,
         )
 
-    def derive_core_agent_triple(self):
+    def derive_core_agent_triple(self) -> str:
         return platform_detection.get_triple()
 
 
@@ -223,7 +231,10 @@ class Defaults(object):
             "core_agent_socket_path": "tcp://127.0.0.1:6590",
             "core_agent_version": "v1.5.0",  # can be an exact tag name, or 'latest'
             "disabled_instruments": [],
-            "download_url": "https://s3-us-west-1.amazonaws.com/scout-public-downloads/apm_core_agent/release",  # noqa: B950
+            "download_url": (
+                "https://s3-us-west-1.amazonaws.com/scout-public-downloads/"
+                "apm_core_agent/release"
+            ),  # noqa: B950
             "errors_batch_size": 5,
             "errors_enabled": True,
             "errors_ignored_exceptions": (),
@@ -231,26 +242,34 @@ class Defaults(object):
             "framework": "",
             "framework_version": "",
             "hostname": None,
+            "ignore": [],
+            "ignore_endpoints": [],
+            "ignore_jobs": [],
             "key": "",
             "log_payload_content": False,
             "monitor": False,
             "name": "Python App",
             "revision_sha": self._git_revision_sha(),
+            "sample_rate": 100,
+            "sample_endpoints": [],
+            "endpoint_sample_rate": None,
+            "sample_jobs": [],
+            "job_sample_rate": None,
             "scm_subdirectory": "",
             "shutdown_message_enabled": True,
             "shutdown_timeout_seconds": 2.0,
             "uri_reporting": "filtered_params",
         }
 
-    def _git_revision_sha(self):
+    def _git_revision_sha(self) -> str:
         # N.B. The environment variable SCOUT_REVISION_SHA may also be used,
         # but that will be picked up by Env
         return os.environ.get("HEROKU_SLUG_COMMIT", "")
 
-    def has_config(self, key):
+    def has_config(self, key: str) -> bool:
         return key in self.defaults
 
-    def value(self, key):
+    def value(self, key: str) -> Any:
         return self.defaults[key]
 
 
@@ -261,14 +280,18 @@ class Null(object):
     Used as the last step of the layered configuration.
     """
 
-    def has_config(self, key):
+    def has_config(self, key: str) -> bool:
         return True
 
-    def value(self, key):
+    def value(self, key: str) -> None:
         return None
 
 
-def convert_to_bool(value):
+def _strip_leading_slash(path: str) -> str:
+    return path.lstrip(" /").strip()
+
+
+def convert_to_bool(value: Any) -> bool:
     if isinstance(value, bool):
         return value
     if isinstance(value, str):
@@ -277,14 +300,38 @@ def convert_to_bool(value):
     return False
 
 
-def convert_to_float(value):
+def convert_to_float(value: Any) -> float:
     try:
         return float(value)
     except ValueError:
         return 0.0
 
 
-def convert_to_list(value):
+def convert_sample_rate(value: Any) -> Optional[int]:
+    """
+    Converts sample rate to integer, ensuring it's between 0 and 100.
+    Allows None as a valid value.
+    """
+    if value is None:
+        return None
+    try:
+        rate = int(value)
+        if not (0 <= rate <= 100):
+            logger.warning(
+                f"Invalid sample rate {rate}. Must be between 0 and 100. "
+                "Defaulting to 100."
+            )
+            return 100
+        return rate
+    except (TypeError, ValueError):
+        logger.warning(
+            f"Invalid sample rate {value}. Must be a number between 0 and 100. "
+            "Defaulting to 100."
+        )
+        return 100
+
+
+def convert_to_list(value: Any) -> List[Any]:
     if isinstance(value, list):
         return value
     if isinstance(value, tuple):
@@ -296,13 +343,59 @@ def convert_to_list(value):
     return []
 
 
+def convert_ignore_paths(value: Any) -> List[str]:
+    """
+    Removes leading slashes from paths and returns a list of strings.
+    """
+    raw_paths = convert_to_list(value)
+    return [_strip_leading_slash(path) for path in raw_paths]
+
+
+def convert_endpoint_sampling(value: Union[str, Dict[str, Any]]) -> Dict[str, int]:
+    """
+    Converts endpoint sampling configuration from string or dict format
+    to a normalized dict.
+    Example: '/endpoint:40,/test:0' -> {'/endpoint': 40, '/test': 0}
+    """
+    if isinstance(value, dict):
+        return {_strip_leading_slash(k): int(v) for k, v in value.items()}
+    if isinstance(value, str):
+        if not value.strip():
+            return {}
+        result = {}
+        pairs = [pair.strip() for pair in value.split(",")]
+        for pair in pairs:
+            try:
+                endpoint, rate = pair.split(":")
+                rate_int = int(rate)
+                if not (0 <= rate_int <= 100):
+                    logger.warning(
+                        f"Invalid sampling rate {rate} for endpoint {endpoint}. "
+                        "Must be between 0 and 100."
+                    )
+                    continue
+                result[_strip_leading_slash(endpoint)] = rate_int
+            except ValueError:
+                logger.warning(f"Invalid sampling configuration: {pair}")
+                continue
+        return result
+    return {}
+
+
 CONVERSIONS = {
     "collect_remote_ip": convert_to_bool,
     "core_agent_download": convert_to_bool,
     "core_agent_launch": convert_to_bool,
     "disabled_instruments": convert_to_list,
-    "ignore": convert_to_list,
+    "ignore": convert_ignore_paths,
+    "ignore_endpoints": convert_ignore_paths,
+    "ignore_jobs": convert_ignore_paths,
     "monitor": convert_to_bool,
+    "sample_rate": convert_sample_rate,
+    "sample_endpoints": convert_endpoint_sampling,
+    "endpoint_sample_rate": convert_sample_rate,
+    "sample_jobs": convert_endpoint_sampling,
+    "job_sample_rate": convert_sample_rate,
     "shutdown_message_enabled": convert_to_bool,
     "shutdown_timeout_seconds": convert_to_float,
 }

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/core/metadata.py

@@ -4,7 +4,7 @@ import datetime as dt
 import sys
 from os import getpid
 
-from scout_apm.core.agent.commands import ApplicationEvent
+from scout_apm.core.agent.commands import ApplicationEvent, format_dt_for_core_agent
 from scout_apm.core.agent.socket import CoreAgentSocketThread
 from scout_apm.core.config import scout_config
 
@@ -15,7 +15,7 @@ def report_app_metadata():
             event_type="scout.metadata",
             event_value=get_metadata(),
             source="Pid: " + str(getpid()),
-            timestamp=dt.datetime.utcnow(),
+            timestamp=dt.datetime.now(dt.timezone.utc),
         )
     )
 
@@ -24,7 +24,7 @@ def get_metadata():
     data = {
         "language": "python",
         "language_version": "{}.{}.{}".format(*sys.version_info[:3]),
-        "server_time": dt.datetime.utcnow().isoformat() + "Z",
+        "server_time": format_dt_for_core_agent(dt.datetime.now(dt.timezone.utc)),
         "framework": scout_config.value("framework"),
         "framework_version": scout_config.value("framework_version"),
         "environment": "",

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/core/queue_time.py

@@ -86,7 +86,7 @@ def track_job_queue_time(
         bool: Whether we succeeded in marking queue time for the job. Used for testing.
     """
     if header_value is not None:
-        now = datetime_to_timestamp(dt.datetime.utcnow()) * 1e9
+        now = datetime_to_timestamp(dt.datetime.now(dt.timezone.utc)) * 1e9
         try:
             ambiguous_float_start = typing.cast(float, header_value)
             start = _convert_ambiguous_timestamp_to_ns(ambiguous_float_start)

scout_apm-3.3.0/src/scout_apm/core/sampler.py

@@ -0,0 +1,149 @@
+# coding=utf-8
+
+import random
+from typing import Dict, Optional, Tuple
+
+
+class Sampler:
+    """
+    Handles sampling decision logic for Scout APM.
+
+    This class encapsulates all sampling-related functionality including:
+    - Loading and managing sampling configuration
+    - Pattern matching for operations (endpoints and jobs)
+    - Making sampling decisions based on operation type and patterns
+    """
+
+    # Constants for operation type detection
+    CONTROLLER_PREFIX = "Controller/"
+    JOB_PREFIX = "Job/"
+
+    def __init__(self, config):
+        """
+        Initialize sampler with Scout configuration.
+
+        Args:
+            config: ScoutConfig instance containing sampling configuration
+        """
+        self.config = config
+        self.sample_rate = config.value("sample_rate")
+        self.sample_endpoints = config.value("sample_endpoints")
+        self.sample_jobs = config.value("sample_jobs")
+        self.ignore_endpoints = set(
+            config.value("ignore_endpoints") + config.value("ignore")
+        )
+        self.ignore_jobs = set(config.value("ignore_jobs"))
+        self.endpoint_sample_rate = config.value("endpoint_sample_rate")
+        self.job_sample_rate = config.value("job_sample_rate")
+
+    def _any_sampling(self):
+        """
+        Check if any sampling is enabled.
+
+        Returns:
+            Boolean indicating if any sampling is enabled
+        """
+        return (
+            self.sample_rate < 100
+            or self.sample_endpoints
+            or self.sample_jobs
+            or self.ignore_endpoints
+            or self.ignore_jobs
+            or self.endpoint_sample_rate is not None
+            or self.job_sample_rate is not None
+        )
+
+    def _find_matching_rate(
+        self, name: str, patterns: Dict[str, float]
+    ) -> Optional[str]:
+        """
+        Finds the matching sample rate for a given operation name.
+
+        Args:
+            name: The operation name to match
+            patterns: Dictionary of pattern to sample rate mappings
+
+        Returns:
+            The sample rate for the matching pattern or None if no match found
+        """
+
+        for pattern, rate in patterns.items():
+            if name.startswith(pattern):
+                return rate
+        return None
+
+    def _get_operation_type_and_name(
+        self, operation: str
+    ) -> Tuple[Optional[str], Optional[str]]:
+        """
+        Determines if an operation is an endpoint or job and extracts its name.
+
+        Args:
+            operation: The full operation string (e.g. "Controller/users/show")
+
+        Returns:
+            Tuple of (type, name) where type is either 'endpoint' or 'job',
+            and name is the operation name without the prefix
+        """
+        if operation.startswith(self.CONTROLLER_PREFIX):
+            return "endpoint", operation[len(self.CONTROLLER_PREFIX) :]
+        elif operation.startswith(self.JOB_PREFIX):
+            return "job", operation[len(self.JOB_PREFIX) :]
+        else:
+            return None, None
+
+    def get_effective_sample_rate(self, operation: str, is_ignored: bool) -> int:
+        """
+        Determines the effective sample rate for a given operation.
+
+        Prioritization:
+        1. Sampling rate for specific endpoint or job
+        2. Specified ignore pattern or flag for operation
+        3. Global endpoint or job sample rate
+        4. Global sample rate
+
+        Args:
+            operation: The operation string (e.g. "Controller/users/show")
+            is_ignored: boolean for if the specific transaction is ignored
+
+        Returns:
+            Integer between 0 and 100 representing sample rate
+        """
+        op_type, name = self._get_operation_type_and_name(operation)
+        patterns = self.sample_endpoints if op_type == "endpoint" else self.sample_jobs
+        ignores = self.ignore_endpoints if op_type == "endpoint" else self.ignore_jobs
+        default_operation_rate = (
+            self.endpoint_sample_rate if op_type == "endpoint" else self.job_sample_rate
+        )
+
+        if not op_type or not name:
+            return self.sample_rate
+        matching_rate = self._find_matching_rate(name, patterns)
+        if matching_rate is not None:
+            return matching_rate
+        for prefix in ignores:
+            if name.startswith(prefix) or is_ignored:
+                return 0
+        if default_operation_rate is not None:
+            return default_operation_rate
+
+        # Fall back to global sample rate
+        return self.sample_rate
+
+    def should_sample(self, operation: str, is_ignored: bool) -> bool:
+        """
+        Determines if an operation should be sampled.
+        If no sampling is enabled, always return True.
+
+        Args:
+            operation: The operation string (e.g. "Controller/users/show"
+                   or "Job/mailer")
+
+        Returns:
+            Boolean indicating whether to sample this operation
+        """
+        if not self._any_sampling():
+            return True
+        return random.randint(1, 100) <= self.get_effective_sample_rate(
+            operation, is_ignored
+        )

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/core/samplers/cpu.py

@@ -14,7 +14,7 @@ class Cpu(object):
     human_name = "Process CPU"
 
     def __init__(self):
-        self.last_run = dt.datetime.utcnow()
+        self.last_run = dt.datetime.now(dt.timezone.utc)
         self.last_cpu_times = psutil.Process().cpu_times()
         self.num_processors = psutil.cpu_count()
         if self.num_processors is None:
@@ -22,7 +22,7 @@ class Cpu(object):
             self.num_processors = 1
 
     def run(self):
-        now = dt.datetime.utcnow()
+        now = dt.datetime.now(dt.timezone.utc)
         process = psutil.Process()  # get a handle on the current process
         cpu_times = process.cpu_times()
 

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/core/samplers/thread.py

@@ -30,7 +30,7 @@ class SamplersThread(SingletonThread):
                     event = ApplicationEvent(
                         event_value=event_value,
                         event_type=event_type,
-                        timestamp=dt.datetime.utcnow(),
+                        timestamp=dt.datetime.now(dt.timezone.utc),
                         source="Pid: " + str(os.getpid()),
                     )
                     CoreAgentSocketThread.send(event)

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/core/tracked_request.py

@@ -10,6 +10,7 @@ from scout_apm.core.agent.commands import BatchCommand
 from scout_apm.core.agent.socket import CoreAgentSocketThread
 from scout_apm.core.config import scout_config
 from scout_apm.core.n_plus_one_tracker import NPlusOneTracker
+from scout_apm.core.sampler import Sampler
 from scout_apm.core.samplers.memory import get_rss_in_mb
 from scout_apm.core.samplers.thread import SamplersThread
 
@@ -23,7 +24,16 @@ class TrackedRequest(object):
     their keyname
     """
 
+    _sampler = None
+
+    @classmethod
+    def get_sampler(cls):
+        if cls._sampler is None:
+            cls._sampler = Sampler(scout_config)
+        return cls._sampler
+
     __slots__ = (
+        "sampler",
         "request_id",
         "start_time",
         "end_time",
@@ -35,6 +45,7 @@ class TrackedRequest(object):
         "n_plus_one_tracker",
         "hit_max",
         "sent",
+        "operation",
     )
 
     # Stop adding new spans at this point, to avoid exhausting memory
@@ -48,7 +59,7 @@ class TrackedRequest(object):
 
     def __init__(self):
         self.request_id = "req-" + str(uuid4())
-        self.start_time = dt.datetime.utcnow()
+        self.start_time = dt.datetime.now(dt.timezone.utc)
         self.end_time = None
         self.active_spans = []
         self.complete_spans = []
@@ -58,6 +69,7 @@ class TrackedRequest(object):
         self.n_plus_one_tracker = NPlusOneTracker()
         self.hit_max = False
         self.sent = False
+        self.operation = None
         logger.debug("Starting request: %s", self.request_id)
 
     def __repr__(self):
@@ -145,11 +157,13 @@ class TrackedRequest(object):
 
         logger.debug("Stopping request: %s", self.request_id)
         if self.end_time is None:
-            self.end_time = dt.datetime.utcnow()
+            self.end_time = dt.datetime.now(dt.timezone.utc)
 
         if self.is_real_request:
-            self.tag("mem_delta", self._get_mem_delta())
-            if not self.is_ignored() and not self.sent:
+            if not self.sent and self.get_sampler().should_sample(
+                self.operation, self.is_ignored()
+            ):
+                self.tag("mem_delta", self._get_mem_delta())
                 self.sent = True
                 batch_command = BatchCommand.from_tracked_request(self)
                 if scout_config.value("log_payload_content"):
@@ -217,7 +231,7 @@ class Span(object):
         should_capture_backtrace=True,
     ):
         self.span_id = "span-" + str(uuid4())
-        self.start_time = dt.datetime.utcnow()
+        self.start_time = dt.datetime.now(dt.timezone.utc)
         self.end_time = None
         self.request_id = request_id
         self.operation = operation
@@ -236,7 +250,7 @@ class Span(object):
         )
 
     def stop(self):
-        self.end_time = dt.datetime.utcnow()
+        self.end_time = dt.datetime.now(dt.timezone.utc)
         self.end_objtrace_counts = objtrace.get_counts()
 
     def tag(self, key, value):
@@ -252,7 +266,9 @@ class Span(object):
             return (self.end_time - self.start_time).total_seconds()
         else:
             # Current, running duration
-            return (dt.datetime.utcnow() - self.start_time).total_seconds()
+            return (
+                dt.datetime.now(tz=dt.timezone.utc) - self.start_time
+            ).total_seconds()
 
     # Add any interesting annotations to the span. Assumes that we are in the
     # process of stopping this span.

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/core/web_requests.py

@@ -96,7 +96,7 @@ def filter_element(key, value):
 def ignore_path(path):
     ignored_paths = scout_config.value("ignore")
     for ignored in ignored_paths:
-        if path.startswith(ignored):
+        if path.lstrip(" /").startswith(ignored):
             return True
     return False
 

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/django/middleware.py

@@ -122,6 +122,7 @@ class ViewTimingMiddleware(object):
         span = tracked_request.current_span()
         if span is not None:
             span.operation = get_controller_name(request)
+            tracked_request.operation = span.operation
 
     def process_exception(self, request, exception):
         """

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/dramatiq.py

@@ -17,7 +17,9 @@ class ScoutMiddleware(dramatiq.Middleware):
         tracked_request = TrackedRequest.instance()
         tracked_request.tag("queue", message.queue_name)
         tracked_request.tag("message_id", message.message_id)
-        tracked_request.start_span(operation="Job/" + message.actor_name)
+        operation = "Job/" + message.actor_name
+        tracked_request.start_span(operation=operation)
+        tracked_request.operation = operation
 
     def after_process_message(self, broker, message, result=None, exception=None):
         if self._do_nothing:

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/falcon.py

@@ -106,6 +106,7 @@ class ScoutMiddleware(object):
         span = tracked_request.start_span(
             operation=operation, should_capture_backtrace=False
         )
+        tracked_request.operation = operation
         req.context.scout_resource_span = span
 
     def _name_operation(self, req, responder, resource):

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/flask/__init__.py

@@ -47,6 +47,7 @@ class ScoutApm(object):
 
         tracked_request = TrackedRequest.instance()
         tracked_request.is_real_request = True
+        tracked_request.operation = operation
         request._scout_tracked_request = tracked_request
 
         werkzeug_track_request_data(request, tracked_request)

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/huey.py

@@ -30,6 +30,7 @@ def scout_on_pre_execute(task):
 
     operation = "Job/{}.{}".format(task.__module__, task.__class__.__name__)
     tracked_request.start_span(operation=operation)
+    tracked_request.operation = operation
 
 
 def scout_on_post_execute(task, task_value, exception):

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm/rq.py

@@ -1,6 +1,7 @@
 # coding=utf-8
 
 import datetime as dt
+import logging
 
 import wrapt
 from rq import SimpleWorker as RqSimpleWorker
@@ -14,6 +15,8 @@ from scout_apm.core.tracked_request import TrackedRequest
 install_attempted = False
 installed = None
 
+logger = logging.getLogger(__name__)
+
 
 def ensure_scout_installed():
     global install_attempted, installed
@@ -65,10 +68,16 @@ def wrap_perform(wrapped, instance, args, kwargs):
     tracked_request.is_real_request = True
     tracked_request.tag("task_id", instance.get_id())
     tracked_request.tag("queue", instance.origin)
-    queue_time = (dt.datetime.utcnow() - instance.enqueued_at).total_seconds()
+    # rq strips tzinfo from enqueued_at during serde in at least some cases
+    # internally everything uses UTC naive datetimes, so we operate on that
+    # assumption here.
+    if instance.enqueued_at.tzinfo is None:
+        queued_at = instance.enqueued_at.replace(tzinfo=dt.timezone.utc)
+    queue_time = (dt.datetime.now(dt.timezone.utc) - queued_at).total_seconds()
     tracked_request.tag("queue_time", queue_time)
-
-    with tracked_request.span(operation="Job/{}".format(instance.func_name)):
+    operation = "Job/{}".format(instance.func_name)
+    tracked_request.operation = operation
+    with tracked_request.span(operation=operation):
         try:
             return wrapped(*args, **kwargs)
         except Exception:

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scout-apm
-Version: 3.1.0
+Version: 3.3.0
 Summary: Scout Application Performance Monitoring Agent
 Home-page: https://github.com/scoutapp/scout_apm_python
 Author: Scout
@@ -70,7 +70,7 @@ To use Scout, you'll need to
 
 For full installation instructions, including information on configuring Scout
 via environment variables and troubleshooting, see our
-[Python docs](https://docs.scoutapm.com/#python-agent).
+[Python docs](https://scoutapm.com/docs/python).
 
 ## Support
 

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm.egg-info/SOURCES.txt

@@ -41,6 +41,7 @@ src/scout_apm/core/n_plus_one_tracker.py
 src/scout_apm/core/objtrace.py
 src/scout_apm/core/platform_detection.py
 src/scout_apm/core/queue_time.py
+src/scout_apm/core/sampler.py
 src/scout_apm/core/stacktracer.py
 src/scout_apm/core/threading.py
 src/scout_apm/core/tracked_request.py

{scout_apm-3.1.0 → scout_apm-3.3.0}/src/scout_apm.egg-info/requires.txt

@@ -1,5 +1,5 @@
 asgiref
-psutil<6,>=5
-urllib3
+psutil>=5
+urllib3~=2.2.0
 certifi
 wrapt<2.0,>=1.10