Skip to content

Latest commit

 

History

History
123 lines (78 loc) · 4.48 KB

README.md

File metadata and controls

123 lines (78 loc) · 4.48 KB

Azure QueueStorage

Package Name NuGet Description
NLog.Extensions.AzureQueueStorage NuGet Azure Queue Storage

Queue Configuration

Syntax

<extensions>
  <add assembly="NLog.Extensions.AzureQueueStorage" /> 
</extensions>

<targets>
  <target xsi:type="AzureQueueStorage"
          name="String"
          layout="Layout"
          connectionString="Layout"
          queueName="Layout">
            <metadata name="mymeta" layout="mymetavalue" />   <!-- Multiple allowed -->
  </target>
</targets>

Parameters

name - Name of the target.

layout - Queue Message Text to be rendered. Layout Required.

queueName - QueueName. Layout

connectionString - Azure storage connection string. Ex. UseDevelopmentStorage=true;

serviceUri - Alternative to ConnectionString, where Managed Identiy is acquired from DefaultAzureCredential for User delegation SAS.

clientIdentity - Alternative to ConnectionString. Used together with ServiceUri. Input for DefaultAzureCredential as ManagedIdentityClientId.

resourceIdentity - Alternative to ConnectionString. Used together with ServiceUri. Input for DefaultAzureCredential as ManagedIdentityResourceId.

tenantIdentity - Alternative to ConnectionString. Used together with ServiceUri. Input for DefaultAzureCredential.

sharedAccessSignature - Alternative to ConnectionString. Used together with ServiceUri. Input for AzureSasCredential

accountName - Alternative to ConnectionString. Used together with ServiceUri. Input for StorageSharedKeyCredential-AccountName

accessKey - Alternative to ConnectionString. Used together with ServiceUri. Input for StorageSharedKeyCredential-AccessKey

timeToLiveSeconds - Default Time-To-Live (TTL) for Queue messages in seconds (Optional)

timeToLiveDays - Default Time-To-Live (TTL) for Queue messages in days (Optional)

Batching Policy

batchSize - Number of EventData items to send in a single batch (Default=100)

taskDelayMilliseconds - Artificial delay before sending to optimize for batching (Default=200 ms)

queueLimit - Number of pending LogEvents to have in memory queue, that are waiting to be sent (Default=10000)

overflowAction - Action to take when reaching limit of in memory queue (Default=Discard)

Retry Policy

taskTimeoutSeconds - How many seconds a Task is allowed to run before it is cancelled (Default 150 secs)

retryDelayMilliseconds - How many milliseconds to wait before next retry (Default 500ms, and will be doubled on each retry).

retryCount - How many attempts to retry the same Task, before it is aborted (Default 0)

Azure Identity Environment

When using ServiceUri (Instead of ConnectionString), then DefaultAzureCredential is used for Azure Identity which supports environment variables:

  • AZURE_CLIENT_ID - For ManagedIdentityClientId / WorkloadIdentityClientId
  • AZURE_TENANT_ID - For TenantId

See also: Set up Your Environment for Authentication

Azure ConnectionString

NLog Layout makes it possible to retrieve settings from many locations.

Lookup ConnectionString from appsettings.json

connectionString="${configsetting:ConnectionStrings.AzureQueue}"

  • Example appsettings.json on .NetCore:
  {
    "ConnectionStrings": {
      "AzureQueue": "UseDevelopmentStorage=true;"
    }
  }

Lookup ConnectionString from app.config

connectionString="${appsetting:ConnectionStrings.AzureQueue}"

  • Example app.config on .NetFramework:
  <configuration>
    <connectionStrings>
      <add name="AzureQueue" connectionString="UseDevelopmentStorage=true;"/>
    </connectionStrings>
  </configuration>

Lookup ConnectionString from environment-variable

connectionString="${environment:AZURE_STORAGE_CONNECTION_STRING}"

Lookup ConnectionString from NLog GlobalDiagnosticsContext (GDC)

connectionString="${gdc:AzureQueueConnectionString}"

  • Example code for setting GDC-value:
  NLog.GlobalDiagnosticsContext.Set("AzureQueueConnectionString", "UseDevelopmentStorage=true;");