Skip to content

Commit

Permalink
Merge pull request #106 from Particular/udidahan-patch-1
Browse files Browse the repository at this point in the history
Remove unnecessary mention of ServicePulse
  • Loading branch information
udidahan authored Feb 4, 2025
2 parents fe57d46 + 84641a3 commit 81b97a3
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 15 deletions.
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ This showcase consists of 4 processes hosting MassTransit message producers and

## Launching the Showcase in Docker

The showcase requires a connection to a broker (by default RabbitMQ), [ServiceControl](https://hub.docker.com/r/particular/servicecontrol) container, [ServicePulse](https://hub.docker.com/r/particular/servicepulse) container and the [MassTransit Connector for ServiceControl](https://hub.docker.com/r/particular/servicecontrol-masstransit-connector) container.
To help getting started we have created a few docker compose files that orchestrate all this setup for you.

Run the docker command below from the `src` folder in a terminal.
* First, make sure you've pulled down the repository to your machine.
* Second, open a terminal and navigate to the `src` folder in your local copy of the repository.
* Third, run the following command:

```cmd
docker compose -p particular-platform-showcase -f docker-compose-base.yml -f compose-rabbitmq.yml --env-file rabbit.env up -d
Expand Down Expand Up @@ -68,21 +69,21 @@ Run the solution to start the demo.

## Opening the showcase UI

Navigate to http://localhost:61335/ to see the UI. Click `Run Scenario` to start the showcase scenario and generate some simulated message handling failures.
Navigate to http://localhost:61335/ to see the UI.

## Handling failures with the Particular Platform
Click `Run Scenario` to send some messages and generate some simulated failures.

### Inspecting failures
## Managing errors

Navigate to [http://localhost:9090](http://localhost:9090) in a new tab, or click the `View in ServicePulse` button, to see the details on failures ingested by the platform.
Navigate to [http://localhost:9090](http://localhost:9090) in a new tab, or click the `View Failures` button, to see the details on failures ingested by the platform.

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

### Scheduling message reprocessing

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.

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

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.

Expand All @@ -91,7 +92,7 @@ A failed message can be scheduled for reprocessing by clicking the `Retry messag
> [!NOTE]
> It may take several seconds after retrying a message for it to appear again in the consumer's input queue
![Service Pulse Failed Message View](docs/service-pulse-failed-message-view.png "Failed message details view")
![Failed Message View](docs/service-pulse-failed-message-view.png "Failed message details view")

### Editing messages before reprocessing

Expand All @@ -106,11 +107,16 @@ Navigate to the `Message Body` tab and change some of the contents of the messag

### Viewing retries

Return to the showcase UI to see that the retries have now been successfully handled.
Return to the Showcase UI to see that the retries have now been successfully handled.

### Troubleshooting

Having issues?

- Check logs in docker. Ensure that there are no port clashes with existing containers or services on your machine.
- Ask any questions on [our forum](https://discuss.particular.net/tag/masstransit)
- Check that all containers are running:
- RabbitMQ
- [ServicePulse](https://hub.docker.com/r/particular/servicepulse)
- [ServiceControl](https://hub.docker.com/r/particular/servicecontrol)
- [MassTransit Connector for ServiceControl](https://hub.docker.com/r/particular/servicecontrol-masstransit-connector)
- Ask any questions you may have on [our forum](https://discuss.particular.net/tag/masstransit)
2 changes: 1 addition & 1 deletion src/frontend/src/components/BillingEndpoint.vue
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ function toggleFailOnRetries() {
target="_blank"
:href="`http://localhost:9090/#/failed-messages/message/${message.messageViewId}`"
>
View failure in ServicePulse
View failure details
</a>
</template>
<template v-else-if="isOrderBilled(message.message)">
Expand Down
2 changes: 1 addition & 1 deletion src/frontend/src/components/ClientEndpoint.vue
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ async function runScenario() {
</button>
<a target="_blank" href="http://localhost:9090/#/failed-messages/">
<button type="button" class="secondary view-servicepulse">
View Failures in ServicePulse
View Failures
</button>
</a>
<span class="note">
Expand Down
2 changes: 1 addition & 1 deletion src/frontend/src/components/SalesEndpoint.vue
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ function toggleFailOnRetries() {
<a
target="_blank"
:href="`http://localhost:9090/#/failed-messages/message/${message.messageViewId}`"
>View failure in ServicePulse</a
>View failure details</a
>
</template>
<template v-else-if="isOrderPlaced(message.message)">
Expand Down
2 changes: 1 addition & 1 deletion src/frontend/src/components/ShippingEndpoint.vue
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ function toggleFailOnRetries() {
target="_blank"
:href="`http://localhost:9090/#/failed-messages/message/${message.messageViewId}`"
>
View failure in ServicePulse
View failure details
</a>
</template>
<template v-else>
Expand Down

0 comments on commit 81b97a3

Please sign in to comment.