AWS transform documentation change
Summary
Updated discovery tool documentation to expand support from VMware-only to multiple sources (VMware, Hyper-V, bare metal), added detailed OS metrics collection modules with specific schedules, restructured content for clarity, and updated data collection tables with new fields and formats.
Security assessment
The changes are feature enhancements and documentation restructuring. There is no evidence of addressing a specific security vulnerability, weakness, or incident. The changes mention protocols (WinRM, SSH, SNMPv2, SNMPv3) and credential usage, but these are existing operational details, not new security features or vulnerability fixes. The update primarily expands platform support and clarifies data collection processes.
Diff
diff --git a/transform/latest/userguide/discovery-tool-data-collection.md b/transform/latest/userguide/discovery-tool-data-collection.md index 1bfeb69bb..ad60bb810 100644 --- a//transform/latest/userguide/discovery-tool-data-collection.md +++ b//transform/latest/userguide/discovery-tool-data-collection.md @@ -5 +5 @@ -Scheduling the discovery toolDiscovered Inventory OS-related data +Collection scheduleDiscovered inventory OS-related data @@ -9 +9 @@ Scheduling the discovery toolDiscovered Inventory OS-related data -## Scheduling the discovery tool +## Discovery tool collection schedule @@ -13 +13 @@ After your initial discovery collection, the discovery tool continues to run on - * VMware discovery - every hour + * VMware discovery – every hour @@ -15 +15 @@ After your initial discovery collection, the discovery tool continues to run on - * Database discovery - once a day + * Hyper-V discovery – every hour @@ -17 +16,0 @@ After your initial discovery collection, the discovery tool continues to run on - * Network metrics - every 15 seconds, may be less frequent for large environments @@ -20,0 +20,22 @@ After your initial discovery collection, the discovery tool continues to run on +The discovery tool also collects OS metrics through the following independent modules, each with its own schedule: + + * Database discovery – once a day + + * Network metrics – every 15 seconds, might be less frequent for large environments + + * Server performance metrics – every 10 minutes + + * Storage performance metrics – every 10 minutes + + * Server provisioning data – daily + + * Storage provisioning data – daily + + * Network interfaces – daily + + * Running processes – hourly + + + + +You can independently start, stop, or trigger each OS metrics module by using **Collect data now**. @@ -24 +45,3 @@ To manually run a collection, from the **Actions** menu choose: - * **Start** \- enable the discovery module + * **Start** – Enables the discovery module. + + * **Stop** – Disables the discovery module. @@ -26 +49 @@ To manually run a collection, from the **Actions** menu choose: - * **Stop** \- disable the discovery module + * **Collect data now** – Starts discovery immediately. Use this option, for example, after you make a change in your network. @@ -28 +50,0 @@ To manually run a collection, from the **Actions** menu choose: - * **Collect data now** \- use this to start discovery right away, for example, after making a change in your network. @@ -31,0 +54 @@ To manually run a collection, from the **Actions** menu choose: +These actions apply per module. You can control OS metrics modules individually. @@ -33 +56 @@ To manually run a collection, from the **Actions** menu choose: -**OS data collection attempts** +### OS data collection attempts @@ -35 +58 @@ To manually run a collection, from the **Actions** menu choose: -When a new server is discovered, the discovery tool attempts each configured credential for each IP address and the hostname. After the discovery tool finds a valid credential, it will continue to use that credential unless a new credential is added. +When a new server is discovered, the discovery tool attempts each configured credential for each IP address and the hostname. After the discovery tool finds a valid credential, it continues to use that credential unless you add a new credential. @@ -39 +62 @@ After a collection failure, the discovery tool attempts to collect networking da -## Discovered VMware Inventory +## Discovered inventory @@ -41 +64 @@ After a collection failure, the discovery tool attempts to collect networking da -After you set up the vCenter Access, the **Number of discovered VMs** displayed in the **Discovery tool status** frame begins to increment, and the **VMware discovery** status is shown as **Enabled** in the **Collection module** frame. +After you configure a discovery source, the **Number of discovered servers** value in the **Discovery tool status** frame begins to increment. The discovery status for the configured source changes to **Enabled** in the **Collection module** frame. The inventory page shows servers from all configured sources: VMware VMs, Hyper-V VMs, and imported bare metal servers. Each server shows its source and collection status per module. @@ -43 +66 @@ After you set up the vCenter Access, the **Number of discovered VMs** displayed -You can navigate to the **Discovered inventory** page and see the servers that are being discovered by the discovery tool. From this page, you can choose **Download inventory** to download a zip file containing MPA files listing the VMs that have been discovered with performance utilization data, database information, and server to server communication information. +Navigate to the **Discovered inventory** page to see the servers that the discovery tool has found. From this page, choose **Download inventory** to download a ZIP file (`discovery_tool_export.zip`) that contains up to 28 days of collected data, including MPA files for all configured sources, performance utilization data, database information, and server-to-server communication information. @@ -45 +68 @@ You can navigate to the **Discovered inventory** page and see the servers that a -You can download the zip file while the discovery tool continues to work, and obtain partial results. Upload this file to [Migration assessment ](https://docs.aws.amazon.com/transform/latest/userguide/transform-app-assessments.html)to obtain a business case for migration. +You can download the ZIP file while the discovery tool continues to work, and obtain partial results. Upload this file to [Migration assessment ](https://docs.aws.amazon.com/transform/latest/userguide/transform-app-assessments.html)to obtain a business case for migration. @@ -47 +70 @@ You can download the zip file while the discovery tool continues to work, and ob -### Data Points Collected +### Data points collected @@ -49 +72 @@ You can download the zip file while the discovery tool continues to work, and ob -The discovery tool gathers comprehensive data across VMware, Database, and Network components. These sections detail the specific data points collected for each component. +The discovery tool gathers comprehensive data across VMware, Hyper-V, OS metrics, database, and network components. The following sections detail the specific data points collected for each component. @@ -51 +74 @@ The discovery tool gathers comprehensive data across VMware, Database, and Netwo -#### VMware Data Collection +#### VMware data collection @@ -71,0 +95,24 @@ avg_ram_utl_pct_dec | Float | VM Performance | 29.27 +#### Hyper-V data collection + +This table describes the Hyper-V virtual machine information collected by the discovery tool: + +Name | Type | Category | Sample Value +---|---|---|--- +vm_name | String | VM Info | "win2022-hyperv-test-01" +vm_id | String | VM Info | "a1b2c3d4-e5f6-7890-abcd-ef1234567890" +powerstate | String | VM Info | "Running" +cpus | Integer | VM Info | 4 +memory_mb | Integer | VM Info | 8192 +disk_paths | String | Disk | "C:\\\VMs\\\disk1.vhdx" +disk_size_gb | Float | Disk | 127.0 +network_adapters | String | Network | "00:15:5D:01:02:03" +ip_addresses | String | Network | "10.0.1.50" +host_name | String | Host | "hyperv-host-01.example.com" +host_os_version | String | Host | "Windows Server 2022 Datacenter" +cluster_name | String | Host | "FailoverCluster01" +hypervisor | String | VM Info | "Hyper-V" + +#### Bare metal data + +Bare metal servers are not auto-discovered. They are imported through a CSV file. The discovery tool does not collect hypervisor-level data for bare metal servers. Instead, it collects database, network, and OS metrics data by using the OS credentials associated with each server during import. + @@ -73,0 +121,147 @@ avg_ram_utl_pct_dec | Float | VM Performance | 29.27 +### OS metrics data collection + +The discovery tool collects OS-level metrics from servers through SSH (Linux) and WinRM (Windows). Data is collected across six sub-modules and exported into six CSV files. + +#### Server inventory (server_inventory.csv) + +Combines server provisioning (hardware and OS configuration) with aggregated storage performance. Collected every 24 hours. + +Name | Type | Category | Sample Value +---|---|---|--- +server_id| String| Server Info| "vm-web-server-01" +server_name| String| Server Info| "web-server-01" +resource_type| String| Server Info| "virtual_machine" +power_state| String| Server Info| "Running" +os_type| String| Server Info| "Linux" +os_name| String| Server Info| "Amazon Linux" +os_version| String| Server Info| "2023" +primary_hostname| String| Server Info| "web-server-01.example.com" +primary_ip_address| String| Server Info| "10.0.2.101" +netmask| String| Server Info| "255.255.255.0" +total_num_network_cards| Integer| Server Info| 2 +total_num_disks| Integer| Server Info| 1 +cpu_count| Integer| Server Info| 4 +total_memory_gb| Float| Server Info| 15.88 +server_uuid| String| Server Info| "4201ecf8-cc44-ee7e-01da-34dfb2acf6c0" +smbios_uuid| String| Server Info| "4201ecf8-cc44-ee7e-01da-34dfb2acf6c0" +cluster_name| String| Server Info| "production-cluster-01" +hypervisor_object_id| String| Server Info| "vm-30920" +hypervisor_type| String| Server Info| "VMware" +hypervisor_version| String| Server Info| "8.0.0" +hypervisor_hostname| String| Server Info| "esxi-node1.example.com" +hypervisor_host_id| String| Server Info| "host-1234" +hypervisor_id| String| Server Info| "4201ecf8-cc44-ee7e-01da-34dfb2acf6c0" +disk_read_iops_avg| Float| Storage Performance| 12.5 +disk_read_iops_peak| Float| Storage Performance| 245.0 +disk_write_iops_avg| Float| Storage Performance| 8.3 +disk_write_iops_peak| Float| Storage Performance| 180.0 +disk_total_iops_avg| Float| Storage Performance| 20.8 +disk_total_iops_peak| Float| Storage Performance| 425.0 +disk_read_throughput_avg_mbps| Float| Storage Performance| 1.2 +disk_read_throughput_peak_mbps| Float| Storage Performance| 24.5 +disk_write_throughput_avg_mbps| Float| Storage Performance| 0.8 +disk_write_throughput_peak_mbps| Float| Storage Performance| 18.0 +disk_total_throughput_avg_mbps| Float| Storage Performance| 2.0 +disk_total_throughput_peak_mbps| Float| Storage Performance| 42.5 + +#### Server performance metrics (server_performance_metrics.csv) + +CPU, memory, and network throughput utilization. Sampled every 10 minutes, aggregated over 28 days. + +Name | Type | Category | Sample Value +---|---|---|--- +server_id| String| Server Info| "vm-web-server-01" +data_source| String| Server Info| "OS" +cpu_utilization_avg_pct| Float| CPU| 45.06 +cpu_utilization_peak_pct| Float| CPU| 79.33 +cpu_count| Integer| CPU| 4 +memory_total_gb| Float| Memory| 15.88 +memory_utilization_avg_pct| Float| Memory| 29.27 +memory_utilization_peak_pct| Float| Memory| 63.99 +network_in_avg_mbps| Float| Network| 0.52 +network_in_peak_mbps| Float| Network| 12.3 +network_out_avg_mbps| Float| Network| 0.31 +network_out_peak_mbps| Float| Network| 8.7 +network_total_avg_mbps| Float| Network| 0.83 +network_total_peak_mbps| Float| Network| 21.0 + +#### Storage performance (server_storage_performance.csv) + +Per-volume disk I/O and space utilization. Sampled every 10 minutes, aggregated over 28 days. + +Name | Type | Category | Sample Value +---|---|---|--- +server_id| String| Server Info| "vm-web-server-01" +data_source| String| Server Info| "OS" +disk_volume_id| String| Volume Info| "/dev/nvme0n1p1" +disk_mount_point| String| Volume Info| "/" +file_system| String| Volume Info| "xfs" +disk_total_gb| Float| Disk Space| 30.0 +disk_used_gb| Float| Disk Space| 12.5 +disk_free_gb| Float| Disk Space| 17.5 +disk_read_iops_avg| Float| Disk I/O| 12.5 +disk_read_iops_peak| Float| Disk I/O| 245.0 +disk_write_iops_avg| Float| Disk I/O| 8.3 +disk_write_iops_peak| Float| Disk I/O| 180.0 +disk_total_iops_avg| Float| Disk I/O| 20.8 +disk_total_iops_peak| Float| Disk I/O| 425.0 +disk_read_throughput_avg_mbps| Float| Disk Throughput| 1.2 +disk_read_throughput_peak_mbps| Float| Disk Throughput| 24.5 +disk_write_throughput_avg_mbps| Float| Disk Throughput| 0.8 +disk_write_throughput_peak_mbps| Float| Disk Throughput| 18.0 +disk_total_throughput_avg_mbps| Float| Disk Throughput| 2.0 +disk_total_throughput_peak_mbps| Float| Disk Throughput| 42.5 +