Skip to content

Commit ef30775

Browse files
author
awstools
committed
feat(client-application-signals): CloudWatch Application Signals now supports application logs correlation with traces and operational health metrics of applications running on EC2 instances. Users can view the most relevant telemetry to troubleshoot application health anomalies such as spikes in latency, errors, and availability.
1 parent 4a753d9 commit ef30775

File tree

8 files changed

+143
-42
lines changed

8 files changed

+143
-42
lines changed

clients/client-application-signals/README.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@
66

77
AWS SDK for JavaScript ApplicationSignals Client for Node.js, Browser and React Native.
88

9-
<important>
10-
<p>This is a Preview release of the Application Signals API Reference. Operations and parameters are subject to change before the general availability
11-
release.</p>
12-
</important>
139
<p>Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications.
1410
It enables real-time service health dashboards and helps you track long-term performance trends against your business goals.
1511
The application-centric view provides you with unified visibility across your applications, services, and
@@ -27,6 +23,8 @@ ensuring optimal customer experience.</p>
2723
<p>See a map of your application topology that Application Signals automatically discovers, that gives you a visual representation of your applications, dependencies, and their connectivity.</p>
2824
</li>
2925
</ul>
26+
<p>Application Signals works with CloudWatch RUM, CloudWatch Synthetics canaries, and Amazon Web Services Service Catalog AppRegistry, to display your client pages, Synthetics canaries,
27+
and application names within dashboards and maps.</p>
3028

3129
## Installing
3230

clients/client-application-signals/src/ApplicationSignals.ts

+3-5
Original file line numberDiff line numberDiff line change
@@ -322,11 +322,7 @@ export interface ApplicationSignals {
322322
}
323323

324324
/**
325-
* <important>
326-
* <p>This is a Preview release of the Application Signals API Reference. Operations and parameters are subject to change before the general availability
327-
* release.</p>
328-
* </important>
329-
* <p>Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications.
325+
* <p>Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications.
330326
* It enables real-time service health dashboards and helps you track long-term performance trends against your business goals.
331327
* The application-centric view provides you with unified visibility across your applications, services, and
332328
* dependencies, so you can proactively monitor and efficiently triage any issues that may arise,
@@ -343,6 +339,8 @@ export interface ApplicationSignals {
343339
* <p>See a map of your application topology that Application Signals automatically discovers, that gives you a visual representation of your applications, dependencies, and their connectivity.</p>
344340
* </li>
345341
* </ul>
342+
* <p>Application Signals works with CloudWatch RUM, CloudWatch Synthetics canaries, and Amazon Web Services Service Catalog AppRegistry, to display your client pages, Synthetics canaries,
343+
* and application names within dashboards and maps.</p>
346344
* @public
347345
*/
348346
export class ApplicationSignals extends ApplicationSignalsClient implements ApplicationSignals {}

clients/client-application-signals/src/ApplicationSignalsClient.ts

+3-5
Original file line numberDiff line numberDiff line change
@@ -321,11 +321,7 @@ export type ApplicationSignalsClientResolvedConfigType = __SmithyResolvedConfigu
321321
export interface ApplicationSignalsClientResolvedConfig extends ApplicationSignalsClientResolvedConfigType {}
322322

323323
/**
324-
* <important>
325-
* <p>This is a Preview release of the Application Signals API Reference. Operations and parameters are subject to change before the general availability
326-
* release.</p>
327-
* </important>
328-
* <p>Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications.
324+
* <p>Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications.
329325
* It enables real-time service health dashboards and helps you track long-term performance trends against your business goals.
330326
* The application-centric view provides you with unified visibility across your applications, services, and
331327
* dependencies, so you can proactively monitor and efficiently triage any issues that may arise,
@@ -342,6 +338,8 @@ export interface ApplicationSignalsClientResolvedConfig extends ApplicationSigna
342338
* <p>See a map of your application topology that Application Signals automatically discovers, that gives you a visual representation of your applications, dependencies, and their connectivity.</p>
343339
* </li>
344340
* </ul>
341+
* <p>Application Signals works with CloudWatch RUM, CloudWatch Synthetics canaries, and Amazon Web Services Service Catalog AppRegistry, to display your client pages, Synthetics canaries,
342+
* and application names within dashboards and maps.</p>
345343
* @public
346344
*/
347345
export class ApplicationSignalsClient extends __Client<

clients/client-application-signals/src/commands/GetServiceCommand.ts

+10
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,19 @@ export interface GetServiceCommandOutput extends GetServiceOutput, __MetadataBea
7171
* // MetricName: "STRING_VALUE", // required
7272
* // },
7373
* // ],
74+
* // LogGroupReferences: [ // LogGroupReferences
75+
* // {
76+
* // "<keys>": "STRING_VALUE",
77+
* // },
78+
* // ],
7479
* // },
7580
* // StartTime: new Date("TIMESTAMP"), // required
7681
* // EndTime: new Date("TIMESTAMP"), // required
82+
* // LogGroupReferences: [
83+
* // {
84+
* // "<keys>": "STRING_VALUE",
85+
* // },
86+
* // ],
7787
* // };
7888
*
7989
* ```

clients/client-application-signals/src/index.ts

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
// smithy-typescript generated code
22
/* eslint-disable */
33
/**
4-
* <important>
5-
* <p>This is a Preview release of the Application Signals API Reference. Operations and parameters are subject to change before the general availability
6-
* release.</p>
7-
* </important>
8-
* <p>Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications.
4+
* <p>Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications.
95
* It enables real-time service health dashboards and helps you track long-term performance trends against your business goals.
106
* The application-centric view provides you with unified visibility across your applications, services, and
117
* dependencies, so you can proactively monitor and efficiently triage any issues that may arise,
@@ -22,6 +18,8 @@
2218
* <p>See a map of your application topology that Application Signals automatically discovers, that gives you a visual representation of your applications, dependencies, and their connectivity.</p>
2319
* </li>
2420
* </ul>
21+
* <p>Application Signals works with CloudWatch RUM, CloudWatch Synthetics canaries, and Amazon Web Services Service Catalog AppRegistry, to display your client pages, Synthetics canaries,
22+
* and application names within dashboards and maps.</p>
2523
*
2624
* @packageDocumentation
2725
*/

clients/client-application-signals/src/models/models_0.ts

+79-1
Original file line numberDiff line numberDiff line change
@@ -736,6 +736,7 @@ export interface GetServiceInput {
736736
* <p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
737737
* be epoch time in seconds. For example: <code>1698778057</code>
738738
* </p>
739+
* <p>Your requested start time will be rounded to the nearest hour.</p>
739740
* @public
740741
*/
741742
StartTime: Date | undefined;
@@ -744,6 +745,7 @@ export interface GetServiceInput {
744745
* <p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
745746
* be epoch time in seconds. For example: <code>1698778057</code>
746747
* </p>
748+
* <p>Your requested start time will be rounded to the nearest hour.</p>
747749
* @public
748750
*/
749751
EndTime: Date | undefined;
@@ -937,6 +939,30 @@ export interface Service {
937939
* @public
938940
*/
939941
MetricReferences: MetricReference[] | undefined;
942+
943+
/**
944+
* <p>An array of string-to-string maps that each contain information about one log group associated with this service. Each
945+
* string-to-string map includes the following fields:</p>
946+
* <ul>
947+
* <li>
948+
* <p>
949+
* <code>"Type": "AWS::Resource"</code>
950+
* </p>
951+
* </li>
952+
* <li>
953+
* <p>
954+
* <code>"ResourceType": "AWS::Logs::LogGroup"</code>
955+
* </p>
956+
* </li>
957+
* <li>
958+
* <p>
959+
* <code>"Identifier": "<i>name-of-log-group</i>"</code>
960+
* </p>
961+
* </li>
962+
* </ul>
963+
* @public
964+
*/
965+
LogGroupReferences?: Record<string, string>[];
940966
}
941967

942968
/**
@@ -952,16 +978,44 @@ export interface GetServiceOutput {
952978
/**
953979
* <p>The start time of the data included in the response. In a raw HTTP Query API, it is formatted as
954980
* be epoch time in seconds. For example: <code>1698778057</code>.</p>
981+
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
982+
* it was rounded to the nearest hour.</p>
955983
* @public
956984
*/
957985
StartTime: Date | undefined;
958986

959987
/**
960988
* <p>The end time of the data included in the response. In a raw HTTP Query API, it is formatted as
961989
* be epoch time in seconds. For example: <code>1698778057</code>.</p>
990+
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
991+
* it was rounded to the nearest hour.</p>
962992
* @public
963993
*/
964994
EndTime: Date | undefined;
995+
996+
/**
997+
* <p>An array of string-to-string maps that each contain information about one log group associated with this service. Each
998+
* string-to-string map includes the following fields:</p>
999+
* <ul>
1000+
* <li>
1001+
* <p>
1002+
* <code>"Type": "AWS::Resource"</code>
1003+
* </p>
1004+
* </li>
1005+
* <li>
1006+
* <p>
1007+
* <code>"ResourceType": "AWS::Logs::LogGroup"</code>
1008+
* </p>
1009+
* </li>
1010+
* <li>
1011+
* <p>
1012+
* <code>"Identifier": "<i>name-of-log-group</i>"</code>
1013+
* </p>
1014+
* </li>
1015+
* </ul>
1016+
* @public
1017+
*/
1018+
LogGroupReferences?: Record<string, string>[];
9651019
}
9661020

9671021
/**
@@ -972,6 +1026,7 @@ export interface ListServiceDependenciesInput {
9721026
* <p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
9731027
* be epoch time in seconds. For example: <code>1698778057</code>
9741028
* </p>
1029+
* <p>Your requested start time will be rounded to the nearest hour.</p>
9751030
* @public
9761031
*/
9771032
StartTime: Date | undefined;
@@ -980,6 +1035,7 @@ export interface ListServiceDependenciesInput {
9801035
* <p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
9811036
* be epoch time in seconds. For example: <code>1698778057</code>
9821037
* </p>
1038+
* <p>Your requested end time will be rounded to the nearest hour.</p>
9831039
* @public
9841040
*/
9851041
EndTime: Date | undefined;
@@ -1101,6 +1157,8 @@ export interface ListServiceDependenciesOutput {
11011157
* <p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as
11021158
* be epoch time in seconds. For example: <code>1698778057</code>
11031159
* </p>
1160+
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
1161+
* it was rounded to the nearest hour.</p>
11041162
* @public
11051163
*/
11061164
StartTime: Date | undefined;
@@ -1109,6 +1167,8 @@ export interface ListServiceDependenciesOutput {
11091167
* <p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as
11101168
* be epoch time in seconds. For example: <code>1698778057</code>
11111169
* </p>
1170+
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
1171+
* it was rounded to the nearest hour.</p>
11121172
* @public
11131173
*/
11141174
EndTime: Date | undefined;
@@ -1135,6 +1195,7 @@ export interface ListServiceDependentsInput {
11351195
* <p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
11361196
* be epoch time in seconds. For example: <code>1698778057</code>
11371197
* </p>
1198+
* <p>Your requested start time will be rounded to the nearest hour.</p>
11381199
* @public
11391200
*/
11401201
StartTime: Date | undefined;
@@ -1143,6 +1204,7 @@ export interface ListServiceDependentsInput {
11431204
* <p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
11441205
* be epoch time in seconds. For example: <code>1698778057</code>
11451206
* </p>
1207+
* <p>Your requested start time will be rounded to the nearest hour.</p>
11461208
* @public
11471209
*/
11481210
EndTime: Date | undefined;
@@ -1266,6 +1328,8 @@ export interface ListServiceDependentsOutput {
12661328
* <p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as
12671329
* be epoch time in seconds. For example: <code>1698778057</code>
12681330
* </p>
1331+
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
1332+
* it was rounded to the nearest hour.</p>
12691333
* @public
12701334
*/
12711335
StartTime: Date | undefined;
@@ -1274,6 +1338,8 @@ export interface ListServiceDependentsOutput {
12741338
* <p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as
12751339
* be epoch time in seconds. For example: <code>1698778057</code>
12761340
* </p>
1341+
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
1342+
* it was rounded to the nearest hour.</p>
12771343
* @public
12781344
*/
12791345
EndTime: Date | undefined;
@@ -1300,6 +1366,7 @@ export interface ListServiceOperationsInput {
13001366
* <p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
13011367
* be epoch time in seconds. For example: <code>1698778057</code>
13021368
* </p>
1369+
* <p>Your requested start time will be rounded to the nearest hour.</p>
13031370
* @public
13041371
*/
13051372
StartTime: Date | undefined;
@@ -1308,6 +1375,7 @@ export interface ListServiceOperationsInput {
13081375
* <p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
13091376
* be epoch time in seconds. For example: <code>1698778057</code>
13101377
* </p>
1378+
* <p>Your requested end time will be rounded to the nearest hour.</p>
13111379
* @public
13121380
*/
13131381
EndTime: Date | undefined;
@@ -1392,6 +1460,8 @@ export interface ListServiceOperationsOutput {
13921460
* <p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as
13931461
* be epoch time in seconds. For example: <code>1698778057</code>
13941462
* </p>
1463+
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
1464+
* it was rounded to the nearest hour.</p>
13951465
* @public
13961466
*/
13971467
StartTime: Date | undefined;
@@ -1400,6 +1470,8 @@ export interface ListServiceOperationsOutput {
14001470
* <p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as
14011471
* be epoch time in seconds. For example: <code>1698778057</code>
14021472
* </p>
1473+
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
1474+
* it was rounded to the nearest hour.</p>
14031475
* @public
14041476
*/
14051477
EndTime: Date | undefined;
@@ -1426,6 +1498,7 @@ export interface ListServicesInput {
14261498
* <p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
14271499
* be epoch time in seconds. For example: <code>1698778057</code>
14281500
* </p>
1501+
* <p>Your requested start time will be rounded to the nearest hour.</p>
14291502
* @public
14301503
*/
14311504
StartTime: Date | undefined;
@@ -1434,6 +1507,7 @@ export interface ListServicesInput {
14341507
* <p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as
14351508
* be epoch time in seconds. For example: <code>1698778057</code>
14361509
* </p>
1510+
* <p>Your requested start time will be rounded to the nearest hour.</p>
14371511
* @public
14381512
*/
14391513
EndTime: Date | undefined;
@@ -1587,6 +1661,8 @@ export interface ListServicesOutput {
15871661
* <p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as
15881662
* be epoch time in seconds. For example: <code>1698778057</code>
15891663
* </p>
1664+
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
1665+
* it was rounded to the nearest hour.</p>
15901666
* @public
15911667
*/
15921668
StartTime: Date | undefined;
@@ -1595,6 +1671,8 @@ export interface ListServicesOutput {
15951671
* <p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as
15961672
* be epoch time in seconds. For example: <code>1698778057</code>
15971673
* </p>
1674+
* <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because
1675+
* it was rounded to the nearest hour.</p>
15981676
* @public
15991677
*/
16001678
EndTime: Date | undefined;
@@ -1677,7 +1755,7 @@ export class ResourceNotFoundException extends __BaseException {
16771755
ResourceType: string | undefined;
16781756

16791757
/**
1680-
* <p>Cannot find the resource id.</p>
1758+
* <p>Can't find the resource id.</p>
16811759
* @public
16821760
*/
16831761
ResourceId: string | undefined;

clients/client-application-signals/src/protocols/Aws_restJson1.ts

+3
Original file line numberDiff line numberDiff line change
@@ -522,6 +522,7 @@ export const de_GetServiceCommand = async (
522522
const data: Record<string, any> = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
523523
const doc = take(data, {
524524
EndTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
525+
LogGroupReferences: _json,
525526
Service: _json,
526527
StartTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
527528
});
@@ -1032,6 +1033,8 @@ const de_Interval = (output: any, context: __SerdeContext): Interval => {
10321033
return { $unknown: Object.entries(output)[0] };
10331034
};
10341035

1036+
// de_LogGroupReferences omitted.
1037+
10351038
// de_Metric omitted.
10361039

10371040
// de_MetricDataQueries omitted.

0 commit comments

Comments
 (0)