Skip to content

Commit 0ddf3ad

Browse files
authored
Merge pull request #87 from Particular/PhilBastian-patch-1
Grammar and wording edits
2 parents 9fec635 + 512c249 commit 0ddf3ad

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

docs.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,12 @@ The sample consists of 4 applications hosting MassTransit message producers and
99

1010
![System Overview](diagram.svg "width=680")
1111

12-
`ClientUI` application generates `PlaceOder` messages at continuous rate that trigger follow-up message flow in the other parts of the system.
12+
`ClientUI` application generates `PlaceOrder` messages that trigger follow-up message flows in the other parts of the system.
1313

1414
### Experiencing failures
1515

16-
In the UI, press the `Run scenario` button.
17-
18-
All consumers provide ability to change message processing failure rate by pressing <kbd>I</kbd> to increase and <kbd>D</kbd> to decrease it. Each consumer application shows a list of available commands and a summary of currently used configuration values.
19-
20-
````
21-
22-
For example, whenever the `Billing` consumer fails to process a message, a log entry gets printed to the command line window, and the message is moved to the `bill-order_error` queue.
16+
In the UI, press the `Run scenario` button. This will generate a set of `PlaceOrder` messages, configured to fail at different consumers through the showcase.
17+
For example, whenever the `Billing` consumer fails to process a message, the message is moved to the `bill-order_error` queue.
2318

2419
```code
2520
fail: MassTransit.ReceiveTransport[0]
@@ -30,13 +25,13 @@ fail: MassTransit.ReceiveTransport[0]
3025
at MassTransit.DependencyInjection.ScopeConsumerFactory`1.Send[TMessage](ConsumeContext`1 context, IPipe`1 next) in /_/src/MassTransit/DependencyInjection/DependencyInjection/ScopeConsumerFactory.cs:line 22
3126
at MassTransit.DependencyInjection.ScopeConsumerFactory`1.Send[TMessage](ConsumeContext`1 context, IPipe`1 next) in /_/src/MassTransit/DependencyInjection/DependencyInjection/ScopeConsumerFactory.cs:line 22
3227
at MassTransit.Middleware.ConsumerMessageFilter`2.MassTransit.IFilter<MassTransit.ConsumeContext<TMessage>>.Send(ConsumeContext`1 context, IPipe`1 next) in /_/src/MassTransit/Middleware/ConsumerMessageFilter.cs:line 48
33-
````
28+
```
3429

3530
### Handling failures with the Particular Platform
3631

3732
#### Running the sample
3833

39-
In order, to see how the Particular Platfrom improves the failed messages management, start the containers responsible for running the platform:
34+
To see how the Particular Platfrom improves failed message management, start the containers responsible for running the platform:
4035

4136
### **RabbitMQ**
4237

@@ -63,31 +58,33 @@ Run docker command below from the `src` folder in a CLI
6358
docker compose -f docker-compose-base.yml -f compose-azure.yml --env-file asb.env up -d
6459
```
6560

66-
This will make the platform monitor error messages for all the consumers in the sample system. Upon failure any moved by a MassTransit consumer to an error queue will be ingest and index by the platform.
61+
This will make the platform monitor error messages for all the consumers in the sample system. Upon failure, any message moved by a MassTransit consumer to an error queue will be ingested by the platform.
6762

6863
#### Inspecting failures
6964

70-
Navigate to [http://localhost:9090](http://localhost:9090), or click the `View in ServicePulse` button to see the details on the failures ingested by the platform.
65+
Navigate to [http://localhost:9090](http://localhost:9090), or click the `View in ServicePulse` button to see the details on failures ingested by the platform.
7166

7267
![Service Pulse Dashboard](service-pulse-dashboard-failed-messages.png "Message processing errors summary view")
7368

7469
#### Scheduling message reprocessing
7570

76-
Click on the "Failed Messages" button at the top of the page to see all failed messages ingested by the platform grouped by the exception trype and stack trace.
71+
Click on the "Failed Messages" button at the top of the page to see all failed messages ingested by the platform, grouped by the exception type and stack trace.
7772

7873
![Service Pulse Failed Messages](service-pulse-dashboard-failed-messages-groups.png "Failed messages grouping")
7974

80-
Drilling into an existing group to see the list of individual processing failures. Clicking on any
81-
of the rows in the list shows detailed information on a given failed message in the headers and message body tabs.
75+
Drill into an existing group to see the list of individual processing failures. Clicking on any of the rows in the list shows detailed information of a given failed message in the headers and message body tabs.
8276

8377
A failed message can be scheduled for reprocessing by clicking the `Retry message` button.
8478

8579
![Service Pulse Failed Message View](service-pulse-failed-message-view.png "Failed message details view")
8680

8781
#### Editing messages before reprocessing
8882

89-
Go to the details page for one of the failed messages and click the `Edit & retry` button at the top. The pop-up window shows the headers collection and the message body in two separate tabs.
83+
Go to the details page for one of the failed messages and click the `Edit & retry` button. The pop-up window shows the headers collection and the message body in two separate tabs.
9084

9185
Navigate to the `Message Body` tab, change the last digit of the `orderId` value, and click "Retry" to schedule the message for reprocessing.
9286

87+
> [!WARNING]
88+
> Changing or deleting header values may change or cause issues with the subsequent re-processing. It is recommended that these values are not changed if you are unsure of their purpose.
89+
9390
![Edit Message View](service-pulse-edit-before-retry.png "Edit & Retry view showing the message body")

0 commit comments

Comments
 (0)