starred/asynq

Fork 0

mirror of https://github.com/hibiken/asynq.git synced 2026-04-26 07:25:56 +03:00

[GH-ISSUE #327] [FEATURE REQUEST] callback for archived tasks #2166

New issue

Closed

opened 2026-03-15 19:30:39 +03:00 by kerem · 3 comments

kerem commented

2026-03-15 19:30:39 +03:00

Owner

Originally created by @AlexeyBelezeko on GitHub (Sep 17, 2021).
Original GitHub issue: https://github.com/hibiken/asynq/issues/327

Originally assigned to: @hibiken on GitHub.

Right now asynq doesn't provide the functionality to notify go code about archived tasks. For example, I have a task for uploading images from one server to another. In case of failure, I want to retry this operation a few times and if the problem didn't fix I want to create a ticket or fire an alert.

I suggest adding some call back for archiving tasks to asynq server configuration.

Originally created by @AlexeyBelezeko on GitHub (Sep 17, 2021). Original GitHub issue: https://github.com/hibiken/asynq/issues/327 Originally assigned to: @hibiken on GitHub. Right now asynq doesn't provide the functionality to notify go code about archived tasks. For example, I have a task for uploading images from one server to another. In case of failure, I want to retry this operation a few times and if the problem didn't fix I want to create a ticket or fire an alert. I suggest adding some call back for archiving tasks to asynq server configuration.

kerem

2026-03-15 19:30:39 +03:00

closed this issue
added the
enhancement
label

kerem commented

2026-03-15 19:30:55 +03:00

Author

Owner

@hibiken commented on GitHub (Sep 17, 2021):

@AlexeyBelezeko Thank you for opening this issue!

I think this is a common need and we do have a hook ErrorHandler which gets invoked every time Handler.ProcessTask returns a non-nil error. We can use this hook to trigger alerts when task has reached its max-retry.

func handleTaskError(ctx context.Context, task *asynq.Task, err error) {
     // Note: Skip checking `ok` since we are sure that this context has these values.
     retried, _ := asynq.GetRetryCount(ctx)
     maxRetry, _ := asynq.GetMaxRetry(ctx)
     if retried >= maxRetry {
           // Task will be archived, trigger an alert
     }
     // handle errors (e.g. report error to error reporting service)
}

// ...

srv := asynq.NewServer(redisConnOpt, asynq.Config{
     ErrorHandler: asynq.ErrorHandlerFunc(handleTaskError),
     // ... other config options 
})

Let me know if this works!

@hibiken commented on GitHub (Sep 17, 2021): @AlexeyBelezeko Thank you for opening this issue! I think this is a common need and we do have a hook [`ErrorHandler`](https://pkg.go.dev/github.com/hibiken/asynq#Config.ErrorHandler) which gets invoked every time `Handler.ProcessTask` returns a non-nil error. We can use this hook to trigger alerts when task has reached its max-retry. ```go func handleTaskError(ctx context.Context, task *asynq.Task, err error) { // Note: Skip checking `ok` since we are sure that this context has these values. retried, _ := asynq.GetRetryCount(ctx) maxRetry, _ := asynq.GetMaxRetry(ctx) if retried >= maxRetry { // Task will be archived, trigger an alert } // handle errors (e.g. report error to error reporting service) } // ... srv := asynq.NewServer(redisConnOpt, asynq.Config{ ErrorHandler: asynq.ErrorHandlerFunc(handleTaskError), // ... other config options }) ``` Let me know if this works!

kerem commented

2026-03-15 19:31:00 +03:00

Author

Owner

@AlexeyBelezeko commented on GitHub (Sep 17, 2021):

@hibiken thank you for a quick answer. This is exactly what I've been looking for. Sorry for my blindness I found out that the same snippet contains in the ErrorHandler comment section.

@AlexeyBelezeko commented on GitHub (Sep 17, 2021): @hibiken thank you for a quick answer. This is exactly what I've been looking for. Sorry for my blindness I found out that the same snippet contains in the ErrorHandler comment section.

kerem commented

2026-03-15 19:31:05 +03:00

Author

Owner

@hibiken commented on GitHub (Sep 17, 2021):

Glad I could help!

No worries. I appreciate these issues because it's a signal that I can do a better job in documentation.

@hibiken commented on GitHub (Sep 17, 2021): Glad I could help! No worries. I appreciate these issues because it's a signal that I can do a better job in documentation.

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/asynq#2166

No description provided.

Rows
Columns