[Containerapp] az containerapp env telemetry: add command for updating telemetry settings

src/containerapp/HISTORY.rst

@@ -7,6 +7,10 @@ upcoming
 * 'az containerapp env dapr-component resiliency': Add support for Dapr Component Resiliency Circuit Breakers
 * 'az containerapp create/update/up': Don't compress jar/war/zip file before upload source code
 * 'az containerapp create/update/up': Update source to cloud builder to 20240124.1
+* 'az containerapp env telemetry data-dog set': support update environment data dog configuration with --site, --key, --enable-open-telemetry-traces and --enable-open-telemetry-metrics
+* 'az containerapp env telemetry data-dog delete': support delete environment data dog configuration
+* 'az containerapp env telemetry app-insights set': support update environment app insights configuration with --connection-string, --enable-open-telemetry-traces and --enable-open-telemetry-logs
+* 'az containerapp env telemetry app-insights delete': support delete environment app insights configuration
 
 0.3.47
 ++++++

src/containerapp/azext_containerapp/_help.py

@@ -1274,3 +1274,43 @@
               --image imageName \\
               --workload-profile-name my-wlp
 """
+
+# Container Apps Telemetry Commands
+
+helps['containerapp env telemetry data-dog set'] = """
+    type: command
+    short-summary: Create or update container apps environment telemetry data dog settings.
+    examples:
+    - name: Create or update container apps environment telemetry data dog settings.
+      text: |
+          az containerapp env telemetry data-dog set -n MyContainerappEnvironment -g MyResourceGroup \\
+              --site dataDogSite --key dataDogKey --enable-open-telemetry-traces true --enable-open-telemetry-metrics true
+"""
+
+helps['containerapp env telemetry app-insights set'] = """
+    type: command
+    short-summary: Create or update container apps environment telemetry app insights settings.
+    examples:
+    - name: Create or update container apps environment telemetry app insights settings.
+      text: |
+          az containerapp env telemetry app-insights set -n MyContainerappEnvironment -g MyResourceGroup \\
+              --connection-string connectionString --enable-open-telemetry-traces true --enable-open-telemetry-metrics true
+"""
+
+helps['containerapp env telemetry data-dog delete'] = """
+    type: command
+    short-summary: Delete container apps environment telemetry data dog settings.
+    examples:
+    - name: Delete container apps environment telemetry data dog settings.
+      text: |
+          az containerapp env telemetry data-dog delete -n MyContainerappEnvironment -g MyResourceGroup
+"""
+
+helps['containerapp env telemetry app-insights delete'] = """
+    type: command
+    short-summary: Delete container apps environment telemetry data dog settings.
+    examples:
+    - name: Delete container apps environment telemetry app insights settings.
+      text: |
+          az containerapp env telemetry app-insights delete -n MyContainerappEnvironment -g MyResourceGroup
+"""

src/containerapp/azext_containerapp/_models.py

@@ -21,7 +21,8 @@
         "appLogsConfiguration": None,
         "customDomainConfiguration": None,  # CustomDomainConfiguration,
         "workloadProfiles": None,
-        "InfrastructureResourceGroup": None
+        "infrastructureResourceGroup": None,
+        "openTelemetryConfiguration": None
     }
 }
 
@@ -536,6 +537,38 @@
     "type": None
 }
 
+AppInsightsConfiguration = {
+    "connectionString": None
+}
+
+OpenTelemetryConfiguration = {
+    "destinationsConfiguration": None,
+    "tracesConfiguration": None,
+    "logsConfiguration": None,
+    "metricsConfiguration": None
+}
+
+DestinationsConfiguration = {
+    "dataDogConfiguration": None
+}
+
+DataDogConfiguration = {
+    "site": None,
+    "key": None
+}
+
+TracesConfiguration = {
+    "destinations": []
+}
+
+LogsConfiguration = {
+    "destinations": []
+}
+
+MetricsConfiguration = {
+    "destinations": []
+}
+
 ManagedServiceIdentity = {
     "type": None,  # 'None', 'SystemAssigned', 'UserAssigned', 'SystemAssigned,UserAssigned'
     "userAssignedIdentities": None  # {string: UserAssignedIdentity}

src/containerapp/azext_containerapp/_params.py

@@ -64,6 +64,19 @@ def load_arguments(self, _):
         c.argument('logs_dynamic_json_columns', options_list=['--logs-dynamic-json-columns', '-j'], arg_type=get_three_state_flag(),
                    help='Boolean indicating whether to parse json string log into dynamic json columns. Only work for destination log-analytics.', is_preview=True)
 
+    # Telemetry 
+    with self.argument_context('containerapp env telemetry data-dog set') as c:
+        c.argument('site', options_list=['--site'], help='Specify the data dog site')
+        c.argument('key', options_list=['--key'], help='Specify the data dog api key')
+        c.argument('enable_open_telemetry_traces', options_list=['--enable-open-telemetry-traces', '-t'], arg_type=get_three_state_flag(), help='Boolean indicating whether to enable data dog open telemetry traces')
+        c.argument('enable_open_telemetry_metrics', options_list=['--enable-open-telemetry-metrics', '-m'], arg_type=get_three_state_flag(), help='Boolean indicating whether to enable data dog open telemetry metrics')
+
+    with self.argument_context('containerapp env telemetry app-insights set') as c:
+        c.argument('connection_string', options_list=['--connection-string'], help='Application Insights connection string used by container apps environment')
+        c.argument('enable_open_telemetry_traces', options_list=['--enable-open-telemetry-traces', '-t'], arg_type=get_three_state_flag(), help='Boolean indicating whether to enable application insights open telemetry traces')
+        c.argument('enable_open_telemetry_logs', options_list=['--enable-open-telemetry-logs', '-l'], arg_type=get_three_state_flag(), help='Boolean indicating whether to enable application insights open telemetry logs')
+
+    # Storage
     with self.argument_context('containerapp env storage') as c:
         c.argument('storage_type', arg_type = get_enum_type(['AzureFile', 'NfsAzureFile']), help="Type of the storage. Assumed to be AzureFile if not specified.", is_preview=True)
         c.argument('access_mode', id_part=None, arg_type=get_enum_type(["ReadWrite", "ReadOnly"]),
@@ -176,9 +189,6 @@ def load_arguments(self, _):
         c.argument('user_assigned', nargs='+', help="Space-separated user identities.")
         c.argument('system_assigned', help="Boolean indicating whether to assign system-assigned identity.", action='store_true')
 
-    with self.argument_context('containerapp env identity remove', is_preview=True) as c:
-        c.argument('user_assigned', nargs='*', help="Space-separated user identities. If no user identities are specified, all user identities will be removed.")
-
     with self.argument_context('containerapp up') as c:
         c.argument('environment', validator=validate_env_name_or_id_for_up, options_list=['--environment'], help="Name or resource ID of the container app's managed environment or connected environment.")
         c.argument('artifact', help="Local path to the application artifact for building the container image. See the supported artifacts here: https://aka.ms/SourceToCloudSupportedArtifacts.", is_preview=True)

src/containerapp/azext_containerapp/commands.py

@@ -130,6 +130,16 @@ def load_command_table(self, _):
         g.custom_show_command('show', 'show_dapr_component_resiliency')
         g.custom_show_command('list', 'list_dapr_component_resiliencies')
 
+    self.command_group('containerapp env telemetry', is_preview=True)
+
+    with self.command_group('containerapp env telemetry data-dog', is_preview=True) as g:
+        g.custom_command('set', 'set_environment_telemetry_data_dog', supports_no_wait=True, exception_handler=ex_handler_factory())
+        g.custom_command('delete', 'delete_environment_telemetry_data_dog', supports_no_wait=True, exception_handler=ex_handler_factory())
+
+    with self.command_group('containerapp env telemetry app-insights', is_preview=True) as g:
+        g.custom_command('set', 'set_environment_telemetry_app_insights', supports_no_wait=True, exception_handler=ex_handler_factory())
+        g.custom_command('delete', 'delete_environment_telemetry_app_insights', supports_no_wait=True, exception_handler=ex_handler_factory())
+
     with self.command_group('containerapp github-action') as g:
         g.custom_command('add', 'create_or_update_github_action', exception_handler=ex_handler_factory())
 

src/containerapp/azext_containerapp/containerapp_env_decorator.py

@@ -45,7 +45,7 @@ def set_up_dynamic_json_columns(self):
 
     def set_up_infrastructure_resource_group(self):
         if self.get_argument_enable_workload_profiles() and self.get_argument_infrastructure_subnet_resource_id() is not None:
-            self.managed_env_def["properties"]["InfrastructureResourceGroup"] = self.get_argument_infrastructure_resource_group()
+            self.managed_env_def["properties"]["infrastructureResourceGroup"] = self.get_argument_infrastructure_resource_group()
 
     def set_up_managed_identity(self):
         identity_def = ManagedServiceIdentity

src/containerapp/azext_containerapp/containerapp_env_telemetry_decorator.py

@@ -0,0 +1,157 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+from azure.cli.command_modules.containerapp._utils import safe_set, safe_get
+from knack.log import get_logger
+from knack.util import CLIError
+from ._client_factory import handle_raw_exception
+from azure.cli.command_modules.containerapp.base_resource import BaseResource
+from azure.cli.core.commands import AzCliCommand
+from typing import Any, Dict
+
+DATA_DOG_DEST = 'dataDog'
+APP_INSIGHTS_DEST = 'appInsights'
+logger = get_logger(__name__)
+
+
+class ContainerappEnvTelemetryDataDogPreviewSetDecorator(BaseResource):
+
+    def __init__(self, cmd: AzCliCommand, client: Any, raw_parameters: Dict, models: str):
+        super().__init__(cmd, client, raw_parameters, models)
+        self.managed_env_def = {}
+        self.existing_managed_env_def = {}
+
+
+    def get_argument_open_telemetry_data_dog_site(self):
+        return self.get_param("site")
+
+    def get_argument_open_telemetry_data_dog_key(self):
+        return self.get_param("key")
+
+    def get_argument_enable_open_telemetry_traces(self):
+        return self.get_param("enable_open_telemetry_traces")
+
+    def get_argument_enable_open_telemetry_metrics(self):
+        return self.get_param("enable_open_telemetry_metrics")
+
+    def construct_payload(self):
+        # Get containerapp env properties of CA we are updating
+        try:
+            self.existing_managed_env_def = self.client.show(cmd=self.cmd, resource_group_name=self.get_argument_resource_group_name(), name=self.get_argument_name())
+        except Exception as e:
+            handle_raw_exception(e)
+
+        self.set_up_open_telemetry_data_dog_site()
+        self.set_up_open_telemetry_data_dog_key()
+        self.set_up_open_telemetry_traces_destinations()
+        self.set_up_open_telemetry_metrics_destinations()
+
+    def set_up_open_telemetry_data_dog_site(self):
+        if self.get_argument_open_telemetry_data_dog_site() and self.get_argument_open_telemetry_data_dog_site() is not None:
+            safe_set(self.managed_env_def, "properties", "openTelemetryConfiguration", "destinationsConfiguration", "dataDogConfiguration", "site", value=self.get_argument_open_telemetry_data_dog_site())
+
+    def set_up_open_telemetry_data_dog_key(self):
+        if self.get_argument_open_telemetry_data_dog_key() and self.get_argument_open_telemetry_data_dog_key() is not None:
+            safe_set(self.managed_env_def, "properties", "openTelemetryConfiguration", "destinationsConfiguration", "dataDogConfiguration", "key", value=self.get_argument_open_telemetry_data_dog_key())
+
+    def set_up_open_telemetry_traces_destinations(self):
+        existing_traces = safe_get(self.existing_managed_env_def, "properties", "openTelemetryConfiguration", "tracesConfiguration", "destinations")
+        if existing_traces is None:
+            if self.get_argument_enable_open_telemetry_traces():
+                existing_traces = [DATA_DOG_DEST]
+                safe_set(self.managed_env_def, "properties", "openTelemetryConfiguration", "tracesConfiguration", "destinations", value=existing_traces)
+        else:
+            if self.get_argument_enable_open_telemetry_traces() and DATA_DOG_DEST not in existing_traces:
+                existing_traces.append(DATA_DOG_DEST) 
+                safe_set(self.managed_env_def, "properties", "openTelemetryConfiguration", "tracesConfiguration", "destinations", value=existing_traces)
+            elif not self.get_argument_enable_open_telemetry_traces() and DATA_DOG_DEST in existing_traces:
+                existing_traces.remove(DATA_DOG_DEST)
+                safe_set(self.managed_env_def, "properties", "openTelemetryConfiguration", "tracesConfiguration", "destinations", value=existing_traces)
+
+    def set_up_open_telemetry_metrics_destinations(self):
+        existing_metrics = safe_get(self.existing_managed_env_def, "properties", "openTelemetryConfiguration", "metricsConfiguration", "destinations")
+        if existing_metrics is None:
+            if self.get_argument_enable_open_telemetry_metrics():
+                existing_metrics = [DATA_DOG_DEST]
+                safe_set(self.managed_env_def, "properties", "openTelemetryConfiguration", "metricsConfiguration", "destinations", value=existing_metrics)
+        else:
+            if self.get_argument_enable_open_telemetry_traces() and DATA_DOG_DEST not in existing_metrics:
+                existing_metrics.append(DATA_DOG_DEST)
+                safe_set(self.managed_env_def, "properties", "openTelemetryConfiguration", "metricsConfiguration", "destinations", value=existing_metrics)
+            elif not self.get_argument_enable_open_telemetry_traces() and DATA_DOG_DEST in existing_metrics:
+                existing_metrics.remove(DATA_DOG_DEST)
+                safe_set(self.managed_env_def, "properties", "openTelemetryConfiguration", "metricsConfiguration", "destinations", value=existing_metrics)
+
+    def update(self):
+        try:
+            return self.client.update(cmd=self.cmd, resource_group_name=self.get_argument_resource_group_name(),
+                                      name=self.get_argument_name(), managed_environment_envelope=self.managed_env_def, no_wait=self.get_argument_no_wait())
+        except Exception as e:
+            handle_raw_exception(e)
+
+class ContainerappEnvTelemetryAppInsightsPreviewSetDecorator(BaseResource):
+
+    def __init__(self, cmd: AzCliCommand, client: Any, raw_parameters: Dict, models: str):
+        super().__init__(cmd, client, raw_parameters, models)
+        self.managed_env_def = {}
+        self.existing_managed_env_def = {}
+
+    def get_argument_open_telemetry_app_insights_connection_string(self):
+        return self.get_param("connection_string")
+
+    def get_argument_enable_open_telemetry_traces(self):
+        return self.get_param("enable_open_telemetry_traces")
+
+    def get_argument_enable_open_telemetry_logs(self):
+        return self.get_param("enable_open_telemetry_logs")
+
+    def construct_payload(self):
+        # Get containerapp env properties of CA we are updating
+        try:
+           self.existing_managed_env_def = self.client.show(cmd=self.cmd, resource_group_name=self.get_argument_resource_group_name(), name=self.get_argument_name())
+        except Exception as e:
+            handle_raw_exception(e)
+
+        self.set_up_open_telemetry_open_telemetry_app_insights_connection_string()
+        self.set_up_open_telemetry_traces_destinations()
+        self.set_up_open_telemetry_logs_destinations()
+
+    def set_up_open_telemetry_open_telemetry_app_insights_connection_string(self):
+        if self.get_argument_open_telemetry_app_insights_connection_string() and self.get_argument_open_telemetry_app_insights_connection_string() is not None:
+            safe_set(self.managed_env_def, "properties", "appInsightsConfiguration", "connectionString", value=self.get_argument_open_telemetry_app_insights_connection_string())
+
+    def set_up_open_telemetry_traces_destinations(self):
+        existing_traces = safe_get(self.existing_managed_env_def, "properties", "openTelemetryConfiguration", "tracesConfiguration", "destinations")
+        if existing_traces is None:
+            if self.get_argument_enable_open_telemetry_traces():
+                existing_traces = [APP_INSIGHTS_DEST]
+                safe_set(self.managed_env_def, "properties", "openTelemetryConfiguration", "tracesConfiguration", "destinations", value=existing_traces)
+        else:
+            if self.get_argument_enable_open_telemetry_traces() and APP_INSIGHTS_DEST not in existing_traces:
+                existing_traces.append(APP_INSIGHTS_DEST) 
+                safe_set(self.managed_env_def, "properties", "openTelemetryConfiguration", "tracesConfiguration", "destinations", value=existing_traces)
+            elif not self.get_argument_enable_open_telemetry_traces() and APP_INSIGHTS_DEST in existing_traces:
+                existing_traces.remove(APP_INSIGHTS_DEST)
+                safe_set(self.managed_env_def, "properties", "openTelemetryConfiguration", "tracesConfiguration", "destinations", value=existing_traces)
+
+    def set_up_open_telemetry_logs_destinations(self):
+        existing_logs = safe_get(self.existing_managed_env_def, "properties", "openTelemetryConfiguration", "logsConfiguration", "destinations")
+        if existing_logs is None:
+            if self.get_argument_enable_open_telemetry_logs():
+                existing_logs = [APP_INSIGHTS_DEST]
+                safe_set(self.managed_env_def, "properties", "openTelemetryConfiguration", "logsConfiguration", "destinations", value=existing_logs)
+        else:
+            if self.get_argument_enable_open_telemetry_logs() and APP_INSIGHTS_DEST not in existing_logs:
+                existing_logs.append(APP_INSIGHTS_DEST) 
+                safe_set(self.managed_env_def, "properties", "openTelemetryConfiguration", "logsConfiguration", "destinations", value=existing_logs)
+            elif not self.get_argument_enable_open_telemetry_logs() and APP_INSIGHTS_DEST in existing_logs:
+                existing_logs.remove(APP_INSIGHTS_DEST)
+                safe_set(self.managed_env_def, "properties", "openTelemetryConfiguration", "logsConfiguration", "destinations", value=existing_logs)
+
+    def update(self):
+        try:
+            return self.client.update(cmd=self.cmd, resource_group_name=self.get_argument_resource_group_name(),
+                                      name=self.get_argument_name(), managed_environment_envelope=self.managed_env_def, no_wait=self.get_argument_no_wait())
+        except Exception as e:
+            handle_raw_exception(e)