Adding 'add-telemetry' Options to CLI for Azure Log Analytics #2772

RubenCerna2079 · 2025-07-17T00:04:43Z

Why make this change?

This change closes issue #2771.

What is this change?

This change allows the users to use the CLI command add-telemetry for the Azure Log Analytics properties.

How was this tested?

Integration Tests
Unit Tests

Sample Request(s)

Co-authored-by: RubenCerna2079 <[email protected]>

…erProvided flags Co-authored-by: aaronburtle <[email protected]>

…ided flags Co-authored-by: aaronburtle <[email protected]>

Copilot

Pull Request Overview

This PR adds CLI support for Azure Log Analytics telemetry configuration in the add-telemetry command. The changes enable users to configure Azure Log Analytics properties such as workspace ID, DCR immutable ID, DCE endpoint, log type, and flush interval through command-line options.

Key changes include:

Added new CLI options for Azure Log Analytics configuration parameters
Updated constructor parameter naming from camelCase to PascalCase for consistency
Fixed serialization logic to only include auth options when user-provided values exist

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
src/Cli/Commands/AddTelemetryOptions.cs	Added 6 new CLI options for Azure Log Analytics configuration
src/Cli/ConfigGenerator.cs	Integrated validation and object creation for Azure Log Analytics options
src/Config/ObjectModel/AzureLogAnalyticsOptions.cs	Updated constructor parameters to PascalCase naming convention
src/Config/ObjectModel/AzureLogAnalyticsAuthOptions.cs	Updated constructor parameters to PascelCase naming convention
src/Config/Converters/AzureLogAnalyticsOptionsConverterFactory.cs	Fixed serialization condition for auth options
src/Service.Tests/Configuration/ConfigurationTests.cs	Added test helper method and import
src/Cli.Tests/ValidateConfigTests.cs	Added validation test for Azure Log Analytics without auth
src/Cli.Tests/Cli.Tests.csproj	Updated BOM marker

src/Config/ObjectModel/AzureLogAnalyticsOptions.cs

src/Service.Tests/Configuration/ConfigurationTests.cs

src/Cli/Commands/AddTelemetryOptions.cs

src/Service.Tests/Configuration/ConfigurationTests.cs

RubenCerna2079 · 2025-07-17T00:17:26Z

/azp run

azure-pipelines · 2025-07-17T00:17:48Z

Azure Pipelines successfully started running 6 pipeline(s).

RubenCerna2079 · 2025-07-17T00:25:33Z

/azp run

azure-pipelines · 2025-07-17T00:25:55Z

Azure Pipelines successfully started running 6 pipeline(s).

Aniruddh25 · 2025-07-17T18:50:44Z

The issue that this PR contains should at least mention in brief what this PR is trying to achieve.

Example from parent issue that can be added:

CLI Updates
Add support to dab configure:

dab configure --azure-log-analytics.enabled
dab configure --azure-log-analytics.auth.type
dab configure --azure-log-analytics.auth.workspace-id
dab configure --azure-log-analytics.auth.shared-key
dab configure --azure-log-analytics.auth.dcr-immutable-id
dab configure --azure-log-analytics.auth.dce-endpoint
dab configure --azure-log-analytics.log-type
dab configure --azure-log-analytics.flush-interval-seconds

Aniruddh25 · 2025-07-17T21:08:24Z

src/Cli.Tests/Cli.Tests.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">


What is the change here?

I did not make any changes to this file

Aniruddh25 · 2025-07-17T21:22:54Z

src/Config/ObjectModel/AzureLogAnalyticsAuthOptions.cs

@@ -27,23 +27,23 @@ public record AzureLogAnalyticsAuthOptions
    public string? DceEndpoint { get; init; }

    [JsonConstructor]
-    public AzureLogAnalyticsAuthOptions(string? workspaceId = null, string? dcrImmutableId = null, string? dceEndpoint = null)
+    public AzureLogAnalyticsAuthOptions(string? WorkspaceId = null, string? DcrImmutableId = null, string? DceEndpoint = null)


why are we changing the casing here? function parameters usually follow camelCasing

I saw that it is the format that is used for the other Telemetry Options, if we want it to follow camelCasing we need to change the other options as well

Aniruddh25 · 2025-07-17T21:23:16Z

src/Config/ObjectModel/AzureLogAnalyticsOptions.cs

@@ -49,38 +49,38 @@ public record AzureLogAnalyticsOptions
    public int? FlushIntervalSeconds { get; init; }

    [JsonConstructor]
-    public AzureLogAnalyticsOptions(bool? enabled = null, AzureLogAnalyticsAuthOptions? auth = null, string? logType = null, int? flushIntervalSeconds = null)
+    public AzureLogAnalyticsOptions(bool? Enabled = null, AzureLogAnalyticsAuthOptions? Auth = null, string? LogType = null, int? FlushIntervalSeconds = null)


same question here: why is this change needed?

I saw that it is the format that is used for the other Telemetry Options, if we want it to follow camelCasing we need to change the other options as well

Aniruddh25 · 2025-07-17T21:28:17Z

src/Cli/Commands/AddTelemetryOptions.cs

+        public string? AzureLogAnalyticsLogType { get; }
+
+        // Specify the flush interval in seconds for Azure Log Analytics resource to which telemetry data should be sent.
+        [Option("azure-log-analytics-flush-interval-seconds", Required = false, HelpText = "Flush Interval Seconds for Azure Log Analytics for specifying time it takes to send telemetry data")]


Suggested change

[Option("azure-log-analytics-flush-interval-seconds", Required = false, HelpText = "Flush Interval Seconds for Azure Log Analytics for specifying time it takes to send telemetry data")]

[Option("azure-log-analytics-flush-interval-seconds", Required = false, HelpText = "Flush Interval in seconds for Azure Log Analytics for specifying time it takes to send telemetry data")]

Aniruddh25 · 2025-07-17T21:30:10Z

src/Cli/Commands/AddTelemetryOptions.cs

+        public int? AzureLogAnalyticsFlushIntervalSeconds { get; }
+
+        // Specify the Workspace ID for Azure Log Analytics resource to which telemetry data should be sent.
+        [Option("azure-log-analytics-auth-workspace-id", Required = false, HelpText = "Workspace ID for Azure Log Analytics to find table to send telemetry data")]


the helptext needs to be updated to mention WorkspaceID. Looks like a copy paste issue

Aniruddh25 · 2025-07-17T21:30:36Z

src/Cli/Commands/AddTelemetryOptions.cs

+
+        // Specify the DCR Immutable ID for Azure Log Analytics resource to which telemetry data should be sent.
+        [Option("azure-log-analytics-auth-dcr-immutable-id", Required = false, HelpText = "DCR Immutable ID for Azure Log Analytics to find table to send telemetry data")]
+        public string? AzureLogAnalyticsDcrImmutableId { get; }


the help text needs to be updated to mention DCR Immutable ID. Looks like a copy paste issue

Aniruddh25 · 2025-07-17T21:34:57Z

src/Cli.Tests/AddAzureLogAnalyticsTests.cs

+        }
+
+        /// <summary>
+        /// Represents a JSON string for the telemetry section of the config, with Application Insights enabled and a specified connection string.


This summary needs to be updated. Typo.

Aniruddh25 · 2025-07-17T21:35:18Z

src/Cli.Tests/AddAzureLogAnalyticsTests.cs

+            ""telemetry"": {}";
+
+        /// <summary>
+        /// Represents a JSON string for the empty telemetry section of the config.


Summary needs to be updated.

Aniruddh25

Overall looks fine, but needs to fix description, title to mention this is adding add-telemetry options to the CLI instead of saying "Add CLI Azure Log Analytics".

JerryNixon · 2025-07-18T16:54:11Z

src/Cli/Commands/AddTelemetryOptions.cs

@@ -68,6 +80,30 @@ public AddTelemetryOptions(
        [Option("otel-service-name", Default = "dab", Required = false, HelpText = "(Default: dab) Headers for Open Telemetry for telemetry data")]
        public string? OpenTelemetryServiceName { get; }

+        // To specify whether Azure Log Analytics telemetry should be enabled. This flag is optional and default value is false.
+        [Option("azure-log-analytics-enabled", Default = CliBool.False, Required = false, HelpText = "(Default: false) Enable/Disable Azure Log Analytics")]


The correct syntax should be dab configure --runtime.telemetry.azure-log-analytics.enabled true please.

Copilot AI and others added 30 commits July 16, 2025 16:14

Initial plan for issue

ec54f52

Complete: Add Azure Log Analytics properties support to DAB

3e5a6ae

Co-authored-by: RubenCerna2079 <[email protected]>

Fix Unit Tests

38c272c

Fix Unit Tests

967431d

Changes to properties and tests

e063ab3

Change tests

982a37a

Fix Unit Tests

b3fb72e

Update AzureLogAnalyticsOptions to follow established pattern with Us…

b446e75

…erProvided flags Co-authored-by: aaronburtle <[email protected]>

Add JsonConverterFactory for AzureLogAnalyticsOptions to use UserProv…

bf47476

…ided flags Co-authored-by: aaronburtle <[email protected]>

Fix unit tests

31a5d1d

Changes based on comments

9f8d9b4

Changes based on comments

dabfaed

Changes based on comments

9fd5d75

Remove unecessary tests

adf616a

Fix Unit Tests

a2842d9

Changes based on comments

eee31c2

Fix launch settings file

43cf250

Fix errors

5d3f0a9

Fix test failure

34560a3

Changes based on comments

f4dea9e

Fix Unit Tests

2c4dacc

Initial plan for issue

1283d20

Changes based on comments

d2baa81

Add CLI

b7a2d85

Add CLI

7faa652

Finish CLI functionality

6ee43c3

Add log error to CLI

a9cad34

Test Refactoring

c3153c4

Test Refactoring 2

b277ec3

Validation Changes

a93d302

RubenCerna2079 requested review from aaronburtle, anushakolan, souvikghosh04, ravishetye, neeraj-sharma2592, sourabh1007, vadeveka, Alekhya-Polavarapu and rusamant as code owners July 17, 2025 00:04

Copilot AI reviewed Jul 17, 2025

View reviewed changes

Fix Unit Tests

9c048f1

RubenCerna2079 changed the title ~~Dev/rubencerna/add cli log analytics~~ Add CLI Azure Log Analytics Jul 17, 2025

Add File with Tests

6adeba4

RubenCerna2079 linked an issue Jul 17, 2025 that may be closed by this pull request

Add CLI for Azure Log Analytics #2771

Open

Aniruddh25 reviewed Jul 17, 2025

View reviewed changes

Aniruddh25 requested changes Jul 17, 2025

View reviewed changes

RubenCerna2079 changed the title ~~Add CLI Azure Log Analytics~~ Adding 'add-telemetry' Options to CLI for Azure Log Analytics Jul 17, 2025

JerryNixon requested changes Jul 18, 2025

View reviewed changes

		@@ -1,4 +1,4 @@
		<Project Sdk="Microsoft.NET.Sdk">
		<Project Sdk="Microsoft.NET.Sdk">

	[Option("azure-log-analytics-flush-interval-seconds", Required = false, HelpText = "Flush Interval Seconds for Azure Log Analytics for specifying time it takes to send telemetry data")]
	[Option("azure-log-analytics-flush-interval-seconds", Required = false, HelpText = "Flush Interval in seconds for Azure Log Analytics for specifying time it takes to send telemetry data")]

Adding 'add-telemetry' Options to CLI for Azure Log Analytics #2772

Are you sure you want to change the base?

Adding 'add-telemetry' Options to CLI for Azure Log Analytics #2772

Conversation

RubenCerna2079 commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why make this change?

What is this change?

How was this tested?

Sample Request(s)

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

RubenCerna2079 commented Jul 17, 2025

Uh oh!

azure-pipelines bot commented Jul 17, 2025

Uh oh!

RubenCerna2079 commented Jul 17, 2025

Uh oh!

azure-pipelines bot commented Jul 17, 2025

Uh oh!

Aniruddh25 commented Jul 17, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Aniruddh25 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

RubenCerna2079 commented Jul 17, 2025 •

edited

Loading