本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # 使用 的 Amazon RDS 績效詳情範例 AWS CLI 下列程式碼範例示範如何使用 AWS Command Line Interface 搭配 Amazon RDS Performance Insights 執行動作和實作常見案例。 *Actions* 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。 每個範例均包含完整原始碼的連結，您可在連結中找到如何設定和執行內容中程式碼的相關指示。 **Topics** + [動作](#actions) ## 動作 ### `create-performance-analysis-report` 以下程式碼範例顯示如何使用 `create-performance-analysis-report`。 **AWS CLI** **建立績效分析報告** 下列 `create-performance-analysis-report` 範例會以資料庫 `db-abcdefg123456789` 的開始時間 `1682969503` 和結束時間 `1682979503` 建立績效分析報告。 ``` aws pi create-performance-analysis-report \ --service-type RDS \ --identifier db-abcdefg123456789 \ --start-time 1682969503 \ --end-time 1682979503 ``` 輸出： ``` { "AnalysisReportId": "report-0234d3ed98e28fb17" } ``` 如需建立績效分析報告的詳細資訊，請參閱《Amazon RDS 使用者指南》**中的[在績效詳情中建立績效分析報告](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.CreatingPerfAnlysisReport.html)，以及《Amazon Aurora 使用者指南》**中的[在績效詳情中建立績效分析報告](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.CreatingPerfAnlysisReport.html)。 + 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreatePerformanceAnalysisReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/create-performance-analysis-report.html)。 ### `delete-performance-analysis-report` 以下程式碼範例顯示如何使用 `delete-performance-analysis-report`。 **AWS CLI** **刪除績效分析報告** 下列 `delete-performance-analysis-report` 範例會刪除報告 ID 為 `report-0d99cc91c4422ee61` 的績效分析報告。 ``` aws pi delete-performance-analysis-report \ --service-type RDS \ --identifier db-abcdefg123456789 \ --analysis-report-id report-0d99cc91c4422ee61 ``` 此命令不會產生輸出。 如需刪除績效分析報告的詳細資訊，請參閱《Amazon RDS 使用者指南》**中的[刪除績效詳情中的績效分析報告](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.DeletePerfAnalysisReport.html)，以及《Amazon Aurora 使用者指南》**中的[刪除績效詳情中的績效分析報告](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.DeletePerfAnalysisReport.html)。 + 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeletePerformanceAnalysisReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/delete-performance-analysis-report.html)。 ### `describe-dimension-keys` 以下程式碼範例顯示如何使用 `describe-dimension-keys`。 **AWS CLI** **範例 1：描述維度索引鍵** 此範例會請求所有等待事件的名稱。資料會依事件名稱和這些事件在指定期間內的彙總值進行摘要。 命令： ``` aws pi describe-dimension-keys --service-type RDS --identifier db-LKCGOBK26374TPTDFXOIWVCPPM --start-time 1527026400 --end-time 1527080400 --metric db.load.avg --group-by '{"Group":"db.wait_event"}' ``` 輸出： ``` { "AlignedEndTime": 1.5270804E9, "AlignedStartTime": 1.5270264E9, "Keys": [ { "Dimensions": {"db.wait_event.name": "wait/synch/mutex/innodb/aurora_lock_thread_slot_futex"}, "Total": 0.05906906851195666 }, { "Dimensions": {"db.wait_event.name": "wait/io/aurora_redo_log_flush"}, "Total": 0.015824722186149193 }, { "Dimensions": {"db.wait_event.name": "CPU"}, "Total": 0.008014396230265477 }, { "Dimensions": {"db.wait_event.name": "wait/io/aurora_respond_to_client"}, "Total": 0.0036361612526204477 }, { "Dimensions": {"db.wait_event.name": "wait/io/table/sql/handler"}, "Total": 0.0019108398419382965 }, { "Dimensions": {"db.wait_event.name": "wait/synch/cond/mysys/my_thread_var::suspend"}, "Total": 8.533847837782684E-4 }, { "Dimensions": {"db.wait_event.name": "wait/io/file/csv/data"}, "Total": 6.864181956477376E-4 }, { "Dimensions": {"db.wait_event.name": "Unknown"}, "Total": 3.895887056379051E-4 }, { "Dimensions": {"db.wait_event.name": "wait/synch/mutex/sql/FILE_AS_TABLE::LOCK_shim_lists"}, "Total": 3.710368625122906E-5 }, { "Dimensions": {"db.wait_event.name": "wait/lock/table/sql/handler"}, "Total": 0 } ] } ``` **範例 2：尋找對資料庫負載影響最大之陳述式的 SQL ID** 下列 `describe-dimension-keys` 會請求 10 個陳述式的 SQL 陳述式和 SQL ID，這些陳述式對資料庫負載的影響最大。 ``` aws pi describe-dimension-keys \ --service-type RDS \ --identifier db-abcdefg123456789 \ --start-time 2023-05-01T00:00:00Z \ --end-time 2023-05-01T01:00:00Z \ --metric db.load.avg \ --group-by '{"Group": "db.sql", "Dimensions": ["db.sql.id", "db.sql.statement"],"Limit": 10}' ``` 輸出： ``` { "AlignedEndTime": 1.5270804E9, "AlignedStartTime": 1.5270264E9, "Identifier": "db-abcdefg123456789", "MetricList": [ { "Keys": [ { "Dimensions": {"db.sql.id": "AKIAIOSFODNN7EXAMPLE", "db.sql.statement": "SELECT * FROM customers WHERE customer_id = 123"}, "Total": 25.5,"Partitions": [12.3, 13.2] } ] } ] } ``` 如需績效詳情中維度的詳細資訊，請參閱《Amazon RDS 使用者指南》**中的[資料庫負載](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.ActiveSessions.html)和《Amazon Aurora 使用者指南》**中的[資料庫負載](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.Overview.ActiveSessions.html)。 + 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeDimensionKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/describe-dimension-keys.html)。 ### `get-dimension-key-details` 以下程式碼範例顯示如何使用 `get-dimension-key-details`。 **AWS CLI** **取得資料庫執行個體指定維度群組的詳細資訊** 下列 `get-dimension-key-details` 範例會擷取資料庫執行個體 `db-10BCD2EFGHIJ3KL4M5NO6PQRS5` 之 SQL 陳述式的完整文字。`--group` 即為 `db.sql`，而 `--group-identifier` 即為 `db.sql.id`。在此範例中，`example-sql-id` 代表使用 `get-resource-metrics` 或 `describe-dimension-keys` 操作擷取的 SQL ID。在此範例中，維度詳細資訊可供使用。因此，績效詳情會擷取 SQL 陳述式的完整文字，而不會將其截斷。 ``` aws pi get-dimension-key-details \ --service-type RDS \ --identifier db-10BCD2EFGHIJ3KL4M5NO6PQRS5 \ --group db.sql \ --group-identifier example-sql-id \ --requested-dimensions statement ``` 輸出： ``` { "Dimensions":[ { "Value": "SELECT e.last_name, d.department_name FROM employees e, departments d WHERE e.department_id=d.department_id", "Dimension": "db.sql.statement", "Status": "AVAILABLE" }, ... ] } ``` 如需績效詳情中維度的詳細資訊，請參閱《Amazon RDS 使用者指南》**中的[資料庫負載](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.ActiveSessions.html)和《Amazon Aurora 使用者指南》**中的[資料庫負載](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.Overview.ActiveSessions.html)。 + 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetDimensionKeyDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/get-dimension-key-details.html)。 ### `get-performance-analysis-report` 以下程式碼範例顯示如何使用 `get-performance-analysis-report`。 **AWS CLI** **取得績效分析報告** 下列 `get-performance-analysis-report` 範例會取得報告 ID 為 `report-0d99cc91c4422ee61` 之資料庫 `db-abcdefg123456789` 的績效分析報告。回應提供報告狀態、ID、時間詳細資訊和洞見。 ``` aws pi get-performance-analysis-report \ --service-type RDS \ --identifier db-abcdefg123456789 \ --analysis-report-id report-0d99cc91c4422ee61 ``` 輸出： ``` { "AnalysisReport": { "Status": "Succeeded", "ServiceType": "RDS", "Identifier": "db-abcdefg123456789", "StartTime": 1680583486.584, "AnalysisReportId": "report-0d99cc91c4422ee61", "EndTime": 1680587086.584, "CreateTime": 1680587087.139, "Insights": [ ... (Condensed for space) ] } } ``` 如需績效分析報告的詳細資訊，請參閱《Amazon RDS 使用者指南》**中的[分析一段時間區間的資料庫效能](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.AnalyzePerformanceTimePeriod.html)，以及《Amazon Aurora 使用者指南》**中的[分析一段時間區間的資料庫效能](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.AnalyzePerformanceTimePeriod.html)。 + 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetPerformanceAnalysisReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/get-performance-analysis-report.html)。 ### `get-resource-metadata` 以下程式碼範例顯示如何使用 `get-resource-metadata`。 **AWS CLI** **取得資料庫的資源中繼資料** 下列 `get-resource-metadata` 範例會取得資料庫 `db-abcdefg123456789` 的資源中繼資料。回應顯示已啟用 SQL 摘要統計資料。 ``` aws pi get-resource-metadata \ --service-type RDS \ --identifier db-abcdefg123456789 ``` 輸出： ``` { "Identifier": "db-abcdefg123456789", "Features":{ "SQL_DIGEST_STATISTICS":{ "Status": "ENABLED" } } } ``` 如需績效詳情 SQL 統計資料的詳細資訊，請參閱《Amazon RDS 使用者指南》**中的[績效詳情的 SQL 統計數字](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/sql-statistics.html)和《Amazon Aurora 使用者指南》**中的[績效詳情的 SQL 統計數字](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/sql-statistics.html)。 + 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetResourceMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/get-resource-metadata.html)。 ### `get-resource-metrics` 以下程式碼範例顯示如何使用 `get-resource-metrics`。 **AWS CLI** **取得資源指標** 此範例會請求 *db.wait\$1event* 維度群組的資料點，以及該群組內 *db.wait\$1event.name* 維度的資料點。在回應中，相關資料點會依請求的維度 (*db.wait\$1event.name*) 分組。 命令： ``` aws pi get-resource-metrics --service-type RDS --identifier db-LKCGOBK26374TPTDFXOIWVCPPM --start-time 1527026400 --end-time 1527080400 --period-in-seconds 300 --metric db.load.avg --metric-queries file://metric-queries.json ``` `--metric-queries` 的引數會儲存在 `metric-queries.json` 的 JSON 檔案中。以下是該檔案的內容： ``` [ { "Metric": "db.load.avg", "GroupBy": { "Group":"db.wait_event" } } ] ``` 輸出： ``` { "AlignedEndTime": 1.5270804E9, "AlignedStartTime": 1.5270264E9, "Identifier": "db-LKCGOBK26374TPTDFXOIWVCPPM", "MetricList": [ { "Key": { "Metric": "db.load.avg" }, "DataPoints": [ { "Timestamp": 1527026700.0, "Value": 1.3533333333333333 }, { "Timestamp": 1527027000.0, "Value": 0.88 }, <...remaining output omitted...> ] }, { "Key": { "Metric": "db.load.avg", "Dimensions": { "db.wait_event.name": "wait/synch/mutex/innodb/aurora_lock_thread_slot_futex" } }, "DataPoints": [ { "Timestamp": 1527026700.0, "Value": 0.8566666666666667 }, { "Timestamp": 1527027000.0, "Value": 0.8633333333333333 }, <...remaining output omitted...> ], }, <...remaining output omitted...> ] } ``` + 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetResourceMetrics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/get-resource-metrics.html)。 ### `list-available-resource-dimensions` 以下程式碼範例顯示如何使用 `list-available-resource-dimensions`。 **AWS CLI** **列出可在資料庫執行個體上查詢指標類型的維度** 下列 `list-available-resource-dimensions` 範例會列出您可以查詢資料庫 `db-abcdefg123456789` 的 `db.load` 指標。 ``` aws pi list-available-resource-dimensions \ --service-type RDS \ --identifier db-abcdefg123456789 \ --metrics db.load ``` 輸出： ``` { "MetricDimensions": [ { "Metric": "db.load", "Groups": [ { "Group": "db.user", "Dimensions": [ { "Identifier": "db.user.id" }, { "Identifier": "db.user.name" } ] }, { "Group": "db.sql_tokenized", "Dimensions": [ { "Identifier": "db.sql_tokenized.id" }, { "Identifier": "db.sql_tokenized.db_id" }, { "Identifier": "db.sql_tokenized.statement" } ] }, ... ] } ] } ``` 如需績效詳情中維度的詳細資訊，請參閱《Amazon RDS 使用者指南》**中的[資料庫負載](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.ActiveSessions.html)和《Amazon Aurora 使用者指南》**中的[資料庫負載](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.Overview.ActiveSessions.html)。 + 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListAvailableResourceDimensions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/list-available-resource-dimensions.html)。 ### `list-available-resource-metrics` 以下程式碼範例顯示如何使用 `list-available-resource-metrics`。 **AWS CLI** **列出可在資料庫執行個體上查詢指標類型的指標** 下列 `list-available-resource-metrics` 範例會列出您可以查詢資料庫 `db-abcdefg123456789` 的 `db.load` 指標。 ``` aws pi list-available-resource-metrics \ --service-type RDS \ --identifier db-abcdefg123456789 \ --metric-types "os" "db" ``` 輸出： ``` { "Metrics": [ { "Description": "The number of virtual CPUs for the DB instance", "Metric": "os.general.numVCPUs", "Unit": "vCPUs" }, ......, { "Description": "Time spent reading data file blocks by backends in this instance", "Metric": "db.IO.read_latency", "Unit": "Milliseconds per block" }, ...... ] } ``` 如需績效詳情中指標的詳細資訊，請參閱《Amazon RDS 使用者指南》**中的[資料庫負載](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.ActiveSessions.html)和《Amazon Aurora 使用者指南》**中的[資料庫負載](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.Overview.ActiveSessions.html)。 + 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListAvailableResourceMetrics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/list-available-resource-metrics.html)。 ### `list-performance-analysis-reports` 以下程式碼範例顯示如何使用 `list-performance-analysis-reports`。 **AWS CLI** **列出資料庫的績效分析報告** 下列 `list-performance-analysis-reports` 範例會列出資料庫 `db-abcdefg123456789` 所有可用的績效分析報告。回應將列出所有報告，其中包含報告 ID，狀態和時間區間的詳細資訊。 ``` aws pi list-performance-analysis-reports \ --service-type RDS \ --identifier db-abcdefg123456789 ``` 輸出： ``` { "AnalysisReports": [ { "Status": "Succeeded", "EndTime": 1680587086.584, "CreateTime": 1680587087.139, "StartTime": 1680583486.584, "AnalysisReportId": "report-0d99cc91c4422ee61" }, { "Status": "Succeeded", "EndTime": 1681491137.914, "CreateTime": 1681491145.973, "StartTime": 1681487537.914, "AnalysisReportId": "report-002633115cc002233" }, { "Status": "Succeeded", "EndTime": 1681493499.849, "CreateTime": 1681493507.762, "StartTime": 1681489899.849, "AnalysisReportId": "report-043b1e006b47246f9" }, { "Status": "InProgress", "EndTime": 1682979503.0, "CreateTime": 1682979618.994, "StartTime": 1682969503.0, "AnalysisReportId": "report-01ad15f9b88bcbd56" } ] } ``` 如需績效分析報告的詳細資訊，請參閱《Amazon RDS 使用者指南》**中的[分析一段時間區間的資料庫效能](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.AnalyzePerformanceTimePeriod.html)，以及《Amazon Aurora 使用者指南》**中的[分析一段時間區間的資料庫效能](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.AnalyzePerformanceTimePeriod.html)。 + 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListPerformanceAnalysisReports](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/list-performance-analysis-reports.html)。 ### `list-tags-for-resource` 以下程式碼範例顯示如何使用 `list-tags-for-resource`。 **AWS CLI** **列出績效分析報告的標籤** 下列 `list-tags-for-resource` 範例會列出具有報告 ID 為 `report-0d99cc91c4422ee61` 之績效分析報告的標籤。 ``` aws pi list-tags-for-resource \ --service-type RDS \ --resource-arn arn:aws:pi:us-west-2:123456789012:perf-reports/RDS/db-abcdefg123456789/report-0d99cc91c4422ee61 ``` 輸出： ``` { "Tags": [ { "Value": "test-tag", "Key": "name" } ] } ``` 如需標記績效分析報告的詳細資訊，請參閱《Amazon RDS 使用者指南》**中的[將標籤新增至績效詳情中的績效分析報告](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html)，以及《Amazon Aurora 使用者指南》**中的[將標籤新增至績效詳情中的績效分析報告](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html)。 + 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/list-tags-for-resource.html)。 ### `tag-resource` 以下程式碼範例顯示如何使用 `tag-resource`。 **AWS CLI** **將標籤新增至績效分析報告** 下列 `tag-resource` 範例會將標籤值為 `test-tag` 的標籤索引鍵 `name` 新增至報告 ID 為 `report-0d99cc91c4422ee61` 的績效分析報告。 ``` aws pi tag-resource \ --service-type RDS \ --resource-arn arn:aws:pi:us-west-2:123456789012:perf-reports/RDS/db-abcdefg123456789/report-0d99cc91c4422ee61 \ --tags Key=name,Value=test-tag ``` 此命令不會產生輸出。 如需標記績效分析報告的詳細資訊，請參閱《Amazon RDS 使用者指南》**中的[將標籤新增至績效詳情中的績效分析報告](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html)，以及《Amazon Aurora 使用者指南》**中的[將標籤新增至績效詳情中的績效分析報告](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html)。 + 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/tag-resource.html)。 ### `untag-resource` 以下程式碼範例顯示如何使用 `untag-resource`。 **AWS CLI** **刪除績效分析報告的標籤** 下列 `untag-resource` 範例會刪除報告 ID 為 `report-0d99cc91c4422ee61` 之績效分析報告的標籤 `name`。 ``` aws pi untag-resource \ --service-type RDS \ --resource-arn arn:aws:pi:us-west-2:123456789012:perf-reports/RDS/db-abcdefg123456789/report-0d99cc91c4422ee61 \ --tag-keys name ``` 此命令不會產生輸出。 如需標記績效分析報告的詳細資訊，請參閱《Amazon RDS 使用者指南》**中的[將標籤新增至績效詳情中的績效分析報告](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html)，以及《Amazon Aurora 使用者指南》**中的[將標籤新增至績效詳情中的績效分析報告](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html)。 + 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/untag-resource.html)。