/// <summary>
/// Adds a sink that writes log events as records in an Azure Table Storage table (default LogEventEntity) using the given storage account.
/// </summary>
/// <param name="loggerConfiguration">The logger configuration.</param>
/// <param name="storageAccount">The Cloud Storage Account to use to insert the log entries to.</param>
/// <param name="restrictedToMinimumLevel">The minimum log event level required in order to write an event to the sink.</param>
/// <param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
/// <param name="storageQueueName">Storage queue name.</param>
/// <param name="bypassTableCreationValidation">Bypass the exception in case the table creation fails.</param>
/// <param name="separateQueuesByLogLevel">Flag for several queues usage by log level.</param>
/// <param name="cloudQueueProvider">Cloud table provider to get current log table.</param>
/// <returns>Logger configuration, allowing configuration to continue.</returns>
/// <exception cref="ArgumentNullException">A required parameter is null.</exception>
public static LoggerConfiguration AzureQueueStorage(
this LoggerSinkConfiguration loggerConfiguration,
CloudStorageAccount storageAccount,
LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
IFormatProvider formatProvider = null,
string storageQueueName = null,
bool bypassTableCreationValidation = false,
bool separateQueuesByLogLevel = false,
ICloudQueueProvider cloudQueueProvider = null)
{
if (loggerConfiguration == null)
{
throw new ArgumentNullException(nameof(loggerConfiguration));
}
if (storageAccount == null)
{
throw new ArgumentNullException(nameof(storageAccount));
}
return(AzureQueueStorage(
loggerConfiguration,
new JsonFormatter(formatProvider: formatProvider, closingDelimiter: ""),
storageAccount,
restrictedToMinimumLevel,
storageQueueName,
bypassTableCreationValidation,
separateQueuesByLogLevel,
cloudQueueProvider));
}
/// <summary>
/// Adds a sink that writes log events as records in Azure Table Storage table (default name LogEventEntity) using the given
/// storage account name and Shared Access Signature (SAS) URL.
/// </summary>
/// <param name="loggerConfiguration">The logger configuration.</param>
/// <param name="sharedAccessSignature">The storage account/table SAS key.</param>
/// <param name="accountName">The storage account name.</param>
/// <param name="restrictedToMinimumLevel">The minimum log event level required in order to write an event to the sink.</param>
/// <param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
/// <param name="storageQueueName">Storage queue name.</param>
/// <param name="cloudQueueProvider">Cloud table provider to get current log table.</param>
/// <returns>Logger configuration, allowing configuration to continue.</returns>
/// <exception cref="ArgumentNullException">A required parameter is null.</exception>
public static LoggerConfiguration AzureQueueStorage(
this LoggerSinkConfiguration loggerConfiguration,
string sharedAccessSignature,
string accountName,
LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
IFormatProvider formatProvider = null,
string storageQueueName = null,
ICloudQueueProvider cloudQueueProvider = null)
{
if (loggerConfiguration == null)
{
throw new ArgumentNullException(nameof(loggerConfiguration));
}
if (string.IsNullOrWhiteSpace(accountName))
{
throw new ArgumentNullException(nameof(accountName));
}
if (string.IsNullOrWhiteSpace(sharedAccessSignature))
{
throw new ArgumentNullException(nameof(sharedAccessSignature));
}
return(AzureQueueStorage(
loggerConfiguration,
new JsonFormatter(formatProvider: formatProvider, closingDelimiter: ""),
sharedAccessSignature,
accountName,
restrictedToMinimumLevel,
storageQueueName,
cloudQueueProvider));
}
/// <summary>
/// Adds a sink that writes log events as records in Azure Table Storage table (default name LogEventEntity) using the given
/// storage account connection string.
/// </summary>
/// <param name="loggerConfiguration">The logger configuration.</param>
/// <param name="formatter">Use a Serilog ITextFormatter such as CompactJsonFormatter to store object in data column of Azure table</param>
/// <param name="connectionString">The Cloud Storage Account connection string to use to insert the log entries to.</param>
/// <param name="restrictedToMinimumLevel">The minimum log event level required in order to write an event to the sink.</param>
/// <param name="storageTableName">Table name that log entries will be written to. Note: Optional, setting this may impact performance</param>
/// <param name="writeInBatches">Use a periodic batching sink, as opposed to a synchronous one-at-a-time sink; this alters the partition
/// key used for the events so is not enabled by default.</param>
/// <param name="batchPostingLimit">The maximum number of events to post in a single batch.</param>
/// <param name="period">The time to wait between checking for event batches.</param>
/// <param name="keyGenerator">The key generator used to create the PartitionKey and the RowKey for each log entry</param>
/// <param name="bypassTableCreationValidation">Bypass the exception in case the table creation fails.</param>
/// <param name="cloudQueueProvider">Cloud table provider to get current log table.</param>
/// <returns>Logger configuration, allowing configuration to continue.</returns>
/// <exception cref="ArgumentNullException">A required parameter is null.</exception>
public static LoggerConfiguration AzureQueueStorage(
this LoggerSinkConfiguration loggerConfiguration,
ITextFormatter formatter,
string connectionString,
LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
string storageQueueName = null,
bool bypassTableCreationValidation = false,
ICloudQueueProvider cloudQueueProvider = null)
{
if (loggerConfiguration == null)
{
throw new ArgumentNullException(nameof(loggerConfiguration));
}
if (formatter == null)
{
throw new ArgumentNullException(nameof(formatter));
}
if (string.IsNullOrEmpty(connectionString))
{
throw new ArgumentNullException(nameof(connectionString));
}
try
{
var storageAccount = CloudStorageAccount.Parse(connectionString);
return(AzureQueueStorage(loggerConfiguration, formatter, storageAccount, restrictedToMinimumLevel, storageQueueName, bypassTableCreationValidation, cloudQueueProvider));
}
catch (Exception ex)
{
Debugging.SelfLog.WriteLine($"Error configuring AzureQueueStorage: {ex}");
ILogEventSink sink = new LoggerConfiguration().CreateLogger();
return(loggerConfiguration.Sink(sink, restrictedToMinimumLevel));
}
}
/// <summary>
/// Adds a sink that writes log events as records in Azure Table Storage table (default name LogEventEntity) using the given
/// storage account connection string.
/// </summary>
/// <param name="loggerConfiguration">The logger configuration.</param>
/// <param name="connectionString">The Cloud Storage Account connection string to use to insert the log entries to.</param>
/// <param name="restrictedToMinimumLevel">The minimum log event level required in order to write an event to the sink.</param>
/// <param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
/// <param name="storageTableName">Table name that log entries will be written to. Note: Optional, setting this may impact performance</param>
/// <param name="writeInBatches">Use a periodic batching sink, as opposed to a synchronous one-at-a-time sink; this alters the partition
/// key used for the events so is not enabled by default.</param>
/// <param name="batchPostingLimit">The maximum number of events to post in a single batch.</param>
/// <param name="period">The time to wait between checking for event batches.</param>
/// <param name="keyGenerator">The key generator used to create the PartitionKey and the RowKey for each log entry</param>
/// <param name="bypassTableCreationValidation">Bypass the exception in case the table creation fails.</param>
/// <param name="cloudQueueProvider">Cloud table provider to get current log table.</param>
/// <returns>Logger configuration, allowing configuration to continue.</returns>
/// <exception cref="ArgumentNullException">A required parameter is null.</exception>
public static LoggerConfiguration AzureQueueStorage(
this LoggerSinkConfiguration loggerConfiguration,
string connectionString,
LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
IFormatProvider formatProvider = null,
string storageQueueName = null,
//bool writeInBatches = false,
//TimeSpan? period = null,
//int? batchPostingLimit = null,
//IKeyGenerator keyGenerator = null,
bool bypassTableCreationValidation = false,
ICloudQueueProvider cloudQueueProvider = null)
{
if (loggerConfiguration == null)
{
throw new ArgumentNullException(nameof(loggerConfiguration));
}
if (string.IsNullOrEmpty(connectionString))
{
throw new ArgumentNullException(nameof(connectionString));
}
return(AzureQueueStorage(
loggerConfiguration,
new JsonFormatter(formatProvider: formatProvider, closingDelimiter: ""),
connectionString,
restrictedToMinimumLevel,
storageQueueName,
bypassTableCreationValidation,
cloudQueueProvider));
}
/// <summary>
/// Construct a sink that saves logs to the specified storage account.
/// </summary>
/// <param name="storageAccount">The Cloud Storage Account containing the queue.</param>
/// <param name="textFormatter"></param>
/// <param name="storageQueueName">Queue name that messages will be written to.</param>
/// <param name="keyGenerator">generator used to generate partition keys and row keys</param>
/// <param name="bypassQueueCreationValidation">Bypass the exception in case the queue creation fails.</param>
/// <param name="cloudQueueProvider">Cloud queue provider to get current queue.</param>
public AzureQueueStorageSink(
CloudStorageAccount storageAccount,
ITextFormatter textFormatter,
string storageQueueName = null,
bool bypassQueueCreationValidation = false,
ICloudQueueProvider cloudQueueProvider = null)
{
_textFormatter = textFormatter;
_storageAccount = storageAccount;
_storageQueueName = storageQueueName;
_bypassQueueCreationValidation = bypassQueueCreationValidation;
_cloudQueueProvider = cloudQueueProvider ?? new DefaultCloudQueueProvider();
}
/// <summary>
/// Adds a sink that writes log events as records in Azure Table Storage table (default name LogEventEntity) using the given
/// storage account name and Shared Access Signature (SAS) URL.
/// </summary>
/// <param name="loggerConfiguration">The logger configuration.</param>
/// <param name="formatter">Use a Serilog ITextFormatter such as CompactJsonFormatter to store object in data column of Azure table</param>
/// <param name="sharedAccessSignature">The storage account/table SAS key.</param>
/// <param name="accountName">The storage account name.</param>
/// <param name="restrictedToMinimumLevel">The minimum log event level required in order to write an event to the sink.</param>
/// <param name="storageQueueName">Storage queue name.</param>
/// <param name="cloudQueueProvider">Cloud table provider to get current log table.</param>
/// <returns>Logger configuration, allowing configuration to continue.</returns>
/// <exception cref="ArgumentNullException">A required parameter is null.</exception>
public static LoggerConfiguration AzureQueueStorage(
this LoggerSinkConfiguration loggerConfiguration,
ITextFormatter formatter,
string sharedAccessSignature,
string accountName,
LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
string storageQueueName = null,
ICloudQueueProvider cloudQueueProvider = null)
{
if (loggerConfiguration == null)
{
throw new ArgumentNullException(nameof(loggerConfiguration));
}
if (formatter == null)
{
throw new ArgumentNullException(nameof(formatter));
}
if (string.IsNullOrWhiteSpace(accountName))
{
throw new ArgumentNullException(nameof(accountName));
}
if (string.IsNullOrWhiteSpace(sharedAccessSignature))
{
throw new ArgumentNullException(nameof(sharedAccessSignature));
}
try
{
var credentials = new StorageCredentials(sharedAccessSignature);
CloudStorageAccount storageAccount = new CloudStorageAccount(credentials, accountName, endpointSuffix: null, useHttps: true);
// We set bypassTableCreationValidation to true explicitly here as the the SAS URL might not have enough permissions to query if the table exists.
return(AzureQueueStorage(
loggerConfiguration,
formatter,
storageAccount,
restrictedToMinimumLevel,
storageQueueName,
true,
false,
cloudQueueProvider));
}
catch (Exception ex)
{
Debugging.SelfLog.WriteLine($"Error configuring AzureQueueStorage: {ex}");
ILogEventSink sink = new LoggerConfiguration().CreateLogger();
return(loggerConfiguration.Sink(sink, restrictedToMinimumLevel));
}
}
/// <summary>
/// Adds a sink that writes log events as records in an Azure Table Storage table (default LogEventEntity) using the given storage account.
/// </summary>
/// <param name="loggerConfiguration">The logger configuration.</param>
/// <param name="formatter">Use a Serilog ITextFormatter such as CompactJsonFormatter to store object in data column of Azure table</param>
/// <param name="storageAccount">The Cloud Storage Account to use to insert the log entries to.</param>
/// <param name="restrictedToMinimumLevel">The minimum log event level required in order to write an event to the sink.</param>
/// <param name="storageQueueName">Storage queue name.</param>
/// <param name="bypassTableCreationValidation">Bypass the exception in case the table creation fails.</param>
/// <param name="separateQueuesByLogLevel">Flag for several queues usage by log level.</param>
/// <param name="cloudQueueProvider">Cloud table provider to get current log table.</param>
/// <returns>Logger configuration, allowing configuration to continue.</returns>
/// <exception cref="ArgumentNullException">A required parameter is null.</exception>
public static LoggerConfiguration AzureQueueStorage(
this LoggerSinkConfiguration loggerConfiguration,
ITextFormatter formatter,
CloudStorageAccount storageAccount,
LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
string storageQueueName = null,
bool bypassTableCreationValidation = false,
bool separateQueuesByLogLevel = false,
ICloudQueueProvider cloudQueueProvider = null)
{
if (loggerConfiguration == null)
{
throw new ArgumentNullException(nameof(loggerConfiguration));
}
if (formatter == null)
{
throw new ArgumentNullException(nameof(formatter));
}
if (storageAccount == null)
{
throw new ArgumentNullException(nameof(storageAccount));
}
ILogEventSink sink;
try
{
sink = new AzureQueueStorageSink(
storageAccount,
formatter,
storageQueueName,
bypassTableCreationValidation,
separateQueuesByLogLevel,
cloudQueueProvider);
}
catch (Exception ex)
{
Debugging.SelfLog.WriteLine($"Error configuring AzureQueueStorage: {ex}");
sink = new LoggerConfiguration().CreateLogger();
}
return(loggerConfiguration.Sink(sink, restrictedToMinimumLevel));
}
/// <summary>
/// Construct a sink that saves logs to the specified storage account.
/// </summary>
/// <param name="storageAccount">The Cloud Storage Account containing the queue.</param>
/// <param name="textFormatter"></param>
/// <param name="storageQueueName">Queue name that messages will be written to.</param>
/// <param name="bypassQueueCreationValidation">Bypass the exception in case the queue creation fails.</param>
/// <param name="separateQueuesByLogLevel">Flag for several queues usage by log level</param>
/// <param name="cloudQueueProvider">Cloud queue provider to get current queue.</param>
public AzureQueueStorageSink(
CloudStorageAccount storageAccount,
ITextFormatter textFormatter,
string storageQueueName = null,
bool bypassQueueCreationValidation = false,
bool separateQueuesByLogLevel = false,
ICloudQueueProvider cloudQueueProvider = null)
{
_textFormatter = textFormatter;
_storageAccount = storageAccount;
_storageQueueName = storageQueueName;
_bypassQueueCreationValidation = bypassQueueCreationValidation;
_separateQueuesByLogLevel = separateQueuesByLogLevel;
_cloudQueueProvider = cloudQueueProvider ?? new DefaultCloudQueueProvider();
if (separateQueuesByLogLevel)
{
_queuesDictionary = new ConcurrentDictionary <string, CloudQueue>();
}
else
{
_queue = _cloudQueueProvider.GetCloudQueue(_storageAccount, _storageQueueName, _bypassQueueCreationValidation);
}
}
