👁 Image
FluxConfig.Provider 1.0.0

FluxConfig Provider

FluxConfig Microsoft.Extensions.Configuration custom Provider.

Introduces a .NET platform-integrated client for interacting with the FluxConfig system.Provides automated retrieval and updating of the application's running configuration without the need to restart the application or interact with the deployment environment.

Supported runtimes

• .NET 6+
• .NET Core 3+

Getting Started

0. Prerequisites

FluxConfig service complex, including

• FluxConfig.Storage
• FluxConfig.Management
• FluxConfig.WebClient

deployed and ready on your system.

To learn more about deployment visit Deployment Guidance

1. Install NuGet package

dotnet add package FluxConfig.Provider

2. Visit deployed FluxConfig.WebClient

To learn more about how to work with FluxConfig visit General Guidance

3. Add FluxConfig Provider to your application

Add FluxConfig Provider to your application IConfiguration via IConfigurationBuilder

IConfigurationRoot config = new ConfigurationBuilder()
 .AddFluxConfig(options =>
 {
 options.ConnectionOptions = new ConnectionOptions
 {
 Address = new Uri("https://your-fluxconfig-storage-url"),
 ApiKey = "Your application configuration api key"
 };
 
 options.ConfigurationTag = "Your application configuration tag"; 
 }).Build();

4. Configure FluxConfig Provider if needed

Configure data polling behaviour

options.PollingOptions = new FluxPollingOptions
 {
 ExceptionBehavior = PollingExceptionBehavior.Ignore,
 RefreshInterval = TimeSpan.FromSeconds(10)
 };

Configure Logging

options.LoggerFactory = LoggerFactory.Create(optionsBuilder =>
 {
 optionsBuilder.AddConsole();
 optionsBuilder.SetMinimumLevel(LogLevel.Information);
 });

Configure custom FluxConfig Exception handler if

ExceptionBehavior = PollingExceptionBehavior.Throw

is selected

// Example of application termination handler
configurationBuilder.SetFluxConfigExceptionHandler(ctx =>
 {
 ctx.Logger.LogWarning("Handler: Exception occured while fetching config data: {message}", ctx.Exception?.Message);
 Environment.Exit(-1);
 });