Skip to content
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

Add serverless docs #221

Merged
merged 3 commits into from
Oct 15, 2023
Merged
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
183 changes: 181 additions & 2 deletions docs/shipping/Code/dotnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,52 @@ namespace dotnet_log4net
}
```

##### Serverless platforms
If you’re using a serverless function, you’ll need to call the appender's flush methods at the end of the function run to make sure the logs are sent before the function finishes its execution.

###### Code sample

```csharp
using System;
using Microsoft.Azure.WebJobs;
using Microsoft.Extensions.Logging;
using log4net;
using log4net.Core;
using log4net.Repository.Hierarchy;
using Logzio.DotNet.Log4net;
using MicrosoftLogger = Microsoft.Extensions.Logging.ILogger;

namespace LogzioLog4NetSampleApplication
{
public class TimerTriggerCSharpLog4Net
{
[FunctionName("TimerTriggerCSharpLog4Net")]
public void Run([TimerTrigger("*/30 * * * * *")]TimerInfo myTimer, MicrosoftLogger msLog)
{
msLog.LogInformation($"Log4Net C# Timer trigger function executed at: {DateTime.Now}");
var hierarchy = (Hierarchy)LogManager.GetRepository();
var logger = LogManager.GetCurrentClassLogger();
var logzioAppender = new LogzioAppender();

logzioAppender.AddToken("<<LOG-SHIPPING-TOKEN>>");
logzioAppender.AddListenerUrl("https://<<LISTENER-HOST>>:8071");
logzioAppender.ActivateOptions();

hierarchy.Root.AddAppender(logzioAppender);
hierarchy.Configured = true;
hierarchy.Root.Level = Level.All;
logger.Info("Now I don't blame him 'cause he run and hid");
logger.Info("But the meanest thing he ever did");
logger.Info("Before he left was he went and named me Sue");
LogManager.Flush(5000);
LogManager.Shutdown();
msLog.LogInformation($"Log4Net C# Timer trigger function finishd at: {DateTime.Now}");

}
}
}
```


### NLog

Expand Down Expand Up @@ -344,7 +390,7 @@ For a complete list of options, see the configuration parameters below the code
token="<<LOG-SHIPPING-TOKEN>>"
logzioType="nlog"
listenerUrl="<<LISTENER-HOST>>:8071"
<!--Optional proxy server address:
<!--Optional proxy server address:
proxyAddress = "http://your.proxy.com:port" -->
bufferSize="100"
bufferTimeout="00:00:05"
Expand Down Expand Up @@ -435,7 +481,7 @@ namespace LogzioNLogSampleApplication
.Property("youCanCallMe", "Al")
.Write();

LogManager.Shutdown();
LogManager.Shutdown();
}
}
}
Expand Down Expand Up @@ -516,7 +562,53 @@ config.AddRule(LogLevel.Debug, LogLevel.Fatal, logzioTarget);
LogManager.Configuration = config;
```

##### Serverless platforms
If you’re using a serverless function, you’ll need to call the appender's flush methods at the end of the function run to make sure the logs are sent before the function finishes its execution.

###### Code sample

```csharp
using System;
using Microsoft.Azure.WebJobs;
using Logzio.DotNet.NLog;
using NLog;
using NLog.Config;
using NLog.Fluent;
using Microsoft.Extensions.Logging;
using MicrosoftLogger = Microsoft.Extensions.Logging.ILogger;
namespace LogzioNLogSampleApplication
{
public class TimerTriggerCSharpNLog
{
[FunctionName("TimerTriggerCSharpNLog")]
public void Run([TimerTrigger("*/30 * * * * *")] TimerInfo myTimer, MicrosoftLogger msLog)
{
msLog.LogInformation($"NLogzio C# Timer trigger function executed at: {DateTime.Now}");

var nLog = LogManager.GetCurrentClassLogger();

nLog.Info()
.Message("If you'll be my bodyguard")
.Property("iCanBe", "your long lost pal")
.Property("iCanCallYou", "Betty, and Betty when you call me")
.Property("youCanCallMe", "Al")
.Write();

// Call Flush with a callback to Shutdown LogManager
LogManager.Flush(ex =>
{
if (ex != null)
msLog.LogError(ex, "Error while flushing NLog.");
else
{
LogManager.Shutdown();
msLog.LogInformation($"NLogzio C# Timer trigger function finished at: {DateTime.Now}");
}
}, TimeSpan.FromSeconds(5));
}
}
}
```


### LoggerFactory
Expand Down Expand Up @@ -781,7 +873,52 @@ hierarchy.Root.Level = Level.All;
hierarchy.Configured = true;
```

##### Serverless platforms
If you’re using a serverless function, you’ll need to call the logger's shutdown methods at the end of the function run and make sure the logs are sent before the function finishes its execution. Make sure 'debug' is set to false if the function is deployed as it might cause permission issues with debug files.

###### Code sample

```csharp
using Microsoft.Azure.WebJobs;
using Microsoft.Extensions.Logging;
using log4net;
using MicrosoftLogger = Microsoft.Extensions.Logging.ILogger;
using MicrosoftLoggerFactory = Microsoft.Extensions.Logging.LoggerFactory;
using System.IO;
using System.Reflection;
using log4net.Config;
using System;
using System.Threading;
namespace LogzioLoggerFactorySampleApplication
{
public class TimerTriggerCSharpLoggerFactory
{
[FunctionName("TimerTriggerCSharpLoggerFactory")]
public void Run([TimerTrigger("*/30 * * * * *")] TimerInfo myTimer, MicrosoftLogger msLog, Microsoft.Azure.WebJobs.ExecutionContext context)
{

msLog.LogInformation($"LoggerFactory C# Timer trigger function executed at: {DateTime.Now}");

var functionAppDirectory = context.FunctionAppDirectory; // Function app root directory
MicrosoftLoggerFactory loggerFactory = new();
loggerFactory.AddLog4Net(Path.Combine(functionAppDirectory, "log4net.config")); // Use the log4net.config in the function app root directory
var logger = loggerFactory.CreateLogger<TimerTriggerCSharpLoggerFactory>();

var logRepository = LogManager.GetRepository(Assembly.GetEntryAssembly());

// Replace "App.config" with the config file that holds your log4net configuration
XmlConfigurator.Configure(logRepository, new FileInfo(Path.Combine(functionAppDirectory, "log4net.config")));

logger.LogInformation("Hello");
logger.LogInformation("Is it me you looking for?");
Thread.Sleep(5000); // gives the logs enough time to be sent to Logz.io
LogManager.Shutdown();
msLog.LogInformation($"LoggerFactory C# Timer trigger function finishd at: {DateTime.Now}");

}
}
}
```
### Serilog

:::note
Expand Down Expand Up @@ -904,6 +1041,48 @@ namespace Example
}
```

##### Serverless platforms
If you’re using a serverless function, you’ll need to call the appender's flush methods at the end of the function run to make sure the logs are sent before the function finishes its execution.
In the Serilog integration, you should use the 'WriteTo.LogzIo()' instad of 'WriteTo.LogzIoDurableHttp()' method as it uses in-memory buffering which is best practice for serverless functions.
###### Code sample

```csharp
using System;
using Microsoft.Azure.WebJobs;
using Serilog;
using Serilog.Sinks.Logz.Io;
using Microsoft.Extensions.Logging;
using MicrosoftLogger = Microsoft.Extensions.Logging.ILogger;
using Serilogger = Serilog.ILogger;
using System.Threading;


namespace LogzioSeriLogSampleApplication
{
public class TimerTriggerCSharpSeriLogzio
{
[FunctionName("TimerTriggerCSharpSeriLogzio")]
public void Run([TimerTrigger("*/30 * * * * *")] TimerInfo myTimer, MicrosoftLogger msLog)
{
msLog.LogInformation($"Serilog C# Timer trigger function executed at: {DateTime.Now}");
Serilogger logzioLogger = new LoggerConfiguration()
.WriteTo.LogzIo("<<LOG-SHIPPING-TOKEN>>", "<<TYPE>>", useHttps: true, dataCenterSubDomain: "listener") // Replace 'listener' with the relevant region, i.e: 'listener-eu'
.CreateLogger();

// Assign the logger to the static Log class
Log.Logger = logzioLogger;

logzioLogger.Information("Hello. Is it me you're looking for?");
Thread.Sleep(5000);
// // Flush the static logger
Log.CloseAndFlush();

msLog.LogInformation($"Serilog C# Timer trigger function finished at: {DateTime.Now}");
}
}
}
```

{@include: ../../_include/log-shipping/log-shipping-token.html}

{@include: ../../_include/log-shipping/listener-var.html}
Expand Down