AWS transform documentation change
Summary
Added Oracle Database collection documentation, restructured data collection sections, updated scheduling details, and standardized table headers to lowercase 'Sample value'
Security assessment
The change documents collection of security-related Oracle database attributes like encrypted tablespace counts and emphasizes use of read-only accounts for database access. However, there's no evidence of addressing a specific vulnerability or security incident.
Diff
diff --git a/transform/latest/userguide/discovery-tool-data-collection.md b/transform/latest/userguide/discovery-tool-data-collection.md index ae54cb412..e146968ba 100644 --- a//transform/latest/userguide/discovery-tool-data-collection.md +++ b//transform/latest/userguide/discovery-tool-data-collection.md @@ -24,2 +23,0 @@ The discovery tool also collects OS metrics through the following independent mo - * Database discovery – once a day - @@ -31,0 +30,2 @@ The discovery tool also collects OS metrics through the following independent mo + * Running processes – hourly (at :40 UTC) + @@ -38 +38,3 @@ The discovery tool also collects OS metrics through the following independent mo - * Running processes – hourly (at :40 UTC) + * SQL Server discovery – daily (at 03:05 UTC) + + * Oracle database discovery – daily (at 05:05 UTC) @@ -93 +94,0 @@ Network data | Network connections between servers -Database data | SQL Server database inventory @@ -99,0 +101,2 @@ Process metrics | Running processes +SQL Server data | SQL Server database inventory +Oracle Database data | Oracle database inventory – CDBs, PDBs, features, options, and components @@ -111 +114 @@ This table describes the VMware virtual machine information collected by the dis -Name | Type | Category | Sample Value +Name | Type | Category | Sample value @@ -132 +135 @@ This table describes the Hyper-V virtual machine information collected by the di -Name | Type | Category | Sample Value +Name | Type | Category | Sample value @@ -154,3 +157 @@ Imported servers are not auto-discovered. They are imported through a CSV file. -### 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. +The discovery tool collects server inventory, performance, storage, network interface, and process data through SSH (Linux) and WinRM (Windows). The following tables describe the data points collected. @@ -158 +159 @@ The discovery tool collects OS-level metrics from servers through SSH (Linux) an -#### Server inventory (server_inventory.csv) +### Server inventory (server_inventory.csv) @@ -162 +163 @@ Combines server provisioning (hardware and OS configuration) with aggregated sto -Name | Type | Category | Sample Value +Name | Type | Category | Sample value @@ -200 +201 @@ disk_total_throughput_peak_mbps| Float| Storage Performance| 42.5 -#### Server performance metrics (server_performance_metrics.csv) +### Server performance metrics (server_performance_metrics.csv) @@ -204 +205 @@ CPU, memory, and network throughput utilization. Sampled every 10 minutes, aggre -Name | Type | Category | Sample Value +Name | Type | Category | Sample value @@ -221 +222 @@ network_total_peak_mbps| Float| Network| 21.0 -#### Storage performance (server_storage_performance.csv) +### Storage performance (server_storage_performance.csv) @@ -225 +226 @@ Per-volume disk I/O and space utilization. Sampled every 10 minutes, aggregated -Name | Type | Category | Sample Value +Name | Type | Category | Sample value @@ -248 +249 @@ disk_total_throughput_peak_mbps| Float| Disk Throughput| 42.5 -#### Storage configuration (storage_config.csv) +### Storage configuration (storage_config.csv) @@ -252 +253 @@ Physical disk hardware details. Collected every 24 hours. -Name | Type | Category | Sample Value +Name | Type | Category | Sample value @@ -263 +264 @@ disk_protocol| String| Disk Info| "LSI Logic SAS" -#### Network interfaces (network_interfaces.csv) +### Network interfaces (network_interfaces.csv) @@ -267 +268 @@ Network adapter configuration. Collected every 24 hours. -Name | Type | Category | Sample Value +Name | Type | Category | Sample value @@ -289 +290 @@ is_primary| Boolean| Interface Info| true -#### Running processes (process_metrics.csv) +### Running processes (process_metrics.csv) @@ -293 +294 @@ Snapshot of running processes. Collected every hour, deduplicated over 30 days. -Name | Type | Category | Sample Value +Name | Type | Category | Sample value @@ -315,14 +316,14 @@ These data points are collected for each connection: - * Source IP, port, process ID, and process name - - * Target IP, port, process ID, and process name - - * State (ESTABLISHED and TIME_WAIT) - - * Transport protocol (TCP) - - * IP version (IPv4) - - * Count (number of times this unique connection was observed) - - - +Name | Type | Category | Sample value +---|---|---|--- +Source IP | String | Connection | "192.168.1.10" +Source port | Integer | Connection | 49152 +Source process ID | Integer | Process | 1234 +Source process name | String | Process | "java" +Target IP | String | Connection | "192.168.1.20" +Target port | Integer | Connection | 5432 +Target process ID | Integer | Process | 5678 +Target process name | String | Process | "postgres" +State | String | Connection | "ESTABLISHED" +Transport protocol | String | Connection | "TCP" +IP version | String | Connection | "IPv4" +Count | Integer | Connection | 42 @@ -359 +360 @@ This setting persists across restarts. You can start or stop private address col -### Database collection +### SQL Server collection @@ -361 +362 @@ This setting persists across restarts. You can start or stop private address col -The Database collection module gathers database (SQL Server) information from Windows servers across all configured sources, including VMware, Hyper-V, and imported servers. The module uses the WinRM protocol to remotely connect to each Windows server and run PowerShell queries to get information about all installed SQL Server services (components) on the server by using WMI namespaces, registry, and file properties. +The SQL Server collection module gathers SQL Server information from Windows servers across all configured sources, including VMware, Hyper-V, and imported servers. The module uses WinRM to remotely connect to each Windows server and run PowerShell queries. It collects information about all installed SQL Server services (components) by using WMI namespaces, registry, and file properties. @@ -365 +366 @@ A SQL Server component is a specific service or feature instance installed as pa -#### Database data collection +#### SQL Server data collection @@ -367 +368 @@ A SQL Server component is a specific service or feature instance installed as pa -The Database collection module gathers SQL Server component information. This table describes key database data points collected: +The SQL Server collection module gathers SQL Server component information. This table describes key data points collected: @@ -369 +370 @@ The Database collection module gathers SQL Server component information. This ta -Name | Type | Category | Sample Value +Name | Type | Category | Sample value @@ -387,0 +389,132 @@ Full format includes all service types. MPA format includes only database engine +### Oracle Database collection + +With Oracle Database collection, you can discover Oracle database instances across all configured sources, including VMware, Hyper-V, and imported servers. The module collects the following data: + + * Container database (CDB) and pluggable database (PDB) enumeration + + * Version and edition + + * Installed options + + * Feature usage statistics + + * Component inventory (DBA_REGISTRY) + + * Datafile sizing + + * Topology flags (RAC, Data Guard, and multitenant architecture) + + + + +**Database-connected (SQL)** + +When you configure Oracle credentials, the discovery tool connects directly to the Oracle database using the read-only service account. This provides full SQL-level collection including PDB details, feature usage, and installed options. All CSV files contain complete data. + +**OS-level fallback** + +If you have not configured database credentials, or if the connection fails, the discovery tool uses SSH or WinRM to detect Oracle installations. It discovers Oracle homes, listeners, patches, version, and edition without database access. For OS-detected hosts, the exported CDB CSV contains instance name, host name, version, and edition. The PDB, features, options, and components CSV files contain no rows. + +The Oracle collection produces the following CSV files in the export ZIP. Each table describes the data points collected per file. + +#### CDB data (oracle_data_cdbs_full.csv) + +One row per CDB instance. This table describes the CDB data points collected: + +Name | Type | Category | Sample value | Source +---|---|---|---|--- +Instance Name | String | Identity | "ORCL" | SQL, OS +Host Name | String | Identity | "oracledb01.example.com" | SQL, OS +DB Name | String | Identity | "ORCL" | SQL only +DB Unique Name | String | Identity | "ORCL_PRIMARY" | SQL only +DBID | Integer | Identity | 1234567890 | SQL only +Version | String | Version | "19.0.0.0" | SQL, OS +Version Full | String | Version | "19.21.0.0.0" | SQL only +Edition | String | Version | "Enterprise Edition" | SQL, OS +Database Type | String | Configuration | "SINGLE" | SQL only +Database Role | String | Configuration | "PRIMARY" | SQL only +Open Mode | String | Configuration | "READ WRITE" | SQL only +Log Mode | String | Configuration | "ARCHIVELOG" | SQL only +Platform | String | Configuration | "Linux x86 64-bit" | SQL only +CDB Flag | String | Configuration | "YES" | SQL only +Is RAC | String | Topology | "YES" or "NO" | SQL only +Is Data Guard Standby | String | Topology | "YES" or "NO" | SQL only +Protection Mode | String | Topology | "MAXIMUM PERFORMANCE" | SQL only +Data Guard Broker | String | Topology | "ENABLED" | SQL only +NLS Characterset | String | Configuration | "AL32UTF8" | SQL only +PDB Count | Integer | Sizing | 3 | SQL only +Flashback On | String | Configuration | "YES" | SQL only +Detection Path | String | Metadata | "phase2" or "phase1b" | SQL, OS + +#### PDB data (oracle_data_pdbs_full.csv) + +One row per PDB (pluggable database). This table describes the PDB data points collected: + +###### Note + +PDB data requires Oracle database credentials (SQL connection). OS-level fallback does not populate this CSV. + +Name | Type | Category | Sample value | Source +---|---|---|---|--- +CDB Instance Name | String | Identity | "ORCL" | SQL only +PDB Name | String | Identity | "APPPDB1" | SQL only +Open Mode | String | Status | "READ WRITE" | SQL only +Lifecycle Status | String | Status | "NORMAL" | SQL only +Tablespace Count | Integer | Sizing | 5 | SQL only +Datafile Count | Integer | Sizing | 12 | SQL only +Total Size Bytes | Integer | Sizing | 5368709120 | SQL only +User Schema Count | Integer | Sizing | 8 | SQL only +DB Link Count | Integer | Connectivity | 2 | SQL only +Components Installed | String | Configuration | "APEX;JVM;XML" | SQL only +Encrypted Tablespace Count | Integer | Security | 1 | SQL only + +#### Feature usage data (oracle_data_features_full.csv) + +One row per feature usage entry from DBA_FEATURE_USAGE_STATISTICS. This table describes the feature usage data points collected: + +###### Note +