Update configuration in SaaS Upgrade Assistant

ID: .name

Category: Metadata

This is the simplest type of property. Every configuration has a name. It's used in SaaS Upgrade Assistant for display and can't be removed. For some configurations, names are extracted from JSON during the processing stage of the package upload, and they may represent different JSON nodes. If no suitable node is found, the default name will be assigned, for example: unnamed disk options.

Changes to such unnamed values won't be deployed to your target environment, but they can make configurations easier to find while working with SaaS Upgrade Assistant.

ID: starts with either .extractedIDs or .customIDs, for example .extractedIDs.id_APPLICATION_2BAAB3940FB8931A.

Category: varies

This is the property type that can be edited with the Bulk edit functionality or in the Edit properties tab. Apart from editing the value, edit mode also allows for the creation or removal of such properties. Properties you create can later be edited with the Bulk edit. Another new possibility is adding more occurrences to the JSON.

Example ID: .syntheticlocation__SYNTHETIC_LOCATION22AAF80F0E2CAF4B__id

Category: Reference

Sometimes configurations reference each other, which affects their deployment order and requirements. Dependent configurations must always be deployed together with their dependencies. This is not always a desired behavior, especially when dealing with cyclic dependencies. You can handle such cases in edit mode by removing or modifying the reference properties. You can even add new dependencies if desired.

Note: Any changes in reference properties require the dependency graph to be rebuilt. This is done automatically, but you might observe a longer saving time when working with such properties.

ID: .scope

Categories: String, Config reference, or Property reference.

This property is available only for some types of configuration, but it's mandatory when present and can't be removed. It's the only type of property that can change its category. There are three possibilities:

Some configurations don't allow trailing spaces in the configuration name, for example, application-web configurations. You may see the following error message after deployment:

Given property 'applicationName' with value: 'Title ' violates the following constraint: Must not have leading or trailing spaces.

This issue can be solved by editing the name property in edit mode. In this case, Title (notice the space) needs to be changed to Title (no space).

Log matching rules must be converted from LQL to DQL before the deployment. SaaS Upgrade Assistant doesn't handle the conversion itself. For details, see Conversion to DQL for Logs.

However, you can use edit mode to manually correct simple queries.

Let's see this configuration of type builtinlogmonitoring.schemaless-log-metric as an example:

{
  enabled: true
  key: "log.test1"
  query: "host.name="HOST1""
  measure: "OCCURRENCE"
  dimensions: []
}

Trying to deploy this configuration will result in the deploy error with the following message:

Caught exception when parsing DQL query 'host.name="HOST1"'.

With edit mode, you can fix this configuration by replacing the query with matchesValue(host.name, "HOST1"), which is valid DQL.

This issue can apply to many different cases, but let's take a look at the one related to calculated-metrics-service. The following error message could be encountered after deployment:

At least one condition of the following types must be used: [SERVICE_DISPLAY_NAME, SERVICE_PUBLIC_DOMAIN_NAME, SERVICE_WEB_APPLICATION_ID, SERVICE_WEB_CONTEXT_ROOT, SERVICE_WEB_SERVER_NAME, SERVICE_WEB_SERVICE_NAME, SERVICE_WEB_SERVICE_NAMESPACE, REMOTE_SERVICE_NAME, REMOTE_ENDPOINT, AZURE_FUNCTIONS_SITE_NAME, AZURE_FUNCTIONS_FUNCTION_NAME, CTG_GATEWAY_URL, CTG_SERVER_NAME, ACTOR_SYSTEM, ESB_APPLICATION_NAME, SERVICE_TAG, SERVICE_TYPE, PROCESS_GROUP_TAG, PROCESS_GROUP_NAME]

This can be resolved by adding an appropriate JSON node in edit mode. Here, that would be a condition inside the conditions array, for example:

conditions: [
	0: {
		attribute: "SERVICE_WEB_SERVICE_NAME"
		comparisonInfo: {
			caseSensitive: false
			comparison: "EXISTS"
			negate: false
			type: "STRING"
			value: null
			values: null
		}
	}
]

Not all entities need to be migrated when upgrading from Managed to SaaS. Sometimes, you may need to simply get rid of an entity ID—such as getting rid of test steps from Synthetic monitors. This can now be achieved by removing JSON nodes in edit mode.

Raw JSON is the content of a JSON payload file stored by SaaS Upgrade Assistant without any processing. It's what you see in the JSON editor when using edit mode. That means the IDs of extracted properties are exposed to you and you must manage their usage.

When exporting configurations, Monaco will create a separate directory for each configuration type. Inside the directory, we can find many raw JSONs and a single config.yaml file. This YAML file contains the metadata for all JSONs in the directory.

The config.yaml file contains multiple entries, each for one configuration. Only the item related to the edited configuration is modified. Additionally, not all YAML properties are editable with edit mode. Let's take a look at the following fragment of the config.yaml file as an example:

configs:
- id: 955423ac-a4e5-3dc6-952a-adc35b736f01
  config:
    name: [Built-in] cloud:aws:cloudtrail
    parameters:
      extractedIDs:
        type: value
        value:
          id_69de2278_ef7a_4b9a_bdc5_a78c9210ea4e: 69de2278-ef7a-4b9a-bdc5-a78c9210ea4e
          id_249491df_4970_421d_8575_5bf555357c14: 249491df-4970-421d-8575-5bf555357c14
      networkzone__useast1__id:
        configId: us-east-1
        configType: network-zone
        property: id
        type: reference
    template: 955423ac-a4e5-3dc6-952a-adc35b736f01.json
    skip: false
    originObjectId: vu9U3hXa3q0AAAABACNidWlsdGluOmxvZ21vbml0b3JpbmcubG9nLWRwcC1ydWxlcwAGdGVuYW50AAZ0ZW5hbnQAJGM1ODQxMTJmLTk1MWUtNDRkNC1hNjg3LTg4MmMyYmEyZDhlMr7vVN4V2t6t
  type:
    settings:
      schema: builtin:logmonitoring.log-dpp-rules
      schemaVersion: 1.0.20
      scope: environment

With edit mode, you can edit:

Edit mode doesn't support editing the following YAML properties: