Skip to content

Commit

Permalink
Hyperlink commit and pulls on readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sudo-suhas committed Mar 31, 2021
1 parent 0e82a66 commit 5b97740
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ The module is backward compatible with github.com/gocraft/work. To switch to thi
go get github.com/gojek/work
```

#### Refresh Node.js dependencies for WebUI (`99f237a`).
#### Refresh Node.js dependencies for WebUI ([`99f237a`][commit-99f237a]).

This fixes multiple security vulnerabilities.

#### Requeue in progress jobs and clean stale lock info on stop (#1).
#### Requeue in progress jobs and clean stale lock info on stop ([#1][pull-1]).

In case there is a failover with a Redis Sentinel cluster with data loss, there can be stale lock information which can
cause job processing to be stuck if the max concurrency limit is reached. Therefore, the jobs which were in progress are
Expand All @@ -42,7 +42,7 @@ being defined for jobs.
queue. It is possible that the job was actually processed successfully by the worker, but the change for removing from
in-progress queue was lost.

#### Expose lock count & max concurrency for each job (#2, #17)
#### Expose lock count & max concurrency for each job ([#2][pull-2], [#17][pull-17])

Added to the queue info accessible from
[`work.Client.Queues()`](https://pkg.go.dev/github.com/gojek/work#Client.Queues). Useful for alerting when lock count is consistently equal to the max
Expand All @@ -51,9 +51,9 @@ concurrency possibly indicating that stale lock count is resulting in jobs not b
For the cleanup to be thorough, [`work.(*WorkerPool).Stop`](https://pkg.go.dev/github.com/gojek/work#WorkerPool.Stop)
would need to be called on each worker pool instance.

The same info is also displayed on the queues page in WebUI (#17).
The same info is also displayed on the queues page in WebUI ([#17][pull-17]).

#### Worker pool started check (#15)
#### Worker pool started check ([#15][pull-15])

Expose [`work.(*WorkerPool).Started`](https://pkg.go.dev/github.com/gojek/work#WorkerPool.Started) which can be used to check if the worker pool has been
started and is running.
Expand Down Expand Up @@ -428,3 +428,8 @@ These packages were developed by the [engineering team](https://eng.uservoice.co
[pkg-go-dev-xgo]: https://pkg.go.dev/mod/github.com/gojek/work?tab=packages
[github-workflow-badge]: https://github.com/gojek/work/workflows/build/badge.svg
[github-workflow]: https://github.com/gojek/work/actions?query=workflow%3Abuild
[commit-99f237a]: https://github.com/gojek/work/commit/99f237a
[pull-1]: https://github.com/gojek/work/pull/1
[pull-2]: https://github.com/gojek/work/pull/2
[pull-15]: https://github.com/gojek/work/pull/15
[pull-17]: https://github.com/gojek/work/pull/17

0 comments on commit 5b97740

Please sign in to comment.