Skip to content

Commit c3a6a55

Browse files
authored
Merge pull request #7008 from Particular/show-pending-retries
Document `SHOW_PENDING_RETRIES` and restructure
2 parents 56b23cb + 5217225 commit c3a6a55

File tree

1 file changed

+27
-14
lines changed

1 file changed

+27
-14
lines changed

servicepulse/intro-pending-retries.md

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,33 @@
11
---
22
title: Pending Retries Message Management
33
summary: Describes how ServicePulse detects and monitors failed messages in the pending state, and allows retrying, or deleting them.
4-
reviewed: 2024-08-13
4+
reviewed: 2025-02-20
55
---
66

7-
In ServicePulse versions 1.6.6 and above, there is a screen to view and manage failed messages that have been requested to be retried but have not completed yet.
8-
9-
Pending retries messages can be found by navigating to the pending retries screen.
7+
The pending retries view shows failed messages that have been requested to be retried but have not completed yet. Pending retries messages can be found by navigating to the pending retries screen.
108

119
![Pending Retries Tab](images/pending-retries.png 'width=500')
1210

13-
### Displaying the Pending Retries view
11+
A pending retry message that is retried will remain in the pending retry list until it is resolved or fails again.
1412

15-
In ServicePulse version 1.7.0 and above, the Pending Retries screen is hidden by default. To make it visible, follow the steps according to the ServicePulse version that is used.
1613

17-
### ServicePulse version 1.7.0 to 1.20.0
14+
> [!NOTE]
15+
> Supported in ServicePulse versions 1.6.6 and above.
1816
19-
Change the following value in `<path-to-ServicePulse-installation>\app\js\app.constants.js` to `true`:
17+
## Howto enable Pending Retries view
2018

21-
```
22-
.constant('showPendingRetry', true)
23-
```
19+
To make it visible, follow the steps according to the ServicePulse version that is used.
20+
21+
> [!NOTE]
22+
> In ServicePulse version 1.7.0 and above, the Pending Retries screen is hidden by default.
23+
24+
### Containers
2425

25-
### ServicePulse version 1.20.0 and above
26+
Add the environment variable `SHOW_PENDING_RETRIES=true` to the container configuration.
27+
28+
### Windows Service
29+
30+
#### ServicePulse version 1.20.0 and above
2631

2732
Add a `showPendingRetry` value in `<path-to-ServicePulse-installation>\app\js\app.constants.js` set to `true`:
2833

@@ -36,7 +41,15 @@ window.defaultConfig = {
3641
};
3742
```
3843

39-
### Messages that are Pending Retries
44+
#### ServicePulse version 1.7.0 to 1.20.0
45+
46+
Change the following value in `<path-to-ServicePulse-installation>\app\js\app.constants.js` to `true`:
47+
48+
```
49+
.constant('showPendingRetry', true)
50+
```
51+
52+
## Messages that are Pending Retries
4053

4154
The Pending Retries screen shows failed messages for which a retry was requested and for which the retry is still pending. The status of retried failures is updated when the message is processed again as either an audited message (i.e. a successful delivery) or as a failed message.
4255

@@ -56,7 +69,7 @@ Results can be filtered by queue name using the search functionality:
5669

5770
Detailed information about the message, such as the failure timestamp, endpoint, stack trace of the error, etc., is displayed in the same manner as on the [Failed Messages](intro-failed-messages.md) page, additionally providing information about [redirects](/servicepulse/redirect.md) if one is created for this queue.
5871

59-
### Retrying a message
72+
## Retrying a message
6073

6174
> [!WARNING]
6275
> Failed messages that are currently in the pending status can be retried; however this feature should be used with care. Retrying pending messages can cause the same message to be processed multiple times. Do not retry a message if it has been processed by the endpoint. In this context "processed" includes both the successful handling of the message and the failure state of it being sent to the error queue.

0 commit comments

Comments
 (0)