8000 Add runtime in success signal by sasirven · Pull Request #9516 · celery/celery · GitHub
[go: up one dir, main page]
Skip to content

Add runtime in success signal #9516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add runtime in success signal #9516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c04289
Add runtime in success signal
sasirven Jan 23, 2025
0e36ccf
Merge branch 'main' into main
auvipy Jun 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion celery/app/trace.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -528,7 +528,7 @@ def trace_task(uuid, args, kwargs, request=None):
if task_on_success:
task_on_success(retval, uuid, args, kwargs)
if success_receivers:
send_success(sender=task, result=retval)
send_success(sender=task, result=retval, runtime=T)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add a test case to verify this change?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry if the test isn't perfect, I did my best to fit it in with everything else :D.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello, may I resolve this change request, or are further changes required?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it seems good. but since we are on the middle of a new stable release, so thinking if we should add or hold this for a while

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, completely understand, no problem!

if _does_info:
info(LOG_SUCCESS, {
'id': uuid,
Expand Down
2 changes: 1 addition & 1 deletion celery/signals.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
)
task_success = Signal(
name='task_success',
providing_args={'result'},
providing_args={'result', 'runtime'},
)
task_retry = Signal(
name='task_retry',
Expand Down
3 changes: 3 additions & 0 deletions docs/userguide/signals.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,9 @@ Provides arguments
* ``result``
Return value of the task.

* ``runtime``
Time in seconds it took to execute the task.

.. signal:: task_failure

``task_failure``
Expand Down
42 changes: 22 additions & 20 deletions t/unit/tasks/test_trace.py
View file
Open in desktop
38FB
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ def trace(
):
t = build_tracer(task.name, task, eager=eager, propagate=propagate, app=app, **opts)
ret = t(task_id, args, kwargs, request)
return ret.retval, ret.info
return ret.retval, ret.info, ret.runtime


class TraceCase:
Expand Down Expand Up @@ -53,7 +53,7 @@ def trace(self, *args, **kwargs):

class test_trace(TraceCase):
def test_trace_successful(self):
retval, info = self.trace(self.add, (2, 2), {})
retval, info, _ = self.trace(self.add, (2, 2), {})
assert info is None
assert retval == 4

Expand Down Expand Up @@ -123,8 +123,10 @@ def test_with_success_receivers(self):
on_success = Mock()
signals.task_success.connect(on_success)
try:
self.trace(self.add, (2, 2), {})
_, _, expected_runtime = self.trace(self.add, (2, 2), {})
on_success.assert_called()
runtime = on_success.call_args[1]['runtime']
assert expected_runtime == runtime
finally:
signals.task_success.receivers[:] = []

Expand Down Expand Up @@ -288,7 +290,7 @@ def test_when_Ignore(self, mock_traceback_clear):
def ignored():
raise Ignore()

retval, info = self.trace(ignored, (), {})
retval, info, _ = self.trace(ignored, (), {})
assert info.state == states.IGNORED
mock_traceback_clear.assert_called()

Expand All @@ -298,7 +300,7 @@ def test_when_Reject(self, mock_traceback_clear):
def rejecting():
raise Reject()

retval, info = self.trace(rejecting, (), {})
retval, info, _ = self.trace(rejecting, (), {})
assert info.state == states.REJECTED
mock_traceback_clear.assert_called()

Expand All @@ -312,7 +314,7 @@ def test_callbacks__scalar(self, maybe_signature):
sig = Mock(name='sig')
request = {'callbacks': [sig], 'root_id': 'root'}
maybe_signature.return_value = sig
retval, _ = self.trace(self.add, (2, 2), {}, request=request)
retval, _, _ = self.trace(self.add, (2, 2), {}, request=request)
sig.apply_async.assert_called_with(
(4,), parent_id='id-1', root_id='root', priority=None
)
Expand All @@ -323,7 +325,7 @@ def test_chain_proto2(self, maybe_signature):
sig2 = Mock(name='sig2')
request = {'chain': [sig2, sig], 'root_id': 'root'}
maybe_signature.return_value = sig
retval, _ = self.trace(self.add, (2, 2), {}, request=request)
retval, _, _ = self.trace(self.add, (2, 2), {}, request=request)
sig.apply_async.assert_called_with(
(4,), parent_id='id-1', root_id='root', chain=[sig2], priority=None
)
Expand All @@ -339,7 +341,7 @@ def test_chain_inherit_parent_priority(self, maybe_signature):
'delivery_info': {'priority': 42},
}
maybe_signature.return_value = sig
retval, _ = self.trace(self.add, (2, 2), {}, request=request)
retval, _, _ = self.trace(self.add, (2, 2), {}, request=request)
sig.apply_async.assert_called_with(
(4,), parent_id='id-1', root_id='root', chain=[sig2], priority=42
)
Expand All @@ -350,7 +352,7 @@ def test_callbacks__EncodeError(self, maybe_signature):
request = {'callbacks': [sig], 'root_id': 'root'}
maybe_signature.return_value = sig
sig.apply_async.side_effect = EncodeError()
retval, einfo = self.trace(self.add, (2, 2), {}, request=request)
retval, einfo, _ = self.trace(self.add, (2, 2), {}, request=request)
assert einfo.state == states.FAILURE

@patch('celery.canvas.maybe_signature')
Expand All @@ -366,7 +368,7 @@ def pass_value(s, *args, **kwargs):
return s

maybe_signature.side_effect = pass_value
retval, _ = self.trace(self.add, (2, 2), {}, request=request)
retval, _, _ = self.trace(self.add, (2, 2), {}, request=request)
group_.assert_called_with((4,), parent_id='id-1', root_id='root', priority=None)
sig3.apply_async.assert_called_with(
(4,), parent_id='id-1', root_id='root', priority=None
Expand All @@ -385,7 +387,7 @@ def pass_value(s, *args, **kwargs):
return s

maybe_signature.side_effect = pass_value
retval, _ = self.trace(self.add, (2, 2), {}, request=request)
retval, _, _ = self.trace(self.add, (2, 2), {}, request=request)
sig1.apply_async.assert_called_with(
(4,), parent_id='id-1', root_id='root', priority=None
)
Expand All @@ -400,15 +402,15 @@ def test_trace_SystemExit(self):
@patch('celery.app.trace.traceback_clear')
def test_trace_Retry(self, mock_traceback_clear):
exc = Retry('foo', 'bar')
_, info = self.trace(self.raises, (exc,), {})
_, info, _ = self.trace(self.raises, (exc,), {})
assert info.state == states.RETRY
assert info.retval is exc
mock_traceback_clear.assert_called()

@patch('celery.app.trace.traceback_clear')
def test_trace_exception(self, mock_traceback_clear):
exc = KeyError('foo')
_, info = self.trace(self.raises, (exc,), {})
_, info, _ = self.trace(self.raises, (exc,), {})
assert info.state == states.FAILURE
assert info.retval is exc
mock_traceback_clear.assert_called()
Expand Down Expand Up @@ -490,8 +492,8 @@ def add(x, y):
task_id = str(uuid4())
request = {'id': task_id, 'delivery_info': {'redelivered': True}}

assert trace(self.app, add, (1, 1), task_id=task_id, request=request) == (2, None)
assert trace(self.app, add, (1, 1), task_id=task_id, request=request) == (None, None)
assert trace(self.app, add, (1, 1), task_id=task_id, request=request) == (2, None, ANY)
assert trace(self.app, add, (1, 1), task_id=task_id, request=request) == (None, None, ANY)

self.app.conf.worker_deduplicate_successful_tasks = False

Expand All @@ -512,8 +514,8 @@ def add(x, y):

with patch('celery.app.trace.AsyncResult') as async_result_mock:
async_result_mock().state.return_value = PENDING
assert trace(self.app, add, (1, 1), task_id=task_id, request=request) == (2, None)
assert trace(self.app, add, (1, 1), task_id=task_id, request=request) == (2, None)
assert trace(self.app, add, (1, 1), task_id=task_id, request=request) == (2, None, ANY)
assert trace(self.app, add, (1, 1), task_id=task_id, request=request) == (2, None, ANY)

self.app.conf.worker_deduplicate_successful_tasks = False

Expand All @@ -533,10 +535,10 @@ def add(x, y):
request = {'id': task_id, 'delivery_info': {'redelivered': True}}

with patch('celery.app.trace.AsyncResult') as async_result_mock:
assert trace(self.app, add, (1, 1), task_id=task_id, request=request) == (2, None)
assert trace(self.app, add, (1, 1), task_id=task_id, request=request) == (2, None, ANY)
state_property = PropertyMock(side_effect=BackendGetMetaError)
type(async_result_mock()).state = state_property
assert trace(self.app, add, (1, 1), task_id=task_id, request=request) == (2, None)
assert trace(self.app, add, (1, 1), task_id=task_id, request=request) == (2, None, ANY)

self.app.conf.worker_deduplicate_successful_tasks = False

Expand All @@ -559,7 +561,7 @@ def add(x, y):
successful_requests.add(task_id)

assert trace(self.app, add, (1, 1), task_id=task_id,
request=request) == (None, None)
request=request) == (None, None, ANY)

successful_requests.clear()
self.app.conf.worker_deduplicate_successful_tasks = False
Expand Down
0