Franz.Common.Http.Messaging 1.2.62

Franz.Common.Http.Messaging

A specialized library within the Franz Framework, designed to streamline the integration of messaging systems, health checks, and transaction management for HTTP-based services in ASP.NET Core applications. This package provides tools to ensure seamless messaging health monitoring and transactional consistency in distributed systems.

Features

• Messaging Health Checks:
  • KafkaHealthCheck for monitoring the health of Kafka messaging systems.
• Transaction Management:
  • TransactionFilter for ensuring transactional consistency in HTTP requests.
• Dependency Injection:
  • ServiceCollectionExtensions for registering messaging and transaction-related services easily.

Version Information

• Current Version: 1.2.62
• Part of the private Franz Framework ecosystem.

Dependencies

This package depends on the following:

• Franz.Common.Http: For HTTP utilities and middleware integration.
• Franz.Common: Provides foundational utilities.
• Franz.Common.Messaging (if available): Additional messaging-related abstractions and utilities.

Installation

From Private Azure Feed

Since this package is hosted privately, configure your NuGet client:

dotnet nuget add source "https://your-private-feed-url" \
  --name "AzurePrivateFeed" \
  --username "YourAzureUsername" \
  --password "YourAzurePassword" \
  --store-password-in-clear-text

Install the package:

dotnet add package Franz.Common.Http.Messaging --version 1.2.62

Usage

1. Messaging Health Checks

Register and configure Kafka health checks:

using Franz.Common.Http.Messaging.Healthchecks;

services.AddHealthChecks()
    .AddCheck<KafkaHealthCheck>("Kafka");

This will monitor the Kafka messaging system's health and integrate it into ASP.NET Core's health check system.

2. Transaction Management

Apply the TransactionFilter to ensure transactional consistency:

using Franz.Common.Http.Messaging.Transactions;

services.AddControllers(options =>
{
    options.Filters.Add<TransactionFilter>();
});

3. Dependency Injection

Register messaging and transaction services with ServiceCollectionExtensions:

using Franz.Common.Http.Messaging.Extensions;

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMessagingUtilities(); // Registers messaging utilities and services
    }
}

Integration with Franz Framework

The Franz.Common.Http.Messaging package integrates seamlessly with:

• Franz.Common.Http: Enhances HTTP-based applications with messaging support.
• Franz.Common: Provides foundational utilities and patterns.

Ensure these dependencies are installed to fully leverage the library's capabilities.

Contributing

This package is part of a private framework. Contributions are limited to the internal development team. If you have access, follow these steps:

1. Clone the repository.
2. Create a feature branch.
3. Submit a pull request for review.

License

This library is licensed under the MIT License. See the LICENSE file for more details.

Changelog

Version 1.2.62

• Introduced KafkaHealthCheck for monitoring Kafka messaging system health.
• Added TransactionFilter for transactional consistency.
• Integrated ServiceCollectionExtensions for streamlined DI setup.