Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 1abdc02

Browse files
ffe4ffe4
authored
Update names of decisions in SamplingResult (open-telemetry#1115)
1 parent 553f6e8 commit 1abdc02

File tree

4 files changed

+27
-25
lines changed

4 files changed

+27
-25
lines changed

‎opentelemetry-sdk/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
([#1091](https://github.com/open-telemetry/opentelemetry-python/pull/1091))
1919
- Drop support for Python 3.4
2020
([#1099](https://github.com/open-telemetry/opentelemetry-python/pull/1099))
21+
- Rename members of `trace.sampling.Decision` enum
22+
([#1115](https://github.com/open-telemetry/opentelemetry-python/pull/1115))
2123

2224
## Version 0.12b0
2325

‎opentelemetry-sdk/src/opentelemetry/sdk/trace/sampling.py

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -72,17 +72,17 @@
7272

7373
class Decision(enum.Enum):
7474
# IsRecording() == false, span will not be recorded and all events and attributes will be dropped.
75-
NOT_RECORD = 0
75+
IGNORE = 0
7676
# IsRecording() == true, but Sampled flag MUST NOT be set.
77-
RECORD = 1
77+
RECORD_ONLY = 1
7878
# IsRecording() == true AND Sampled flag` MUST be set.
79-
RECORD_AND_SAMPLED = 2
79+
RECORD_AND_SAMPLE = 2
8080

8181
def is_recording(self):
82-
return self in (Decision.RECORD, Decision.RECORD_AND_SAMPLED)
82+
return self in (Decision.RECORD_ONLY, Decision.RECORD_AND_SAMPLE)
8383

8484
def is_sampled(self):
85-
return self is Decision.RECORD_AND_SAMPLED
85+
return self is Decision.RECORD_AND_SAMPLE
8686

8787

8888
class SamplingResult:
@@ -140,12 +140,12 @@ def should_sample(
140140
attributes: Attributes = None,
141141
links: Sequence["Link"] = (),
142142
) -> "SamplingResult":
143-
if self._decision is Decision.NOT_RECORD:
143+
if self._decision is Decision.IGNORE:
144144
return SamplingResult(self._decision)
145145
return SamplingResult(self._decision, attributes)
146146

147147
def get_description(self) -> str:
148-
if self._decision is Decision.NOT_RECORD:
148+
if self._decision is Decision.IGNORE:
149149
return "AlwaysOffSampler"
150150
return "AlwaysOnSampler"
151151

@@ -194,10 +194,10 @@ def should_sample(
194194
attributes: Attributes = None, # TODO
195195
links: Sequence["Link"] = (),
196196
) -> "SamplingResult":
197-
decision = Decision.NOT_RECORD
197+
decision = Decision.IGNORE
198198
if trace_id & self.TRACE_ID_LIMIT < self.bound:
199-
decision = Decision.RECORD_AND_SAMPLED
200-
if decision is Decision.NOT_RECORD:
199+
decision = Decision.RECORD_AND_SAMPLE
200+
if decision is Decision.IGNORE:
201201
return SamplingResult(decision)
202202
return SamplingResult(decision, attributes)
203203

@@ -231,8 +231,8 @@ def should_sample(
231231
not parent_context.is_valid
232232
or not parent_context.trace_flags.sampled
233233
):
234-
return SamplingResult(Decision.NOT_RECORD)
235-
return SamplingResult(Decision.RECORD_AND_SAMPLED, attributes)
234+
return SamplingResult(Decision.IGNORE)
235+
return SamplingResult(Decision.RECORD_AND_SAMPLE, attributes)
236236

237237
return self._delegate.should_sample(
238238
parent_context=parent_context,
@@ -246,10 +246,10 @@ def get_description(self):
246246
return "ParentBased{{{}}}".format(self._delegate.get_description())
247247

248248

249-
ALWAYS_OFF = StaticSampler(Decision.NOT_RECORD)
249+
ALWAYS_OFF = StaticSampler(Decision.IGNORE)
250250
"""Sampler that never samples spans, regardless of the parent span's sampling decision."""
251251

252-
ALWAYS_ON = StaticSampler(Decision.RECORD_AND_SAMPLED)
252+
ALWAYS_ON = StaticSampler(Decision.RECORD_AND_SAMPLE)
253253
"""Sampler that always samples spans, regardless of the parent span's sampling decision."""
254254

255255
DEFAULT_OFF = ParentBased(ALWAYS_OFF)

‎opentelemetry-sdk/tests/trace/test_sampling.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,34 +25,34 @@
2525
class TestDecision(unittest.TestCase):
2626
def test_is_recording(self):
2727
self.assertTrue(
28-
sampling.Decision.is_recording(sampling.Decision.RECORD)
28+
sampling.Decision.is_recording(sampling.Decision.RECORD_ONLY)
2929
)
3030
self.assertTrue(
31-
sampling.Decision.is_recording(
32-
sampling.Decision.RECORD_AND_SAMPLED
33-
)
31+
sampling.Decision.is_recording(sampling.Decision.RECORD_AND_SAMPLE)
3432
)
3533
self.assertFalse(
36-
sampling.Decision.is_recording(sampling.Decision.NOT_RECORD)
34+
sampling.Decision.is_recording(sampling.Decision.IGNORE)
3735
)
3836

3937
def test_is_sampled(self):
4038
self.assertFalse(
41-
sampling.Decision.is_sampled(sampling.Decision.RECORD)
39+
sampling.Decision.is_sampled(sampling.Decision.RECORD_ONLY)
4240
)
4341
self.assertTrue(
44-
sampling.Decision.is_sampled(sampling.Decision.RECORD_AND_SAMPLED)
42+
sampling.Decision.is_sampled(sampling.Decision.RECORD_AND_SAMPLE)
4543
)
4644
self.assertFalse(
47-
sampling.Decision.is_sampled(sampling.Decision.NOT_RECORD)
45+
sampling.Decision.is_sampled(sampling.Decision.IGNORE)
4846
)
4947

5048

5149
class TestSamplingResult(unittest.TestCase):
5250
def test_ctr(self):
5351
attributes = {"asd": "test"}
54-
result = sampling.SamplingResult(sampling.Decision.RECORD, attributes)
55-
self.assertIs(result.decision, sampling.Decision.RECORD)
52+
result = sampling.SamplingResult(
53+
sampling.Decision.RECORD_ONLY, attributes
54+
)
55+
self.assertIs(result.decision, sampling.Decision.RECORD_ONLY)
5656
with self.assertRaises(TypeError):
5757
result.attributes["test"] = "mess-this-up"
5858
self.assertTrue(len(result.attributes), 1)

‎opentelemetry-sdk/tests/trace/test_trace.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -538,7 +538,7 @@ def test_sampling_attributes(self):
538538
"attr-in-both": "decision-attr",
539539
}
540540
tracer_provider = trace.TracerProvider(
541-
sampling.StaticSampler(sampling.Decision.RECORD_AND_SAMPLED,)
541+
sampling.StaticSampler(sampling.Decision.RECORD_AND_SAMPLE,)
542542
)
543543

544544
self.tracer = tracer_provider.get_tracer(__name__)

0 commit comments

Comments
 (0)