👁 Image
Southport.Azure.Functions.Extensions 10.0.2

Southport.Azure.Functions.Extensions

A .NET library providing execution logging, monitoring, and utility extensions for Azure Functions (Isolated Worker model).

👁 NuGet

Features

• Execution Logging - Automatic function execution tracking with start/end times, status codes, and trigger values persisted to SQL Server
• Structured Logging - Serilog integration with SQL Server and Application Insights sinks
• Base Function Classes - FunctionBase<TService> with built-in exception handling, logging, and concurrent execution prevention
• Execution Results - Type-safe result pattern with Success, SuccessWithWarnings, and Failed status codes
• Queue Management - Azure Storage Queue client factory and poison queue requeuer service
• Log Maintenance - Automated cleanup of old execution logs
• Execution Digest - Email notifications for failed/warning executions via SendGrid or MailGun
• Health Checks - SQL Server health check integration

Installation

dotnet add package Southport.Azure.Functions.Extensions

Quick Start

1. Configure Services

var host = new HostBuilder()
 .ConfigureFunctionsWebApplication()
 .ConfigureServices((context, services) =>
 {
 var config = context.Configuration;
 var connectionString = config["SqlConnectionString"];

 // Register your SQL connection factory
 services.AddScoped<ISqlConnectionFactory, YourSqlConnectionFactory>();

 // Add execution logging with Serilog
 services.AddExecutionLoggerStandardServices<ISqlConnectionFactory>(connectionString);

 // Optional: Add queue services
 services.AddQueueServices();

 // Optional: Add health checks
 services.AddHealthCheckServices(connectionString);
 })
 .Build();

2. Create a Function Using the Base Class

public class MyTimerFunction : FunctionBase<IMyService>
{
 public MyTimerFunction(IMyService service, IExecutionLogger executionLogger, ILogger<MyTimerFunction> logger)
 : base(service, executionLogger, logger)
 {
 }

 [Function(nameof(MyTimerFunction))]
 public async Task Run([TimerTrigger("0 */5 * * * *")] TimerInfo timer, FunctionContext context)
 {
 async Task<ExecutionResult> Function()
 {
 // Your business logic here
 await Service.DoWorkAsync();
 return ExecutionResult.Success();
 }

 await Run(context, Function);
 }
}

3. Return Execution Results

// Success
return ExecutionResult.Success();

// Success with warnings
return ExecutionResult.SuccessWithWarnings("Some items were skipped");

// Failure
return ExecutionResult.Fail("Operation failed: " + errorMessage);

4. Log Only On Error (Optional)

For high-frequency functions where you only want to log failures:

await RunLogOnlyOnError(context, Function);

Database Setup

Create the required tables in your SQL Server database:

ExecutionLog Table

CREATE TABLE [dbo].[ExecutionLog] (
 [Id] nvarchar(100) NOT NULL PRIMARY KEY,
 [Function] nvarchar(50) NOT NULL,
 [Start] datetime2(2) NOT NULL,
 [End] datetime2(2) NULL,
 [TriggerValue] nvarchar(max) NULL,
 [StatusCode] smallint NULL
);

CREATE INDEX [IX_Execution_End] ON [dbo].[ExecutionLog] ([End]);
CREATE INDEX [IX_Execution_Function] ON [dbo].[ExecutionLog] ([Function]);
CREATE INDEX [IX_Execution_Start] ON [dbo].[ExecutionLog] ([Start]);
CREATE INDEX [IX_Execution_StatusCode] ON [dbo].[ExecutionLog] ([StatusCode]);

ApplicationLog Table

CREATE TABLE [dbo].[ApplicationLog] (
 [Id] int IDENTITY(1,1) NOT NULL PRIMARY KEY,
 [Message] nvarchar(max) NULL,
 [MessageTemplate] nvarchar(max) NULL,
 [Level] nvarchar(128) NULL,
 [TimeStamp] datetimeoffset(7) NOT NULL,
 [Exception] nvarchar(max) NULL,
 [Function] nvarchar(100) NULL,
 [Source] nvarchar(250) NULL,
 [LogEvent] nvarchar(max) NULL,
 [ExecutionLogId] nvarchar(100) NULL
);

CREATE INDEX [IX_ExecutionId] ON [dbo].[ApplicationLog] ([ExecutionLogId]);

Configuration

ExecutionLogging Options

{
 "ExecutionLogging": {
 "Schema": "dbo",
 "ExecutionLogTable": "ExecutionLog",
 "ApplicationLogTable": "ApplicationLog",
 "ApplicationLogSource": "My Function App",
 "ExecutionExpirationSeconds": 3600
 }
}

ExecutionDigest Options (for email notifications)

{
 "ExecutionDigest": {
 "FromAddress": "noreply@example.com",
 "Company": "My Company",
 "ApplicationName": "My App"
 }
}

Services

Status Codes

Requirements

• .NET 10.0
• Azure Functions Isolated Worker
• SQL Server (for execution logging)

License

Copyright © Southport Solutions, LLC. All rights reserved.