diff --git a/sentry_sdk/api.py b/sentry_sdk/api.py index d60434079c..a6b3c293dc 100644 --- a/sentry_sdk/api.py +++ b/sentry_sdk/api.py @@ -388,6 +388,10 @@ def start_transaction( def set_measurement(name, value, unit=""): # type: (str, float, MeasurementUnit) -> None + """ + .. deprecated:: 2.28.0 + This function is deprecated and will be removed in the next major release. + """ transaction = get_current_scope().transaction if transaction is not None: transaction.set_measurement(name, value, unit) diff --git a/sentry_sdk/tracing.py b/sentry_sdk/tracing.py index ca249fe8fe..fc40221b9f 100644 --- a/sentry_sdk/tracing.py +++ b/sentry_sdk/tracing.py @@ -613,6 +613,16 @@ def set_status(self, value): def set_measurement(self, name, value, unit=""): # type: (str, float, MeasurementUnit) -> None + """ + .. deprecated:: 2.28.0 + This function is deprecated and will be removed in the next major release. + """ + + warnings.warn( + "`set_measurement()` is deprecated and will be removed in the next major version. Please use `set_data()` instead.", + DeprecationWarning, + stacklevel=2, + ) self._measurements[name] = {"value": value, "unit": unit} def set_thread(self, thread_id, thread_name): @@ -1061,6 +1071,16 @@ def finish( def set_measurement(self, name, value, unit=""): # type: (str, float, MeasurementUnit) -> None + """ + .. deprecated:: 2.28.0 + This function is deprecated and will be removed in the next major release. + """ + + warnings.warn( + "`set_measurement()` is deprecated and will be removed in the next major version. Please use `set_data()` instead.", + DeprecationWarning, + stacklevel=2, + ) self._measurements[name] = {"value": value, "unit": unit} def set_context(self, key, value): diff --git a/tests/tracing/test_misc.py b/tests/tracing/test_misc.py index 040fb24213..b954d36e1a 100644 --- a/tests/tracing/test_misc.py +++ b/tests/tracing/test_misc.py @@ -323,6 +323,48 @@ def test_set_meaurement_public_api(sentry_init, capture_events): assert event["measurements"]["metric.bar"] == {"value": 456, "unit": "second"} +def test_set_measurement_deprecated(sentry_init): + sentry_init(traces_sample_rate=1.0) + + with start_transaction(name="measuring stuff") as trx: + with pytest.warns(DeprecationWarning): + set_measurement("metric.foo", 123) + + with pytest.warns(DeprecationWarning): + trx.set_measurement("metric.bar", 456) + + with start_span(op="measuring span") as span: + with pytest.warns(DeprecationWarning): + span.set_measurement("metric.baz", 420.69, unit="custom") + + +def test_set_meaurement_compared_to_set_data(sentry_init, capture_events): + """ + This is just a test to see the difference + between measurements and data in the resulting event payload. + """ + sentry_init(traces_sample_rate=1.0) + + events = capture_events() + + with start_transaction(name="measuring stuff") as transaction: + transaction.set_measurement("metric.foo", 123) + transaction.set_data("metric.bar", 456) + + with start_span(op="measuring span") as span: + span.set_measurement("metric.baz", 420.69, unit="custom") + span.set_data("metric.qux", 789) + + (event,) = events + assert event["measurements"]["metric.foo"] == {"value": 123, "unit": ""} + assert event["contexts"]["trace"]["data"]["metric.bar"] == 456 + assert event["spans"][0]["measurements"]["metric.baz"] == { + "value": 420.69, + "unit": "custom", + } + assert event["spans"][0]["data"]["metric.qux"] == 789 + + @pytest.mark.parametrize( "trace_propagation_targets,url,expected_propagation_decision", [