Add support for connection string to Microsoft.ApplicationInsights.NLogTarget

[saidi-adot]

Add support for connection string to Microsoft.ApplicationInsights.NLogTarget #2714

Fix Issue # .

Changes

(Please provide a brief description of the changes here.)

Checklist

• I ran Unit Tests locally.
• CHANGELOG.md updated with one line description of the fix, and a link to the original issue if available.

For significant contributions please make sure you have completed the following items:

• Design discussion issue #
• Changes in public surface reviewed

The PR will trigger build, unit tests, and functional tests automatically. Please follow these instructions to build and test locally.

Notes for authors:

• FxCop and other analyzers will fail the build. To see these errors yourself, compile localy using the Release configuration.

Notes for reviewers:
We support comment build triggers

• /AzurePipelines run will queue all builds
• /AzurePipelines run will queue a specific build

[saidi-adot]

@TimothyMothra @cijothomas - Can you please review the PR

[cijothomas]

#2750 (comment)

[saidi-adot]

#2750 (comment)

@rajkumar-rangaraj and @TimothyMothra - Can you please let us know your thoughts on this.

[snakefoot]

Maybe implement like this:

            string connectionString = this.connectionStringLayout.Render(LogEventInfo.CreateNullEvent());

            // Check if nlog application insights target has connectionstring in config file then
            // configure new telemetryclient with the connectionstring otherwise using legacy instrumentationkey.
            if (!string.IsNullOrWhiteSpace(connectionString))
            {
                var telemetryConfiguration = TelemetryConfiguration.CreateDefault();
                telemetryConfiguration.ConnectionString = connectionString;
                this.telemetryClient = new TelemetryClient(telemetryConfiguration);
            }
            else
            {
#pragma warning disable CS0618 // Type or member is obsolete: TelemtryConfiguration.Active is used in TelemetryClient constructor.
                this.telemetryClient = new TelemetryClient();
#pragma warning restore CS0618 // Type or member is obsolete
                string instrumentationKey = this.instrumentationKeyLayout.Render(LogEventInfo.CreateNullEvent());
                if (!string.IsNullOrWhiteSpace(instrumentationKey))
                {
                    this.telemetryClient.Context.InstrumentationKey = instrumentationKey;
                }
            }

This will resolve the issue about not to modify TelemtryConfiguration.Active

[snakefoot]

@cijothomas If NLog-target changes from using obsolete/legacy TelemetryClient (depending on on TelemtryConfiguration.Active), to instead create its own local TelemetryClient using connectionString. Would you accept the pull-request ?

[snakefoot]

@cijothomas Polite poke. If NLog-target changes from using obsolete/legacy TelemetryClient (depending on on TelemtryConfiguration.Active), to instead create its own local TelemetryClient using connectionString. Would you accept the pull-request ?

[cijothomas]

@cijothomas Polite poke. If NLog-target changes from using obsolete/legacy TelemetryClient (depending on on TelemtryConfiguration.Active), to instead create its own local TelemetryClient using connectionString. Would you accept the pull-request ?

I'll let @rajkumar-rangaraj @TimothyMothra to comment on if this repo plan to accept new features, given the OTel movement.

From a technical standpoint, creating own TelemetryClient would mean it'll have a config, different from the rest of the application, right?

[snakefoot]

@cijothomas From a technical standpoint, creating own TelemetryClient would mean it'll have a config, different from the rest of the application, right?

Yes like this:

                var telemetryConfiguration = TelemetryConfiguration.CreateDefault();
                telemetryConfiguration.ConnectionString = connectionString;
                this.telemetryClient = new TelemetryClient(telemetryConfiguration);

Thus not depend on deprecated TelemtryConfiguration.Active, that requires one to explicit configure EnableActiveTelemetryConfigurationSetup to make the NLog-target work. Giving a better user-experience.

[snakefoot]

@cijothomas + @rajkumar-rangaraj + @TimothyMothra Are you willing to accept pull-request that allows NLog to use ConnectionString and no longer use the now deprecated TelemtryConfiguration.Active ?

This will give a better user-experience, as people doesn't have to explicit set EnableActiveTelemetryConfigurationSetup

[ahanneman-adot]

@cijothomas + @rajkumar-rangaraj + @TimothyMothra Please accept this Pull Request.

Azure is ending support for InstrumentationKey in March 2025 forcing everyone to switch to ConnectionString. We really like using NLog and it huge be a huge effort for us to switch off of NLog. We cannot be losing application logs, we need to be able to continue to support our applications.

[snakefoot]

Created fork #2897 that changes to use isolated TelemetryClient when using ConnectionString.

[snakefoot]

I guess when #3001 is merged from develop-branch to main-branch and released, then this can be closed.