rename agent_sampling_rules to agent_based_samplers to improve clarity

Author: mabdinur

ddtrace/_trace/processor/__init__.py

@@ -132,7 +132,7 @@ def __init__(
         compute_stats_enabled: bool,
         single_span_rules: List[SpanSamplingRule],
         apm_opt_out: bool,
-        agent_sampling_rules: Optional[dict] = None,
+        agent_based_samplers: Optional[dict] = None,
     ):
         super(TraceSamplingProcessor, self).__init__()
         self._compute_stats_enabled = compute_stats_enabled
@@ -146,10 +146,10 @@ def __init__(
                 rate_limit=1,
                 rate_limit_window=60e9,
                 rate_limit_always_on=True,
-                agent_sampling_rules=agent_sampling_rules,
+                agent_based_samplers=agent_based_samplers,
             )
         else:
-            self.sampler = DatadogSampler(agent_sampling_rules=agent_sampling_rules)
+            self.sampler = DatadogSampler(agent_based_samplers=agent_based_samplers)
 
     def process_trace(self, trace: List[Span]) -> Optional[List[Span]]:
         if trace:
@@ -506,7 +506,7 @@ def _reset(self):
             config._trace_compute_stats,
             get_span_sampling_rules(),
             asm_config._apm_opt_out,
-            self.sampling_processor.sampler._agent_sampling_rules,
+            self.sampling_processor.sampler._agent_based_samplers,
         )
         self._traces = defaultdict(lambda: _Trace())
         self._span_metrics = {

ddtrace/_trace/sampler.py

@@ -75,7 +75,7 @@ class DatadogSampler:
         "limiter",
         "rules",
         "_rate_limit_always_on",
-        "_agent_sampling_rules",
+        "_agent_based_samplers",
     )
     _default_key = "service:,env:"
 
@@ -85,7 +85,7 @@ def __init__(
         rate_limit: Optional[int] = None,
         rate_limit_window: float = 1e9,
         rate_limit_always_on: bool = False,
-        agent_sampling_rules: Optional[Dict[str, RateSampler]] = None,
+        agent_based_samplers: Optional[Dict[str, RateSampler]] = None,
     ):
         """
         Constructor for DatadogSampler sampler
@@ -102,7 +102,7 @@ def __init__(
         else:
             self.rules: List[SamplingRule] = rules or []
         # Set Agent based samplers
-        self._agent_sampling_rules = agent_sampling_rules or {}
+        self._agent_based_samplers = agent_based_samplers or {}
         # Set rate limiter
         self._rate_limit_always_on: bool = rate_limit_always_on
         if rate_limit is None:
@@ -120,10 +120,10 @@ def update_rate_by_service_sample_rates(self, rate_by_service: Dict[str, float])
         samplers: Dict[str, RateSampler] = {}
         for key, sample_rate in rate_by_service.items():
             samplers[key] = RateSampler(sample_rate)
-        self._agent_sampling_rules = samplers
+        self._agent_based_samplers = samplers
 
     def __str__(self):
-        rates = {key: sampler.sample_rate for key, sampler in self._agent_sampling_rules.items()}
+        rates = {key: sampler.sample_rate for key, sampler in self._agent_based_samplers.items()}
         return "{}(agent_rates={!r}, limiter={!r}, rules={!r}), rate_limit_always_on={!r}".format(
             self.__class__.__name__,
             rates,
@@ -182,11 +182,11 @@ def sample(self, span: Span) -> bool:
             sample_rate = matched_rule.sample_rate
         else:
             key = self._key(span.service, span.get_tag(ENV_KEY))
-            if key in self._agent_sampling_rules:
+            if key in self._agent_based_samplers:
                 # Agent service based sampling
                 agent_service_based = True
-                sampled = self._agent_sampling_rules[key].sample(span)
-                sample_rate = self._agent_sampling_rules[key].sample_rate
+                sampled = self._agent_based_samplers[key].sample(span)
+                sample_rate = self._agent_based_samplers[key].sample_rate
 
         if matched_rule or self._rate_limit_always_on:
             # Avoid rate limiting when trace sample rules and/or sample rates are NOT provided

tests/integration/test_priority_sampling.py

@@ -40,7 +40,7 @@ def _prime_tracer_with_priority_sample_rate_from_agent(t, service):
     t.flush()
 
     sampler_key = "service:{},env:".format(service)
-    while sampler_key not in t._span_aggregator.sampling_processor.sampler._agent_sampling_rules:
+    while sampler_key not in t._span_aggregator.sampling_processor.sampler._agent_based_samplers:
         time.sleep(1)
         s = t.trace("operation", service=service)
         s.finish()
@@ -69,9 +69,9 @@ def test_priority_sampling_rate_honored():
 
     _prime_tracer_with_priority_sample_rate_from_agent(t, service)
     sampler_key = "service:{},env:".format(service)
-    assert sampler_key in t._span_aggregator.sampling_processor.sampler._agent_sampling_rules
+    assert sampler_key in t._span_aggregator.sampling_processor.sampler._agent_based_samplers
 
-    rate_from_agent = t._span_aggregator.sampling_processor.sampler._agent_sampling_rules[sampler_key].sample_rate
+    rate_from_agent = t._span_aggregator.sampling_processor.sampler._agent_based_samplers[sampler_key].sample_rate
     assert 0 < rate_from_agent < 1
 
     _turn_tracer_into_dummy(t)
@@ -102,10 +102,10 @@ def test_priority_sampling_response():
     _id = time.time()
     service = "my-svc-{}".format(_id)
     sampler_key = "service:{},env:".format(service)
-    assert sampler_key not in t._span_aggregator.sampling_processor.sampler._agent_sampling_rules
+    assert sampler_key not in t._span_aggregator.sampling_processor.sampler._agent_based_samplers
     _prime_tracer_with_priority_sample_rate_from_agent(t, service)
     assert (
-        sampler_key in t._span_aggregator.sampling_processor.sampler._agent_sampling_rules
+        sampler_key in t._span_aggregator.sampling_processor.sampler._agent_based_samplers
     ), "after fetching priority sample rates from the agent, the tracer should hold those rates"
     t.shutdown()
 
@@ -154,13 +154,13 @@ def test_sampling_configurations_are_not_reset_on_tracer_configure():
 
     _prime_tracer_with_priority_sample_rate_from_agent(t, service)
 
-    agent_sampling_rules = t._span_aggregator.sampling_processor.sampler._agent_sampling_rules
+    agent_based_samplers = t._span_aggregator.sampling_processor.sampler._agent_based_samplers
     trace_sampling_rules = t._span_aggregator.sampling_processor.sampler.rules
     single_span_sampling_rules = t._span_aggregator.sampling_processor.single_span_rules
     assert (
-        agent_sampling_rules and trace_sampling_rules and single_span_sampling_rules
+        agent_based_samplers and trace_sampling_rules and single_span_sampling_rules
     ), "Expected agent sampling rules, span sampling rules, trace sampling rules to be set"
-    f", got {agent_sampling_rules}, {trace_sampling_rules}, {single_span_sampling_rules}"
+    f", got {agent_based_samplers}, {trace_sampling_rules}, {single_span_sampling_rules}"
 
     class CustomFilter(TraceFilter):
         def process_trace(self, trace):
@@ -171,9 +171,9 @@ def process_trace(self, trace):
 
     t.configure(trace_processors=[CustomFilter()])  # Triggers AgentWriter recreate
     assert (
-        t._span_aggregator.sampling_processor.sampler._agent_sampling_rules == agent_sampling_rules
-    ), f"Expected agent sampling rules to be set to {agent_sampling_rules}, "
-    f"got {t._span_aggregator.sampling_processor.sampler._agent_sampling_rules}"
+        t._span_aggregator.sampling_processor.sampler._agent_based_samplers == agent_based_samplers
+    ), f"Expected agent sampling rules to be set to {agent_based_samplers}, "
+    f"got {t._span_aggregator.sampling_processor.sampler._agent_based_samplers}"
 
     assert (
         t._span_aggregator.sampling_processor.sampler.rules == trace_sampling_rules

tests/tracer/test_sampler.py

@@ -820,7 +820,7 @@ def test_update_rate_by_service_sample_rates(priority_sampler):
     for given_rates in cases:
         priority_sampler.update_rate_by_service_sample_rates(given_rates)
         actual_rates = {}
-        for k, v in priority_sampler._agent_sampling_rules.items():
+        for k, v in priority_sampler._agent_based_samplers.items():
             actual_rates[k] = v.sample_rate
         assert given_rates == actual_rates, "sampler should store the rates it's given"
     # It's important to also test in reverse mode for we want to make sure key deletion
@@ -829,7 +829,7 @@ def test_update_rate_by_service_sample_rates(priority_sampler):
     for given_rates in cases:
         priority_sampler.update_rate_by_service_sample_rates(given_rates)
         actual_rates = {}
-        for k, v in priority_sampler._agent_sampling_rules.items():
+        for k, v in priority_sampler._agent_based_samplers.items():
             actual_rates[k] = v.sample_rate
         assert given_rates == actual_rates, "sampler should store the rates it's given"