Swagger

Azure App Config Environment Variables

The following should be specified as environment variables when launching the service:

Blob Storage

Kafka

Note: Mechanism and Protocol are only used when SASL authentication is enabled.

Options for Mechanism:

• Plain
• Gssapi
• ScramSHA256
• ScramSHA512
• OAuthBearer

Options for Protocol:

• SaslPlaintext
• Plaintext
• Ssl
• SaslSsl

SASL Plain Text Authentication

Include the following configuration properties to connecto to Kafka that requires SASL_PLAINTEXT authentication:

Kafka Consumer Settings

CORS

Token Service Settings

TODO: Describe what the purpose of the token endpoint is

Service Authentication

Redis

Telemetry

Service Registry

The Service Registry section contains URLs and configurations for all microservices in the Link Cloud ecosystem. Configuration key: ServiceRegistry

Not all services use every URL. The configuration is provided for completeness and future-proofing. If using Azure App Configuration, all service URLs should be specified, and each service will use only the URLs it needs.

Service URLs

Example Configuration in JSON

{
  "ServiceRegistry": {
    "AccountServiceUrl": "http://localhost:8060",
    "AuditServiceUrl": "http://localhost:8062",
    "CensusServiceUrl": "http://localhost:8064",
    "DataAcquisitionServiceUrl": "http://localhost:8065",
    "MeasureServiceUrl": "http://localhost:8067",
    "NormalizationServiceUrl": "http://localhost:8068",
    "NotificationServiceUrl": "http://localhost:7434",
    "QueryDispatchServiceUrl": "http://localhost:8071",
    "ReportServiceUrl": "http://localhost:8072",
    "SubmissionServiceUrl": "http://localhost:8073",
    "TenantService": {
      "TenantServiceUrl": "http://localhost:8074",
      "CheckIfTenantExists": true,
      "GetTenantRelativeEndpoint": "facility/"
    },
    "ValidationServiceUrl": "http://localhost:8075",
    "TerminologyServiceUrl": "http://localhost:8076"
  }
}

Tenant Service Configuration

Data Acquisition Service Configuration

The following settings are specific to the Data Acquisition service.

Databases

SQL Server Database

Mongo Database

Service Information

The ServiceInformation configuration allows exposing build, version and deployment information through the /api/XXX/info (i.e. /api/audit/info) endpoint of each service. This information is automatically populated from assembly metadata and git information during build time.

The service automatically extracts information from .NET assembly version in the AssemblyInfo.cs file or project file

EF Core Query Logging

Configure EF Core to log queries, including sensitive data, by setting up the appsettings.json file and adjusting the Program.cs file. This allows dynamic adjustment of logging levels in Serilog based on the EnableEnhancedQueryLogging setting.

Configuration in appsettings.json

Add the following section to enable enhanced query logging:

"EnhancedQueryLoggingSettings": {
  "EnableEnhancedQueryLogging": false
}

Configuration in Program.cs

In Program.cs, configure Serilog to dynamically set log levels for EF Core namespaces and enable EF Core logging in the DbContext setup.

For Serilog configuration (e.g., in a ConfigureLogging method):

// Bind the enhanced logging settings
var enhancedLoggingSettings = builder.Configuration.GetRequiredSection(nameof(EnhancedQueryLoggingSettings)).Get<EnhancedQueryLoggingSettings>();

// Create Serilog logger configuration
var loggerConfig = new LoggerConfiguration()
    .ReadFrom.Configuration(builder.Configuration)
    // ... other enrichers and filters ...

// Conditionally override EF Core log levels
var efCoreLogLevel = enhancedLoggingSettings != null && enhancedLoggingSettings.EnableEnhancedQueryLogging
    ? LogEventLevel.Information
    : LogEventLevel.Warning;

loggerConfig
    .MinimumLevel.Override("Microsoft.EntityFrameworkCore", efCoreLogLevel)
    .MinimumLevel.Override("Microsoft.EntityFrameworkCore.Database.Command", efCoreLogLevel);

Log.Logger = loggerConfig.CreateLogger();
builder.Logging.AddSerilog();

For DbContext registration (e.g., when using MongoDB provider for EF Core):

builder.Services.AddDbContext<MongoDbContext>((sp, options) =>
{
    var querySettings = builder.Configuration.GetRequiredSection(nameof(EnhancedQueryLoggingSettings)).Get<EnhancedQueryLoggingSettings>();

    // ... client and settings setup ...

    if (querySettings != null && querySettings.EnableEnhancedQueryLogging)
    {
        var loggerFactory = sp.GetRequiredService<ILoggerFactory>();
        options.UseMongoDB(client, mongoSettings.DatabaseName)
            .UseLoggerFactory(loggerFactory)
            .EnableSensitiveDataLogging();
    }
    else
    {
        options.UseMongoDB(client, mongoSettings.DatabaseName);
    }
});

Relationships

flowchart LR
ndotnet_704D25B0["Design: Configuring .NET Services"]