Skip to content

Commit

Permalink
Merge branch 'main' into improve_tryit_doco
Browse files Browse the repository at this point in the history
  • Loading branch information
irinascurtu authored Feb 5, 2025
2 parents d04e430 + d81883f commit 88835ba
Show file tree
Hide file tree
Showing 17 changed files with 825 additions and 863 deletions.
28 changes: 22 additions & 6 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,26 @@
By accessing code under the [Particular Software GitHub Organization](https://github.com/Particular) (Particular Software) here, you are agreeing to the following licensing terms.
If you do not agree to these terms, do not access Particular Software code.
By accessing code under the [Particular Software GitHub Organization](https://github.com/Particular) (Particular Software) here, you are agreeing to the following licensing terms. If you do not agree to these terms, do not access Particular Software code.

Your license to Particular Software source code and/or binaries is governed by the Reciprocal Public License 1.5 (RPL1.5) license as described here:
Your license to the artifacts in this repository is governed by the [MIT License](https://opensource.org/license/MIT), as described here:

https://opensource.org/license/rpl-1-5/
Copyright (c) Particular Software Limited

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```
If you do not wish to release the source of software you build using Particular Software source code and/or binaries under the terms above, you may use Particular Software source code and/or binaries under the License Agreement described here:
https://particular.net/LicenseAgreement
29 changes: 18 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,17 @@ 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 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)
- 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)

And, if you need help, you can always head over to [our forum](https://discuss.particular.net/tag/masstransit).
90 changes: 0 additions & 90 deletions docs/docs.md

This file was deleted.

6 changes: 3 additions & 3 deletions src/Billing/Billing.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
</ItemGroup>

<ItemGroup>
<PackageReference Include="MassTransit.Azure.ServiceBus.Core" Version="8.3.0" />
<PackageReference Include="MassTransit.RabbitMQ" Version="8.3.0" />
<PackageReference Include="MassTransit.AmazonSQS" Version="8.3.0" />
<PackageReference Include="MassTransit.Azure.ServiceBus.Core" Version="8.3.6" />
<PackageReference Include="MassTransit.RabbitMQ" Version="8.3.6" />
<PackageReference Include="MassTransit.AmazonSQS" Version="8.3.6" />
<PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.1" />
</ItemGroup>
</Project>
6 changes: 3 additions & 3 deletions src/ClientUI/ClientUI.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="MassTransit.Azure.ServiceBus.Core" Version="8.3.0" />
<PackageReference Include="MassTransit.RabbitMQ" Version="8.3.0" />
<PackageReference Include="MassTransit.AmazonSQS" Version="8.3.0" />
<PackageReference Include="MassTransit.Azure.ServiceBus.Core" Version="8.3.6" />
<PackageReference Include="MassTransit.RabbitMQ" Version="8.3.6" />
<PackageReference Include="MassTransit.AmazonSQS" Version="8.3.6" />
<PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.1" />
</ItemGroup>

Expand Down
Loading

0 comments on commit 88835ba

Please sign in to comment.