Skip to content

README.md

Latest commit

 

History

History
140 lines (86 loc) · 5.27 KB

README.md

File metadata and controls

140 lines (86 loc) · 5.27 KB
Raw

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>

General Options

name - Name of the target.

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

queueName - QueueName. Layout

connectionString - Azure Queue Storage connection string from your storage account. Required unless using serviceUri.

serviceUri - Alternative to ConnectionString, where Managed Identiy is acquired from DefaultAzureCredential.

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

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

Authentication Options

managedIdentityClientId - clientId for ManagedIdentityClientId on DefaultAzureCredentialOptions. Requires serviceUri

managedIdentityResourceId - resourceId for ManagedIdentityResourceId on DefaultAzureCredentialOptions, do not use together with ManagedIdentityClientId. Requires serviceUri.

tenantIdentity - tenantId for DefaultAzureCredentialOptions. Requires serviceUri.

sharedAccessSignature - Access signature for AzureSasCredential authentication. Requires serviceUri.

accountName - accountName for StorageSharedKeyCredential authentication. Requires serviceUri and accessKey.

accessKey - accountKey for StorageSharedKeyCredential authentication. Requires serviceUri and accountName.

clientAuthId - clientId for ClientSecretCredential OAuth2 authentication. Requires serviceUri, tenantIdentity and clientAuthSecret.

clientAuthSecret - clientSecret for ClientSecretCredential OAuth2 authentication. Requires serviceUri,tenantIdentity and clientAuthId.

When using ServiceUri (Instead of ConnectionString) with DefaultAzureCredential, then Azure Identity can also resolve from environment variables:

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

See also: Set up Your Environment for Authentication

Proxy Options

noProxy - Bypasses any system proxy and proxy in ProxyAddress when set to true.

proxyAddress - Address of the proxy server to use (e.g. http://proxyserver:8080).

proxyLogin - Login to use for the proxy server. Requires proxyPassword.

proxyPassword - Password to use for the proxy server. Requires proxyLogin.

useDefaultCredentialsForProxy - Uses the default credentials (System.Net.CredentialCache.DefaultCredentials) for the proxy server. Take precedence over proxyLogin and proxyPassword when set to true.

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 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;");