...
The new configuration format introduces several key changes:
Multiple Inputsinputs: The configuration now supports multiple inputs to better represent the different data sources and access mechanisms (
azure
andazure_event_hub
)Rename Credential Config Parametersconfig parameters renamed: The credentials configuration field names now follow names that are consistent with Microsoft Azure documentation:
tenant_id
,client_id
,client_secret
.Azure Blob Storage Checkpoint Supportcheckpoint support: The configuration now accepts Azure Blob Storage related parameters in the queue-specific configuration:
blob_storage_connection_string
,blob_storage_container_name
,blob_storage_account_name
.Moved VM Metrics to Dedicated Servicededicated service: The VM metrics input has been moved to a dedicated service. The customer service configuration is no longer valid.
Moved Event Hub to Dedicated Servicededicated service: The Event Hub input has been moved to a dedicated service. The customer service configuration is no longer valid.
...
Before starting the migration process, we recommend the following steps:
Backup Your Current Configurationyour current configuration: Always ensure you have a backup of your existing configuration files to prevent any data loss.
Review the New Configuration Documentationnew configuration documentation: Familiarize yourself with the new configuration options available in version 1.8.0.
...
The credential configuration field names have been updated:
active_directory_id
-> →tenant_id
secret
-> →client_secret
app_id
-> →client_id
An example of the old and new configuration is shown below:
Code Block |
---|
# Old Versionversion (1.7.1) credentials: app_id: <app_id_value> active_directory_id: <active_directory_id_value> subscription_id: <subscription_id_value> secret: <secret_value> |
↓
Code Block |
---|
# New Versionversion (1.8.0) credentials: client_id: <client_id_value> tenant_id: <tenant_id_value> subscription_id: <subscription_id_value> client_secret: <client_secret_value> |
...
Putting it all together, see below for an example of the old and new configuration:
Code Block |
---|
# Old Versionversion (1.7.1) inputs: azure: id: 10001 enabled: true credentials: app_id: app_id_acme active_directory_id: active_directory_id_acme subscription_id: subscription_id_acme secret: secret_acme environment: test_environment requests_limits: - period: 1d number_of_requests: -1 services: my_service_1: request_period_in_seconds: 300 types: - eh_services queues: queue_a: event_hub_name: the-event-hub-name consumer_group: the-consumer-group connection_str: the-connection-string events_use_autocategory: true compatibility_version: 1.2.1 duplicated_messages_mechanism: global use_global_counter_per_queue: true my_service_2: request_period_in_seconds: 300 types: - vm_metrics |
↓
Code Block |
---|
# New Versionversion (1.8.0) inputs: azure: id: 100001 enabled: true credentials: subscription_id: subscription_id_acme client_id: app_id_acme client_secret: secret_acme tenant_id: active_directory_id_acme environment: test-env services: vm_metrics: request_period_in_seconds: 300 azure_event_hubs: id: 100001 enabled: true credentials: subscription_id: subscription_id_acme client_id: app_id_acme client_secret: secret_acme tenant_id: active_directory_id_acme environment: test-env services: event_hubs: queues: queue_a: event_hub_name: the-event-hub-name event_hub_connection_string: the-connection-string consumer_group: the-consumer-group events_use_autocategory: true compatibility_version: 1.2.0 duplicated_messages_mechanism: global override_starting_position: "2022-01-01T00:00:00Z" # Replace with the datetime of the last event in Devo. Otherwise, collector pulls from latest event for the first checkpoint. |
...
For more detailed troubleshooting, refer to the official documentation or contact support.
Conclusion
Following these steps should help you smoothly transition to the new version of Software Script. If you encounter any issues, don't hesitate to reach out for support.