feat: LavinMQ integration #2634

prom3theu5 · 2025-02-18T10:52:52Z

This pull request adds supporting documentation for the LavinMQ hosting integration in the Community Toolkit tracked by CommunityToolkit/Aspire#477

Internal previews

📄 File	🔗 Preview link
docs/community-toolkit/hosting-lavinmq.md	.NET Aspire LavinMQ integration
docs/community-toolkit/overview.md	Overview

IEvangelist · 2025-03-27T17:55:48Z

docs/community-toolkit/hosting-lavinmq.md

+# .NET Aspire LavinMQ integration
+
+[!INCLUDE [includes-hosting](../includes/includes-hosting.md)]
+


Missing the banner include.

Suggested change

[!INCLUDE [banner](includes/banner.md)]

IEvangelist · 2025-03-27T18:10:13Z

docs/community-toolkit/hosting-lavinmq.md

This article needs to be added to the TOC, under here: https://github.com/dotnet/docs-aspire/blob/main/docs/toc.yml#L289

IEvangelist · 2025-03-27T18:10:36Z

docs/community-toolkit/hosting-lavinmq.md

+
+## Hosting integration
+
+The LavinMQ hosting integration models a LavinMQ server as the <xref:Aspire.Hosting.ApplicationModel.LavinMQContainerResource> type. To access this type and its APIs add the [📦 CommunityToolkit.Aspire.Hosting.LavinMQ](https://www.nuget.org/packages/CommunityToolkit.Aspire.Hosting.LavinMQ) NuGet package in the [app host](xref:dotnet/aspire/app-host) project.


Suggested change

The LavinMQ hosting integration models a LavinMQ server as the <xref:Aspire.Hosting.ApplicationModel.LavinMQContainerResource> type. To access this type and its APIs add the [📦 CommunityToolkit.Aspire.Hosting.LavinMQ](https://www.nuget.org/packages/CommunityToolkit.Aspire.Hosting.LavinMQ) NuGet package in the [app host](xref:dotnet/aspire/app-host) project.

The LavinMQ hosting integration models a LavinMQ server as the `Aspire.Hosting.ApplicationModel.LavinMQContainerResource` type. To access this type and its APIs add the [📦 CommunityToolkit.Aspire.Hosting.LavinMQ](https://www.nuget.org/packages/CommunityToolkit.Aspire.Hosting.LavinMQ) NuGet package in the [app host](xref:dotnet/aspire/app-host) project.

IEvangelist · 2025-03-27T18:10:50Z

docs/community-toolkit/hosting-lavinmq.md

+var LavinMQ = builder.AddLavinMQ("messaging")
+                      .WithDataVolume(isReadOnly: false);


Suggested change

var LavinMQ = builder.AddLavinMQ("messaging")

.WithDataVolume(isReadOnly: false);

var LavinMQ = builder.AddLavinMQ("messaging")

.WithDataVolume(isReadOnly: false);

IEvangelist · 2025-03-27T18:11:11Z

docs/community-toolkit/hosting-lavinmq.md

+var LavinMQ = builder.AddLavinMQ("messaging")
+                      .WithDataBindMount(
+                          source: @"C:\LavinMQ\Data",
+                          isReadOnly: false);


Suggested change

var LavinMQ = builder.AddLavinMQ("messaging")

.WithDataBindMount(

source: @"C:\LavinMQ\Data",

isReadOnly: false);

var LavinMQ = builder.AddLavinMQ("messaging")

.WithDataBindMount(

source: @"C:\LavinMQ\Data",

isReadOnly: false);

IEvangelist · 2025-03-27T18:11:45Z

docs/community-toolkit/hosting-lavinmq.md

+LavinMQ is wire compatible with RabbitMQ.
+This may introduce a bit of confusion at first, but think of LavinMQ as a RabbitMQ server with a different name in terms of the .NET client integration.
+You can see an example of using the explicit RabbitMQ.Client [here](https://lavinmq.com/documentation/dot-net-sample-code)
+To get started with the .NET Aspire RabbitMQ client integration, install the [📦 Aspire.RabbitMQ.Client](https://www.nuget.org/packages/Aspire.RabbitMQ.Client) NuGet package in the client-consuming project, that is, the project for the application that uses the LavinMQ client. The LavinMQ client integration registers an [IConnection](https://LavinMQ.github.io/LavinMQ-dotnet-client/api/LavinMQ.Client.IConnection.html) instance that you can use to interact with LavinMQ.


Suggested change

LavinMQ is wire compatible with RabbitMQ.

This may introduce a bit of confusion at first, but think of LavinMQ as a RabbitMQ server with a different name in terms of the .NET client integration.

You can see an example of using the explicit RabbitMQ.Client [here](https://lavinmq.com/documentation/dot-net-sample-code)

To get started with the .NET Aspire RabbitMQ client integration, install the [📦 Aspire.RabbitMQ.Client](https://www.nuget.org/packages/Aspire.RabbitMQ.Client) NuGet package in the client-consuming project, that is, the project for the application that uses the LavinMQ client. The LavinMQ client integration registers an [IConnection](https://LavinMQ.github.io/LavinMQ-dotnet-client/api/LavinMQ.Client.IConnection.html) instance that you can use to interact with LavinMQ.

LavinMQ is wire compatible with RabbitMQ. This may introduce a bit of confusion at first, but think of LavinMQ as a RabbitMQ server with a different name in terms of the .NET client integration. You can see an example of using the explicit RabbitMQ.Client [here](https://lavinmq.com/documentation/dot-net-sample-code). To get started with the .NET Aspire RabbitMQ client integration, install the [📦 Aspire.RabbitMQ.Client](https://www.nuget.org/packages/Aspire.RabbitMQ.Client) NuGet package in the client-consuming project, that is, the project for the application that uses the LavinMQ client. The LavinMQ client integration registers an [IConnection](https://LavinMQ.github.io/LavinMQ-dotnet-client/api/LavinMQ.Client.IConnection.html) instance that you can use to interact with LavinMQ.

Copilot

Pull Request Overview

This PR adds comprehensive documentation for the LavinMQ hosting integration in the .NET Aspire Community Toolkit. LavinMQ is a wire-compatible alternative to RabbitMQ that can be used as a message broker in .NET Aspire applications.

Adds complete documentation for the LavinMQ hosting integration including setup, configuration, and usage examples
Updates the community toolkit overview to include LavinMQ in the list of available integrations
Provides guidance on using RabbitMQ client libraries with LavinMQ due to wire compatibility

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
docs/community-toolkit/overview.md	Adds LavinMQ to the list of hosting integrations with links to documentation and NuGet package
docs/community-toolkit/hosting-lavinmq.md	New comprehensive documentation file covering LavinMQ integration setup, configuration, and usage

Comments suppressed due to low confidence (3)

docs/community-toolkit/hosting-lavinmq.md:45

The variable name 'LavinMQ' uses PascalCase, which is inconsistent with C# naming conventions. Variable names should use camelCase. Consider renaming to 'lavinMq' or 'lavinmq'.

var LavinMQ = builder.AddLavinMQ("messaging");

docs/community-toolkit/hosting-lavinmq.md:72

The variable name 'LavinMQ' uses PascalCase, which is inconsistent with C# naming conventions. Variable names should use camelCase. Consider renaming to 'lavinMq' or 'lavinmq'.

var LavinMQ = builder.AddLavinMQ("messaging")

docs/community-toolkit/hosting-lavinmq.md:90

The variable name 'LavinMQ' uses PascalCase, which is inconsistent with C# naming conventions. Variable names should use camelCase. Consider renaming to 'lavinMq' or 'lavinmq'.

var LavinMQ = builder.AddLavinMQ("messaging")

Copilot · 2025-07-18T19:42:09Z

docs/community-toolkit/hosting-lavinmq.md

+
+### LavinMQ container resource management plugin
+
+LavinMQ includes a management interface by default


This sentence is incomplete and lacks proper punctuation. It should end with a period and provide more complete information about the management interface.

Copilot · 2025-07-18T19:42:10Z

docs/community-toolkit/hosting-lavinmq.md

+
+Because LavinMQ is wire compatible with AMQP 0.9.1, we can leverage the existing RabbitMQ health check integration.
+
+The hosting integration relies on the [📦 AspNetCore.HealthChecks.RabbitMQ](https://www.nuget.org/packages/AspNetCore.HealthChecks.LavinMQ) NuGet package.


The link URL points to 'AspNetCore.HealthChecks.LavinMQ' but the link text shows 'AspNetCore.HealthChecks.RabbitMQ'. This inconsistency will result in a broken link since the URL should match the package name mentioned in the text.

Suggested change

The hosting integration relies on the [📦 AspNetCore.HealthChecks.RabbitMQ](https://www.nuget.org/packages/AspNetCore.HealthChecks.LavinMQ) NuGet package.

The hosting integration relies on the [📦 AspNetCore.HealthChecks.LavinMQ](https://www.nuget.org/packages/AspNetCore.HealthChecks.LavinMQ) NuGet package.

Copilot · 2025-07-18T19:42:10Z

docs/community-toolkit/hosting-lavinmq.md

+## See also
+
+- [Send messages with RabbitMQ in .NET Aspire](/training/modules/send-messages-rabbitmq-dotnet-aspire-app)
+- [RabbitMQ .NET Client docs](https://rabbitmq.github.io/LavinMQ-dotnet-client)


The URL 'https://rabbitmq.github.io/LavinMQ-dotnet-client' appears to be incorrect. It should point to the RabbitMQ .NET client documentation, which would be 'https://rabbitmq.github.io/rabbitmq-dotnet-client' not 'LavinMQ-dotnet-client'.

Suggested change

- [RabbitMQ .NET Client docs](https://rabbitmq.github.io/LavinMQ-dotnet-client)

- [RabbitMQ .NET Client docs](https://rabbitmq.github.io/rabbitmq-dotnet-client)

Copilot · 2025-07-18T19:42:10Z

docs/community-toolkit/hosting-lavinmq.md

+LavinMQ is wire compatible with RabbitMQ.
+This may introduce a bit of confusion at first, but think of LavinMQ as a RabbitMQ server with a different name in terms of the .NET client integration.
+You can see an example of using the explicit RabbitMQ.Client [here](https://lavinmq.com/documentation/dot-net-sample-code)
+To get started with the .NET Aspire RabbitMQ client integration, install the [📦 Aspire.RabbitMQ.Client](https://www.nuget.org/packages/Aspire.RabbitMQ.Client) NuGet package in the client-consuming project, that is, the project for the application that uses the LavinMQ client. The LavinMQ client integration registers an [IConnection](https://LavinMQ.github.io/LavinMQ-dotnet-client/api/LavinMQ.Client.IConnection.html) instance that you can use to interact with LavinMQ.


The URL 'https://LavinMQ.github.io/LavinMQ-dotnet-client/api/LavinMQ.Client.IConnection.html' appears to be incorrect. Since LavinMQ is wire-compatible with RabbitMQ and uses the RabbitMQ client, this should point to the RabbitMQ client documentation.

Suggested change

To get started with the .NET Aspire RabbitMQ client integration, install the [📦 Aspire.RabbitMQ.Client](https://www.nuget.org/packages/Aspire.RabbitMQ.Client) NuGet package in the client-consuming project, that is, the project for the application that uses the LavinMQ client. The LavinMQ client integration registers an [IConnection](https://LavinMQ.github.io/LavinMQ-dotnet-client/api/LavinMQ.Client.IConnection.html) instance that you can use to interact with LavinMQ.

To get started with the .NET Aspire RabbitMQ client integration, install the [📦 Aspire.RabbitMQ.Client](https://www.nuget.org/packages/Aspire.RabbitMQ.Client) NuGet package in the client-consuming project, that is, the project for the application that uses the LavinMQ client. The LavinMQ client integration registers an [IConnection](https://www.rabbitmq.com/dotnet-api-guide.html) instance that you can use to interact with LavinMQ.

feat: LavinMQ integration

bd366c5

prom3theu5 requested a review from IEvangelist as a code owner February 18, 2025 10:52

dotnet-policy-service bot added the community-contribution label Feb 18, 2025

prom3theu5 mentioned this pull request Feb 18, 2025

feat: Add LavinMQ support #477 CommunityToolkit/Aspire#486

Merged

10 tasks

IEvangelist added the DO NOT MERGE Help prevent PR from mistakenly being merged. label Feb 20, 2025

IEvangelist approved these changes Mar 27, 2025

View reviewed changes

IEvangelist removed the DO NOT MERGE Help prevent PR from mistakenly being merged. label Mar 27, 2025

IEvangelist requested a review from Copilot July 18, 2025 19:41

Copilot AI reviewed Jul 18, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: LavinMQ integration #2634

feat: LavinMQ integration #2634

Uh oh!

prom3theu5 commented Feb 18, 2025 •

edited by github-actions bot

Loading

Uh oh!

IEvangelist Mar 27, 2025

Uh oh!

IEvangelist Mar 27, 2025

Uh oh!

IEvangelist Mar 27, 2025

Uh oh!

IEvangelist Mar 27, 2025

Uh oh!

IEvangelist Mar 27, 2025

Uh oh!

IEvangelist Mar 27, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 18, 2025

Uh oh!

Copilot AI Jul 18, 2025

Uh oh!

Copilot AI Jul 18, 2025

Uh oh!

Copilot AI Jul 18, 2025

Uh oh!

Uh oh!

		# .NET Aspire LavinMQ integration

		[!INCLUDE [includes-hosting](../includes/includes-hosting.md)]


		## Hosting integration

		The LavinMQ hosting integration models a LavinMQ server as the <xref:Aspire.Hosting.ApplicationModel.LavinMQContainerResource> type. To access this type and its APIs add the [📦 CommunityToolkit.Aspire.Hosting.LavinMQ](https://www.nuget.org/packages/CommunityToolkit.Aspire.Hosting.LavinMQ) NuGet package in the [app host](xref:dotnet/aspire/app-host) project.

		var LavinMQ = builder.AddLavinMQ("messaging")
		.WithDataVolume(isReadOnly: false);


		### LavinMQ container resource management plugin

		LavinMQ includes a management interface by default


		Because LavinMQ is wire compatible with AMQP 0.9.1, we can leverage the existing RabbitMQ health check integration.

		The hosting integration relies on the [📦 AspNetCore.HealthChecks.RabbitMQ](https://www.nuget.org/packages/AspNetCore.HealthChecks.LavinMQ) NuGet package.

	- [RabbitMQ .NET Client docs](https://rabbitmq.github.io/LavinMQ-dotnet-client)
	- [RabbitMQ .NET Client docs](https://rabbitmq.github.io/rabbitmq-dotnet-client)

feat: LavinMQ integration #2634

Are you sure you want to change the base?

feat: LavinMQ integration #2634

Uh oh!

Conversation

prom3theu5 commented Feb 18, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Internal previews

Uh oh!

IEvangelist Mar 27, 2025

Choose a reason for hiding this comment

Uh oh!

IEvangelist Mar 27, 2025

Choose a reason for hiding this comment

Uh oh!

IEvangelist Mar 27, 2025

Choose a reason for hiding this comment

Uh oh!

IEvangelist Mar 27, 2025

Choose a reason for hiding this comment

Uh oh!

IEvangelist Mar 27, 2025

Choose a reason for hiding this comment

Uh oh!

IEvangelist Mar 27, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

prom3theu5 commented Feb 18, 2025 •

edited by github-actions bot

Loading