Skip to content

Commit 94f7ccb

Browse files
author
awstools
committed
feat(client-pi): Adds documentation for dimension groups and dimensions to analyze locks for Database Insights.
1 parent 5b42130 commit 94f7ccb

File tree

5 files changed

+86
-15
lines changed

5 files changed

+86
-15
lines changed

‎clients/client-pi/src/commands/GetDimensionKeyDetailsCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface GetDimensionKeyDetailsCommandOutput extends GetDimensionKeyDeta
3131
* <p>Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID,
3232
* <code>GetDimensionKeyDetails</code> retrieves the full text of the dimension <code>db.sql.statement</code> associated with this ID.
3333
* This operation is useful because <code>GetResourceMetrics</code> and <code>DescribeDimensionKeys</code> don't support retrieval of large
34-
* SQL statement text.</p>
34+
* SQL statement text, lock snapshots, and execution plans.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript

‎clients/client-pi/src/commands/GetPerformanceAnalysisReportCommand.ts

+9-3
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,9 @@ export interface GetPerformanceAnalysisReportCommandOutput
9797
* // Dimensions: { // DescriptiveMap
9898
* // "<keys>": "STRING_VALUE",
9999
* // },
100+
* // Filter: {
101+
* // "<keys>": "STRING_VALUE",
102+
* // },
100103
* // Value: Number("double"),
101104
* // },
102105
* // },
@@ -109,6 +112,9 @@ export interface GetPerformanceAnalysisReportCommandOutput
109112
* // Dimensions: {
110113
* // "<keys>": "STRING_VALUE",
111114
* // },
115+
* // Filter: {
116+
* // "<keys>": "STRING_VALUE",
117+
* // },
112118
* // Value: Number("double"),
113119
* // },
114120
* // },
@@ -130,6 +136,7 @@ export interface GetPerformanceAnalysisReportCommandOutput
130136
* // Dimensions: {
131137
* // "<keys>": "STRING_VALUE",
132138
* // },
139+
* // Filter: "<DescriptiveMap>",
133140
* // Value: Number("double"),
134141
* // },
135142
* // },
@@ -139,9 +146,8 @@ export interface GetPerformanceAnalysisReportCommandOutput
139146
* // PerformanceInsightsMetric: {
140147
* // Metric: "STRING_VALUE",
141148
* // DisplayName: "STRING_VALUE",
142-
* // Dimensions: {
143-
* // "<keys>": "STRING_VALUE",
144-
* // },
149+
* // Dimensions: "<DescriptiveMap>",
150+
* // Filter: "<DescriptiveMap>",
145151
* // Value: Number("double"),
146152
* // },
147153
* // },

‎clients/client-pi/src/models/models_0.ts

+61-3
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,12 @@ export interface PerformanceInsightsMetric {
3939
*/
4040
Dimensions?: Record<string, string> | undefined;
4141

42+
/**
43+
* <p>The filter for the Performance Insights metric.</p>
44+
* @public
45+
*/
46+
Filter?: Record<string, string> | undefined;
47+
4248
/**
4349
* <p>The value of the metric. For example, <code>9</code> for <code>db.load.avg</code>.</p>
4450
* @public
@@ -463,10 +469,26 @@ export interface DimensionGroup {
463469
* </li>
464470
* <li>
465471
* <p>
472+
* <code>db.blocking_sql</code> - The SQL queries blocking the most DB load.</p>
473+
* </li>
474+
* <li>
475+
* <p>
476+
* <code>db.blocking_session</code> - The sessions blocking the most DB load.</p>
477+
* </li>
478+
* <li>
479+
* <p>
480+
* <code>db.blocking_object</code> - The object resources acquired by other sessions that are blocking the most DB load.</p>
481+
* </li>
482+
* <li>
483+
* <p>
466484
* <code>db.host</code> - The host name of the connected client (all engines).</p>
467485
* </li>
468486
* <li>
469487
* <p>
488+
* <code>db.plans</code> - The execution plans for the query (only Aurora PostgreSQL).</p>
489+
* </li>
490+
* <li>
491+
* <p>
470492
* <code>db.query</code> - The query that is currently running (only Amazon DocumentDB).</p>
471493
* </li>
472494
* <li>
@@ -529,6 +551,30 @@ export interface DimensionGroup {
529551
* </li>
530552
* <li>
531553
* <p>
554+
* <code>db.blocking_sql.id</code> - The ID for each of the SQL queries blocking the most DB load.</p>
555+
* </li>
556+
* <li>
557+
* <p>
558+
* <code>db.blocking_sql.sql</code> - The SQL text for each of the SQL queries blocking the most DB load.</p>
559+
* </li>
560+
* <li>
561+
* <p>
562+
* <code>db.blocking_session.id</code> - The ID for each of the sessions blocking the most DB load.</p>
563+
* </li>
564+
* <li>
565+
* <p>
566+
* <code>db.blocking_object.id</code> - The ID for each of the object resources acquired by other sessions that are blocking the most DB load.</p>
567+
* </li>
568+
* <li>
569+
* <p>
570+
* <code>db.blocking_object.type</code> - The object type for each of the object resources acquired by other sessions that are blocking the most DB load.</p>
571+
* </li>
572+
* <li>
573+
* <p>
574+
* <code>db.blocking_object.value</code> - The value for each of the object resources acquired by other sessions that are blocking the most DB load.</p>
575+
* </li>
576+
* <li>
577+
* <p>
532578
* <code>db.host.id</code> - The host ID of the connected client (all engines).</p>
533579
* </li>
534580
* <li>
@@ -785,7 +831,8 @@ export interface DescribeDimensionKeysRequest {
785831
/**
786832
* <p>Additional metrics for the top <code>N</code> dimension keys. If the specified dimension group in the <code>GroupBy</code> parameter is
787833
* <code>db.sql_tokenized</code>, you can specify per-SQL metrics to get the values for the top <code>N</code> SQL digests. The response
788-
* syntax is as follows: <code>"AdditionalMetrics" : \{ "<i>string</i>" : "<i>string</i>" \}</code>. </p>
834+
* syntax is as follows: <code>"AdditionalMetrics" : \{ "<i>string</i>" : "<i>string</i>" \}</code>.</p>
835+
* <p>The only supported statistic function is <code>.avg</code>.</p>
789836
* @public
790837
*/
791838
AdditionalMetrics?: string[] | undefined;
@@ -1102,6 +1149,10 @@ export interface GetDimensionKeyDetailsRequest {
11021149
* <ul>
11031150
* <li>
11041151
* <p>
1152+
* <code>db.lock_snapshot</code> (Aurora only)</p>
1153+
* </li>
1154+
* <li>
1155+
* <p>
11051156
* <code>db.query</code> (Amazon DocumentDB only)</p>
11061157
* </li>
11071158
* <li>
@@ -1125,6 +1176,10 @@ export interface GetDimensionKeyDetailsRequest {
11251176
* <p>
11261177
* <code>db.query.id</code> for dimension group <code>db.query</code> (DocumentDB only)</p>
11271178
* </li>
1179+
* <li>
1180+
* <p>For the dimension group <code>db.lock_snapshot</code>, the <code>GroupIdentifier</code> is the epoch timestamp when Performance Insights captured the snapshot, in seconds.
1181+
* You can retrieve this value with the <code>GetResourceMetrics</code> operation for a 1 second period.</p>
1182+
* </li>
11281183
* </ul>
11291184
* @public
11301185
*/
@@ -1136,6 +1191,10 @@ export interface GetDimensionKeyDetailsRequest {
11361191
* <ul>
11371192
* <li>
11381193
* <p>
1194+
* <code>db.lock_trees</code> - Specify the dimension name <code>db.lock_trees</code>. (Aurora only)</p>
1195+
* </li>
1196+
* <li>
1197+
* <p>
11391198
* <code>db.sql</code> - Specify either the full dimension name <code>db.sql.statement</code> or the short dimension name
11401199
* <code>statement</code> (Aurora and RDS only).</p>
11411200
* </li>
@@ -1437,8 +1496,7 @@ export interface GetResourceMetricsRequest {
14371496
PeriodInSeconds?: number | undefined;
14381497

14391498
/**
1440-
* <p>The maximum number of items to return in the response. If more items exist than the specified <code>MaxRecords</code> value, a
1441-
* pagination token is included in the response so that the remaining results can be retrieved. </p>
1499+
* <p>The maximum number of items to return in the response.</p>
14421500
* @public
14431501
*/
14441502
MaxResults?: number | undefined;

‎clients/client-pi/src/protocols/Aws_json1_1.ts

+1
Original file line numberDiff line numberDiff line change
@@ -993,6 +993,7 @@ const de_PerformanceInsightsMetric = (output: any, context: __SerdeContext): Per
993993
return take(output, {
994994
Dimensions: _json,
995995
DisplayName: __expectString,
996+
Filter: _json,
996997
Metric: __expectString,
997998
Value: __limitedParseDouble,
998999
}) as any;

0 commit comments

Comments
 (0)