[CLI][Spring-Cloud] Move to GA for Java In-process Agent (#3623)

* In param help, change instrumentation key to connection string

* update dependency of azure cli to have connection_string in data model

* update param description for app_insights_key

* update history and setup version for IPA GA CLI

* rename term distributed tracing to Application Insights in help

* remove Java In-process Agent or (IPA) in help

* deco `disable_distributed_tracing` parameter in
az spring-cloud create/update

* mark `enable_java_agent` as deprecated. And ignore this parameter. By default enable java agent in az spring-cloud create command group

* By default enable java agent in az spring-cloud update command group

* separate ai parameters from asc create and asc update

* merge same parameter for asc create and asc update

* remove help for asc update against ai settings

* add warn log for `enable-java-agent`

* support connection string in help info

* refine too long string help info

* remove preview tag for asc app-insights command group

* rename trace_properties to monitoring_setting_properties

* support both connection string and instrumentation key

* support sampling rate

* refine validator error message

* add validator back for enable_java_agent and refine the wording.

* refine history for the changes.

* fix bug for app-insights update

* fix bug for app-insights update

* update version

* Fix bug for asc update disable ai

* add support no-wait for ipa ga

* add scenario test for asc create and update

* add scenario test for asc app insights update

* add negative cases for asc create

* add negative cases for asc update

* add negative cases for asc app-insights update

* enhance scenario for asc app-insights update

* enhance scenario for asc create

* add scenario for asc create with ai disabled

* fix for style check

* remove comment

* remove dependency on other modules

* replace CLIError with concrete error class

* add track work item for refactoring the validators

* add comment to explain record_only

* update history

src/spring-cloud/HISTORY.md

@@ -1,5 +1,18 @@
 Release History
 ===============
+2.10.0
+-----
+* Support functions for Java In-Process Agent feature General Available.
+* For Application Insights configuration, support both `connection_string` and `instrumentation_key`,
+  and we recommended to use `connection_string`.
+* Enabling In-Process Agent is equivalent to enabling application insights.
+* Mark `enable-java-agent` as deprecated, since IPA is GA-ed.
+* Mark application insights related parameter as deprecated in `az spring-cloud update`,
+  it's still supported, but will de decommissioned in the future, 
+  and we recommended to use `az spring-cloud app-insights update`.
+* Support `--sampling-rate` in `az spring-cloud create`.
+* Decommissioned `disable-distributed-tracing` parameter.
+
 2.9.0
 -----
 * Add --source-path argument into 'az spring-cloud app deploy' and 'az spring-cloud app deployment create'

src/spring-cloud/azext_spring_cloud/_help.py

@@ -17,11 +17,13 @@
     examples:
     - name: Create a new Azure Spring Cloud in westus.
       text: az spring-cloud create -n MyService -g MyResourceGroup -l westus
-    - name: Create a new Azure Spring Cloud in westus with an existing Application Insights by using the instrumentation key.
-      text: az spring-cloud create -n MyService -g MyResourceGroup -l westus --app-insights-key MyInstrumentationKey
-    - name: Create a new Azure Spring Cloud in westus with an existing Application Insights and enable Java In-Process Agent.
-      text: az spring-cloud create -n MyService -g MyResourceGroup -l westus --enable-java-agent true --app-insights MyInstrumentationName
-    - name: Create a new Azure Spring Cloud with distributed tracing disabled.
+    - name: Create a new Azure Spring Cloud in westus with an existing Application Insights by using the Connection string (recommended) or Instrumentation key.
+      text: az spring-cloud create -n MyService -g MyResourceGroup -l westus --app-insights-key \"MyConnectionString\"
+    - name: Create a new Azure Spring Cloud in westus with an existing Application Insights.
+      text: az spring-cloud create -n MyService -g MyResourceGroup -l westus --app-insights appInsightsName
+    - name: Create a new Azure Spring Cloud in westus with an existing Application Insights and specify the sampling rate.
+      text: az spring-cloud create -n MyService -g MyResourceGroup -l westus --app-insights appInsightsName --sampling-rate 10
+    - name: Create a new Azure Spring Cloud with Application Insights disabled.
       text: az spring-cloud create -n MyService -g MyResourceGroup --disable-app-insights
     - name: Create a new Azure Spring Cloud with VNet-injected via giving VNet name in current resource group
       text: az spring-cloud create -n MyService -g MyResourceGroup --vnet MyVNet --app-subnet MyAppSubnet --service-runtime-subnet MyServiceRuntimeSubnet
@@ -35,8 +37,6 @@
     examples:
     - name: Update pricing tier.
       text: az spring-cloud update -n MyService --sku Standard -g MyResourceGroup
-    - name: Enable the distributed tracing of the existing Azure Spring Cloud.
-      text: az spring-cloud update -n MyService -g MyResourceGroup --disable-app-insights false
     - name: Update the tags of the existing Azure Spring Cloud.
       text: az spring-cloud update -n MyService -g MyResourceGroup --tags key1=value1 key2=value2
 """
@@ -461,8 +461,8 @@
     type: command
     short-summary: Update Application Insights settings.
     examples:
-        - name: Enable Application Insights and Java In-process Agent.
-          text: az spring-cloud app-insights update -n MyService -g MyResourceGroup --app-insights-key MyInstrumentationKey --sampling-rate 100
+        - name: Enable Application Insights by using the Connection string (recommended) or Instrumentation key.
+          text: az spring-cloud app-insights update -n MyService -g MyResourceGroup --app-insights-key \"MyConnectionString\" --sampling-rate 100
         - name: Disable Application Insights.
           text: az spring-cloud app-insights update -n MyService -g MyResourceGroup --disable
 """

src/spring-cloud/azext_spring_cloud/_params.py

@@ -11,8 +11,9 @@
                           validate_name, validate_app_name, validate_deployment_name, validate_log_lines,
                           validate_log_limit, validate_log_since, validate_sku, validate_jvm_options,
                           validate_vnet, validate_vnet_required_parameters, validate_node_resource_group,
-                          validate_tracing_parameters, validate_app_insights_parameters, validate_java_agent_parameters,
-                          validate_instance_count, validate_jar)
+                          validate_tracing_parameters_asc_create, validate_tracing_parameters_asc_update,
+                          validate_app_insights_parameters, validate_instance_count, validate_java_agent_parameters,
+                          validate_jar)
 from ._utils import ApiType
 
 from .vendored_sdks.appplatform.v2020_07_01.models import RuntimeVersion, TestKeyType
@@ -33,36 +34,69 @@ def load_arguments(self, _):
         c.argument('name', options_list=[
             '--name', '-n'], help='Name of Azure Spring Cloud.')
 
+    # A refactoring work item to move validators to command level to reduce the duplications.
+    # https://dev.azure.com/msazure/AzureDMSS/_workitems/edit/11002857/
     with self.argument_context('spring-cloud create') as c:
         c.argument('location', arg_type=get_location_type(self.cli_ctx), validator=validate_location)
-        c.argument('sku', type=str, validator=validate_sku, help='Name of SKU, the value is "Basic" or "Standard"')
         c.argument('reserved_cidr_range', help='Comma-separated list of IP address ranges in CIDR format. The IP ranges are reserved to host underlying Azure Spring Cloud infrastructure, which should be 3 at least /16 unused IP ranges, must not overlap with any Subnet IP ranges.', validator=validate_vnet_required_parameters)
         c.argument('vnet', help='The name or ID of an existing Virtual Network into which to deploy the Spring Cloud instance.', validator=validate_vnet_required_parameters)
         c.argument('app_subnet', help='The name or ID of an existing subnet in "vnet" into which to deploy the Spring Cloud app. Required when deploying into a Virtual Network. Smaller subnet sizes are supported, please refer: https://aka.ms/azure-spring-cloud-smaller-subnet-vnet-docs', validator=validate_vnet_required_parameters)
         c.argument('service_runtime_subnet', options_list=['--service-runtime-subnet', '--svc-subnet'], help='The name or ID of an existing subnet in "vnet" into which to deploy the Spring Cloud service runtime. Required when deploying into a Virtual Network.', validator=validate_vnet)
         c.argument('service_runtime_network_resource_group', options_list=['--service-runtime-network-resource-group', '--svc-nrg'], help='The resource group where all network resources for Azure Spring Cloud service runtime will be created in.', validator=validate_node_resource_group)
         c.argument('app_network_resource_group', options_list=['--app-network-resource-group', '--app-nrg'], help='The resource group where all network resources for apps will be created in.', validator=validate_node_resource_group)
-        c.argument('enable_java_agent', is_preview=True, arg_type=get_three_state_flag(), help="Enable java in-process agent", validator=validate_java_agent_parameters)
+        c.argument('enable_java_agent',
+                   arg_type=get_three_state_flag(),
+                   help="Java in process agent is now GA-ed and used by default when Application Insights enabled. "
+                        "This parameter is no longer needed and will be removed in future release.",
+                   validator=validate_java_agent_parameters,
+                   deprecate_info=c.deprecate(target='--enable-java-agent', hide=True))
+        c.argument('app_insights_key',
+                   help="Connection string (recommended) or Instrumentation key of the existing Application Insights.",
+                   validator=validate_tracing_parameters_asc_create)
+        c.argument('app_insights',
+                   help="Name of the existing Application Insights in the same Resource Group. "
+                        "Or Resource ID of the existing Application Insights in a different Resource Group.",
+                   validator=validate_tracing_parameters_asc_create)
+        c.argument('sampling_rate',
+                   type=float,
+                   help="Sampling Rate of application insights. Minimum is 0, maximum is 100.",
+                   validator=validate_tracing_parameters_asc_create)
+        c.argument('disable_app_insights',
+                   arg_type=get_three_state_flag(),
+                   help="Disable Application Insights, "
+                        "if not disabled and no existing Application Insights specified with "
+                        "--app-insights-key or --app-insights, "
+                        "will create a new Application Insights instance in the same resource group.",
+                   validator=validate_tracing_parameters_asc_create)
+
     with self.argument_context('spring-cloud update') as c:
-        c.argument('sku', type=str, validator=validate_sku, help='Name of SKU, the value is "Basic" or "Standard"')
+        c.argument('app_insights_key',
+                   help="Connection string (recommended) or Instrumentation key of the existing Application Insights.",
+                   validator=validate_tracing_parameters_asc_update,
+                   deprecate_info=c.deprecate(target='az spring-cloud update --app-insights-key',
+                                              redirect='az spring-cloud app-insights update --app-insights-key',
+                                              hide=True))
+        c.argument('app_insights',
+                   help="Name of the existing Application Insights in the same Resource Group. "
+                        "Or Resource ID of the existing Application Insights in a different Resource Group.",
+                   validator=validate_tracing_parameters_asc_update,
+                   deprecate_info=c.deprecate(target='az spring-cloud update --app-insights',
+                                              redirect='az spring-cloud app-insights update --app-insights',
+                                              hide=True))
+        c.argument('disable_app_insights',
+                   arg_type=get_three_state_flag(),
+                   help="Disable Application Insights, "
+                        "if not disabled and no existing Application Insights specified with "
+                        "--app-insights-key or --app-insights, "
+                        "will create a new Application Insights instance in the same resource group.",
+                   validator=validate_tracing_parameters_asc_update,
+                   deprecate_info=c.deprecate(target='az spring-cloud update --disable-app-insights',
+                                              redirect='az spring-cloud app-insights update --disable',
+                                              hide=True))
 
     for scope in ['spring-cloud create', 'spring-cloud update']:
         with self.argument_context(scope) as c:
-            c.argument('app_insights_key',
-                       help="Instrumentation key of the existing Application Insights.",
-                       validator=validate_tracing_parameters)
-            c.argument('app_insights',
-                       help="Name of the existing Application Insights in the same Resource Group. Or Resource ID of the existing Application Insights in a different Resource Group.",
-                       validator=validate_tracing_parameters)
-            c.argument('disable_distributed_tracing',
-                       arg_type=get_three_state_flag(),
-                       help="Disable distributed tracing, if not disabled and no existing Application Insights specified with --app-insights-key or --app-insights, will create a new Application Insights instance in the same resource group.",
-                       validator=validate_tracing_parameters,
-                       deprecate_info=c.deprecate(target='--disable-distributed-tracing', redirect='--disable-app-insights', hide=True))
-            c.argument('disable_app_insights',
-                       arg_type=get_three_state_flag(),
-                       help="Disable Application Insights, if not disabled and no existing Application Insights specified with --app-insights-key or --app-insights, will create a new Application Insights instance in the same resource group.",
-                       validator=validate_tracing_parameters)
+            c.argument('sku', type=str, validator=validate_sku, help='Name of SKU, the value is "Basic" or "Standard"')
             c.argument('tags', arg_type=tags_type)
 
     with self.argument_context('spring-cloud test-endpoint renew-key') as c:
@@ -268,10 +302,11 @@ def prepare_logs_argument(c):
 
     with self.argument_context('spring-cloud app-insights update') as c:
         c.argument('app_insights_key',
-                   help="Instrumentation key of the existing Application Insights",
+                   help="Connection string (recommended) or Instrumentation key of the existing Application Insights.",
                    validator=validate_app_insights_parameters)
         c.argument('app_insights',
-                   help="Name of the existing Application Insights in the same Resource Group. Or Resource ID of the existing Application Insights in a different Resource Group.",
+                   help="Name of the existing Application Insights in the same Resource Group. "
+                        "Or Resource ID of the existing Application Insights in a different Resource Group.",
                    validator=validate_app_insights_parameters)
         c.argument('sampling_rate',
                    type=float,

src/spring-cloud/azext_spring_cloud/_validators.py

@@ -155,34 +155,60 @@ def validate_jvm_options(namespace):
         namespace.jvm_options = namespace.jvm_options.strip('\'')
 
 
-def validate_tracing_parameters(namespace):
-    if namespace.disable_app_insights and namespace.disable_distributed_tracing:
-        raise InvalidArgumentValueError("Conflict detected: '--disable-app-insights' can not be set with '--disable-distributed-tracing'.")
+def validate_tracing_parameters_asc_create(namespace):
+    if (namespace.app_insights or namespace.app_insights_key or namespace.sampling_rate is not None) \
+            and namespace.disable_app_insights:
+        raise InvalidArgumentValueError(
+            "Conflict detected: '--app-insights' or '--app-insights-key' or '--sampling-rate' "
+            "can not be set with '--disable-app-insights'.")
+    _validate_app_insights_parameters(namespace)
+
+
+def validate_tracing_parameters_asc_update(namespace):
     if (namespace.app_insights or namespace.app_insights_key) and namespace.disable_app_insights:
-        raise InvalidArgumentValueError("Conflict detected: '--app-insights' or '--app-insights-key'"
-                                        "can not be set with '--disable-app-insights'.")
-    if (namespace.app_insights or namespace.app_insights_key) and namespace.disable_distributed_tracing:
-        raise InvalidArgumentValueError("Conflict detected: '--app-insights' or '--app-insights-key'"
-                                        "can not be set with '--disable-distributed-tracing'.")
+        raise InvalidArgumentValueError(
+            "Conflict detected: '--app-insights' or '--app-insights-key' "
+            "can not be set with '--disable-app-insights'.")
     if namespace.app_insights and namespace.app_insights_key:
-        raise InvalidArgumentValueError("Conflict detected: '--app-insights' and '--app-insights-key' can not be set at the same time.")
+        raise InvalidArgumentValueError(
+            "Conflict detected: '--app-insights' and '--app-insights-key' can not be set at the same time.")
     if namespace.app_insights == "":
         raise InvalidArgumentValueError("Conflict detected: '--app-insights' can not be empty.")
 
 
 def validate_java_agent_parameters(namespace):
+    """TODO (jiec) Deco this function when 'enable-java-agent' is decommissioned.
+    """
     if namespace.disable_app_insights and namespace.enable_java_agent:
-        raise InvalidArgumentValueError("Conflict detected: '--enable-java-in-process-agent' and '--disable-app-insights' can not be set at the same time.")
+        raise InvalidArgumentValueError(
+            "Conflict detected: '--enable-java-agent' and '--disable-app-insights' "
+            "can not be set at the same time.")
 
 
 def validate_app_insights_parameters(namespace):
-    if (namespace.app_insights or namespace.app_insights_key or namespace.sampling_rate) and namespace.disable:
-        raise InvalidArgumentValueError("Conflict detected: '--app-insights' or '--app-insights-key' or '--sampling-rate'"
-                                        "can not be set with '--disable'.")
+    if (namespace.app_insights or namespace.app_insights_key or namespace.sampling_rate is not None) \
+            and namespace.disable:
+        raise InvalidArgumentValueError(
+            "Conflict detected: '--app-insights' or '--app-insights-key' or '--sampling-rate' "
+            "can not be set with '--disable'.")
+    if not namespace.app_insights \
+            and not namespace.app_insights_key \
+            and namespace.sampling_rate is None \
+            and not namespace.disable:
+        raise InvalidArgumentValueError("Invalid value: nothing is updated for application insights.")
+    _validate_app_insights_parameters(namespace)
+
+
+def _validate_app_insights_parameters(namespace):
     if namespace.app_insights and namespace.app_insights_key:
-        raise InvalidArgumentValueError("Conflict detected: '--app-insights' and '--app-insights-key' can not be set at the same time.")
-    if namespace.sampling_rate and (namespace.sampling_rate < 0 or namespace.sampling_rate > 100):
-        raise InvalidArgumentValueError("Sampling Rate must be in the range [0,100].")
+        raise InvalidArgumentValueError(
+            "Conflict detected: '--app-insights' and '--app-insights-key' can not be set at the same time.")
+    if namespace.app_insights == "":
+        raise InvalidArgumentValueError("Invalid value: '--app-insights' can not be empty.")
+    if namespace.app_insights_key == "":
+        raise InvalidArgumentValueError("Invalid value: '--app-insights-key' can not be empty.")
+    if namespace.sampling_rate is not None and (namespace.sampling_rate < 0 or namespace.sampling_rate > 100):
+        raise InvalidArgumentValueError("Invalid value: Sampling Rate must be in the range [0,100].")
 
 
 def validate_vnet(cmd, namespace):

src/spring-cloud/azext_spring_cloud/azext_metadata.json

@@ -1,4 +1,4 @@
 {
     "azext.isPreview": false,
-    "azext.minCliCoreVersion": "2.0.67"
+    "azext.minCliCoreVersion": "2.25.0"
 }

src/spring-cloud/azext_spring_cloud/commands.py

@@ -117,10 +117,10 @@ def load_command_table(self, _):
         g.custom_command('update', 'domain_update')
         g.custom_command('unbind', 'domain_unbind')
 
-    with self.command_group('spring-cloud app-insights', is_preview=True,
+    with self.command_group('spring-cloud app-insights',
                             client_factory=cf_spring_cloud_20201101preview,
                             exception_handler=handle_asc_exception) as g:
-        g.custom_command('update', 'app_insights_update')
+        g.custom_command('update', 'app_insights_update', supports_no_wait=True)
         g.custom_show_command('show', 'app_insights_show')
 
     with self.command_group('spring-cloud', exception_handler=handle_asc_exception):