Skip to content

Adding Serilog support on Azure Functions #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,14 @@ This file should not be uploaded to the repository as it contains sensitive data
"StorageConnectionString": "<run: terraform output StorageConnectionString>",
"DatabaseCollection": "integrations",
"DatabaseName": "dbintegrationlab",
"StorageContainerName": "messages"
"StorageContainerName": "messages",
"Serilog.DataDogLogs.ApiKey": "dummy",
"Serilog.DataDogLogs.Source": "azure-functions-lab",
"Serilog.DataDogLogs.Service": "some-example-functions",
"Serilog.DataDogLogs.Env": "azfn-lab",
"Serilog.DataDogLogs.Host": "azure",
"Serilog.DataDogLogs.BatchSizeLimit": 5000,
"Serilog.DataDogLogs.QueueLimit": 500000
}
}
```
Expand Down
80 changes: 80 additions & 0 deletions SomeExampleFunctions/Shared/SerilogConfiguration.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
using Serilog;
using Serilog.Events;
using System;

namespace SomeExampleFunctions.Shared
{
public static class SerilogConfiguration
{
private static readonly string SinkOutputTemplate = Configuration.ValueOf("Serilog.Sink.OutputTemplate");

public static LoggerConfiguration Configure()
{
LoggerConfiguration configuration = GetLoggerConfiguration();
SetLevelOverrides(configuration);
SetEnrichers(configuration);
SetConsoleSink(configuration);
SetFileSink(configuration);
SetDataDogLogsSink(configuration);
return configuration;
}//func

private static LoggerConfiguration GetLoggerConfiguration()
{
LoggerConfiguration config = new LoggerConfiguration();
return config;
}//func

private static void SetLevelOverrides(LoggerConfiguration configuration)
{
configuration
.MinimumLevel.Override("Default", LogEventLevel.Information)
.MinimumLevel.Override("Microsoft", LogEventLevel.Information)
.MinimumLevel.Override("Microsoft.Hosting.Lifetime", LogEventLevel.Information);
}//func

private static void SetEnrichers(LoggerConfiguration configuration)
{
configuration
.Enrich.FromLogContext()
.Enrich.WithThreadId()
.Enrich.WithThreadName();
}//func

private static void SetConsoleSink(LoggerConfiguration configuration)
{
configuration.WriteTo.Console(outputTemplate: SinkOutputTemplate);
}//func

private static void SetFileSink(LoggerConfiguration configuration)
{
configuration.WriteTo.Async(a =>
{
string appName = Configuration.ValueOf("AppName");
a.File(
path: $"{Configuration.ValueOf("Serilog.File.BaseFilePath")}/{appName}/{appName}.txt",
fileSizeLimitBytes: Convert.ToInt64(Configuration.ValueOf("Serilog.File.FileSizeLimitBytes")),
rollOnFileSizeLimit: true,
retainedFileCountLimit: Convert.ToInt32(Configuration.ValueOf("Serilog.File.RetainedFileCountLimit")),
encoding: System.Text.Encoding.UTF8,
outputTemplate: SinkOutputTemplate
);
});
}//func

private static void SetDataDogLogsSink(LoggerConfiguration configuration)
{
configuration
.WriteTo.DatadogLogs(
apiKey: Configuration.ValueOf("Serilog.DataDogLogs.ApiKey"),
source: Configuration.ValueOf("Serilog.DataDogLogs.Source"),
service: Configuration.ValueOf("Serilog.DataDogLogs.Service"),
host: Configuration.ValueOf("Serilog.DataDogLogs.Host"),
tags: new[] { $"env:{Configuration.ValueOf("Serilog.DataDogLogs.Env")}" },
logLevel: LogEventLevel.Debug,
batchSizeLimit: Convert.ToInt32(Configuration.ValueOf("Serilog.DataDogLogs.BatchSizeLimit")),
queueLimit: Convert.ToInt32(Configuration.ValueOf("Serilog.DataDogLogs.QueueLimit"))
);
}//func
}
}
6 changes: 5 additions & 1 deletion SomeExampleFunctions/SomeExampleFunctions.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,18 @@
<AzureFunctionsVersion>v3</AzureFunctionsVersion>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Arcus.Observability.Telemetry.AzureFunctions" Version="2.3.0" />
<PackageReference Include="Microsoft.Azure.Functions.Extensions" Version="1.1.0" />
<PackageReference Include="Microsoft.NET.Sdk.Functions" Version="3.0.13" />
<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.ServiceBus" Version="4.3.0" />
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="3.1.19" />
<PackageReference Include="Microsoft.Extensions.Http" Version="3.1.19" />
<PackageReference Include="Azure.Storage.Blobs" Version="12.10.0" />
<PackageReference Include="MongoDB.Driver" Version="2.13.1" />
<PackageReference Include="Serilog.AspNetCore" Version="4.1.0" />
<PackageReference Include="Serilog.Enrichers.Thread" Version="3.1.0" />
<PackageReference Include="Serilog.Sinks.Async" Version="1.5.0" />
<PackageReference Include="Serilog.Sinks.Datadog.Logs" Version="0.3.5" />
</ItemGroup>
<ItemGroup>
<None Remove="Microsoft.Azure.WebJobs.Extensions.ServiceBus" />
Expand All @@ -36,6 +41,5 @@
<ItemGroup>
<Folder Include="Functions\" />
<Folder Include="Models\" />
<Folder Include="Shared\" />
</ItemGroup>
</Project>
30 changes: 19 additions & 11 deletions SomeExampleFunctions/Startup.cs
Original file line number Diff line number Diff line change
@@ -1,19 +1,27 @@
using System;
using Azure.Storage.Blobs;
using Microsoft.Azure.Functions.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Serilog;
using SomeExampleFunctions.Shared;
using System;

[assembly: FunctionsStartup(typeof(SomeExampleFunctions.Startup))]
namespace SomeExampleFunctions
{
public class Startup: FunctionsStartup
{
public override void Configure(IFunctionsHostBuilder builder)
{
builder.Services.AddHttpClient("processorApi", client => {
client.BaseAddress = new Uri(Configuration.ValueOf("MessageProcessorServiceUrl"));
});
}
}
public class Startup : FunctionsStartup
{
public override void Configure(IFunctionsHostBuilder builder)
{
builder.Services.AddHttpClient("processorApi", client =>
{
client.BaseAddress = new Uri(Configuration.ValueOf("MessageProcessorServiceUrl"));
});

builder.Services.AddLogging(loggingBuilder =>
{
loggingBuilder.ClearProvidersExceptFunctionProviders();
loggingBuilder.AddSerilog(SerilogConfiguration.Configure().CreateLogger());
});
}
}
}