Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
acw-ug-271	acw-ug.pdf	271	(Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension:48 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension:49 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension:49 Get started with Lambda Insights 893 Amazon CloudWatch User Guide Region ARN Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension:76 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension:48 Canada West (Calgary) arn:aws:lambda:ca-west-1:946466191631:layer:L ambdaInsightsExtension:9 China (Beijing) arn:aws-cn:lambda:cn-north-1:488211338238:lay er:LambdaInsightsExtension:39 China (Ningxia); arn:aws-cn:lambda:cn-northwest-1:488211338238 :layer:LambdaInsightsExtension:39 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension:49 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension:49 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension:49 Europe (Milan) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension:40 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension:48 Europe (Spain) arn:aws:lambda:eu-south-2:352183217350:layer: LambdaInsightsExtension:24 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension:46 Get started with Lambda Insights 894 Amazon CloudWatch User Guide Region ARN Europe (Zurich) arn:aws:lambda:eu-central-2:033019950311:laye r:LambdaInsightsExtension:23 Israel (Tel Aviv) arn:aws:lambda:il-central-1:459530977127:laye r:LambdaInsightsExtension:17 Middle East (Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension:40 Middle East (UAE) arn:aws:lambda:me-central-1:732604637566:laye r:LambdaInsightsExtension:23 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension:48 1.0.273.0 Version 1.0.273.0 includes important bug ﬁxes for all compatible runtimes, and adds support for Canada West (Calgary). ARNs for version 1.0.273.0 The following table lists the ARNs to use for this version of the extension in each AWS Region where it is available. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension:45 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension:45 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension:45 Get started with Lambda Insights 895 Amazon CloudWatch User Guide Region ARN US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension:45 Africa (Cape Town) arn:aws:lambda:af-south-1:012438385374:layer: LambdaInsightsExtension:35 Asia Paciﬁc (Hong Kong) Asia Paciﬁc (Hyderabad) arn:aws:lambda:ap-east-1:519774774795:layer:L ambdaInsightsExtension:35 arn:aws:lambda:ap-south-2:891564319516:layer: LambdaInsightsExtension:17 Asia Paciﬁc (Jakarta) arn:aws:lambda:ap-southeast-3:439286490199:la yer:LambdaInsightsExtension:21 Asia Paciﬁc (Melbourne) arn:aws:lambda:ap-southeast-4:158895979263:la yer:LambdaInsightsExtension:12 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension:43 Asia Paciﬁc (Osaka) arn:aws:lambda:ap-northeast-3:194566237122:la yer:LambdaInsightsExtension:26 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension:44 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension:45 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension:45 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension:72 Get started with Lambda Insights 896 Amazon CloudWatch User Guide Region ARN Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension:44 Canada West (Calgary) arn:aws:lambda:ca-west-1:946466191631:layer:L ambdaInsightsExtension:4 China (Beijing) arn:aws-cn:lambda:cn-north-1:488211338238:lay er:LambdaInsightsExtension:36 China (Ningxia); arn:aws-cn:lambda:cn-northwest-1:488211338238 :layer:LambdaInsightsExtension:36 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension:45 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension:45 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension:45 Europe (Milan) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension:35 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension:44 Europe (Spain) arn:aws:lambda:eu-south-2:352183217350:layer: LambdaInsightsExtension:19 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension:42 Europe (Zurich) arn:aws:lambda:eu-central-2:033019950311:laye r:LambdaInsightsExtension:17 Get started with Lambda Insights 897 Amazon CloudWatch User Guide Region ARN Israel (Tel Aviv) arn:aws:lambda:il-central-1:459530977127:laye r:LambdaInsightsExtension:12 Middle East (Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension:35 Middle East (UAE) arn:aws:lambda:me-central-1:732604637566:laye r:LambdaInsightsExtension:18 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension:44 1.0.229.0 Version 1.0.229.0 includes important bug ﬁxes for all compatible runtimes, and adds support for the Israel (Tel Aviv) Region. ARNs for version 1.0.229.0 The following table lists the ARNs to use for this version of the extension in each AWS Region where it is available. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension:38 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension:38 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension:38 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension:38 Get started with Lambda Insights 898 Amazon CloudWatch User Guide Region ARN Africa (Cape Town) arn:aws:lambda:af-south-1:012438385374:layer: LambdaInsightsExtension:28 Asia Paciﬁc (Hong Kong) Asia Paciﬁc (Hyderabad) arn:aws:lambda:ap-east-1:519774774795:layer:L ambdaInsightsExtension:28 arn:aws:lambda:ap-south-2:891564319516:layer: LambdaInsightsExtension:10 Asia Paciﬁc (Jakarta) arn:aws:lambda:ap-southeast-3:439286490199:la yer:LambdaInsightsExtension:14 Asia Paciﬁc (Melbourne) arn:aws:lambda:ap-southeast-4:158895979263:la yer:LambdaInsightsExtension:5 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension:36 Asia Paciﬁc (Osaka) arn:aws:lambda:ap-northeast-3:194566237122:la yer:LambdaInsightsExtension:19 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension:37 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension:38 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension:38 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension:60 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension:37 Get started with Lambda Insights 899 Amazon CloudWatch User Guide Region ARN China (Beijing) arn:aws-cn:lambda:cn-north-1:488211338238:lay er:LambdaInsightsExtension:29 China (Ningxia); arn:aws-cn:lambda:cn-northwest-1:488211338238 :layer:LambdaInsightsExtension:29 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension:38 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension:38 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension:38 Europe (Milan) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension:28 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension:37 Europe (Spain) arn:aws:lambda:eu-south-2:352183217350:layer: LambdaInsightsExtension:12 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension:35 Europe (Zurich) arn:aws:lambda:eu-central-2:033019950311:laye r:LambdaInsightsExtension:11 Israel (Tel Aviv) arn:aws:lambda:il-central-1:459530977127:laye r:LambdaInsightsExtension:5 Middle East (Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension:28 Get started with Lambda Insights 900 Amazon CloudWatch User Guide Region ARN Middle East (UAE) arn:aws:lambda:me-central-1:732604637566:laye r:LambdaInsightsExtension:11 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension:37 1.0.178.0 Version 1.0.178.0 adds support for the following AWS Regions. • Asia Paciﬁc (Hyderabad) • Asia Paciﬁc (Jakarta) • Europe (Spain) • Europe (Zurich) • Middle East (UAE) ARNs for version 1.0.178.0 The following table lists the ARNs to use for this version of the extension in each AWS Region where it is available. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension:35 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension:33 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension:33 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension:33 Get started with Lambda Insights 901 Amazon CloudWatch User Guide Region ARN Africa (Cape Town) arn:aws:lambda:af-south-1:012438385374:layer: LambdaInsightsExtension:25 Asia Paciﬁc (Hong Kong) Asia Paciﬁc (Hyderabad) arn:aws:lambda:ap-east-1:519774774795:layer:L ambdaInsightsExtension:25 arn:aws:lambda:ap-south-2:891564319516:layer: LambdaInsightsExtension:8 Asia Paciﬁc (Jakarta) arn:aws:lambda:ap-southeast-3:439286490199:la yer:LambdaInsightsExtension:11 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension:31 Asia Paciﬁc (Osaka) arn:aws:lambda:ap-northeast-3:194566237122:la yer:LambdaInsightsExtension:2 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension:32 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension:33 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension:33 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension:50 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension:32 China (Beijing) arn:aws-cn:lambda:cn-north-1:488211338238:lay er:LambdaInsightsExtension:26 Get started with Lambda Insights 902 Amazon CloudWatch User Guide Region ARN China (Ningxia); arn:aws-cn:lambda:cn-northwest-1:488211338238 :layer:LambdaInsightsExtension:26 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension:35 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension:33 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension:33 Europe (Milan) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension:25 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension:32 Europe (Spain) arn:aws:lambda:eu-south-2:352183217350:layer: LambdaInsightsExtension:10 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension:30 Europe (Zurich) arn:aws:lambda:eu-central-2:033019950311:laye r:LambdaInsightsExtension:7 Middle East (Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension:25 Middle East (UAE) arn:aws:lambda:me-central-1:732604637566:laye r:LambdaInsightsExtension:9 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension:32 Get started with Lambda Insights 903 Amazon CloudWatch 1.0.143.0 User Guide
acw-ug-272	acw-ug.pdf	272	yer:LambdaInsightsExtension:32 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension:33 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension:33 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension:50 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension:32 China (Beijing) arn:aws-cn:lambda:cn-north-1:488211338238:lay er:LambdaInsightsExtension:26 Get started with Lambda Insights 902 Amazon CloudWatch User Guide Region ARN China (Ningxia); arn:aws-cn:lambda:cn-northwest-1:488211338238 :layer:LambdaInsightsExtension:26 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension:35 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension:33 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension:33 Europe (Milan) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension:25 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension:32 Europe (Spain) arn:aws:lambda:eu-south-2:352183217350:layer: LambdaInsightsExtension:10 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension:30 Europe (Zurich) arn:aws:lambda:eu-central-2:033019950311:laye r:LambdaInsightsExtension:7 Middle East (Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension:25 Middle East (UAE) arn:aws:lambda:me-central-1:732604637566:laye r:LambdaInsightsExtension:9 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension:32 Get started with Lambda Insights 903 Amazon CloudWatch 1.0.143.0 User Guide Version 1.0.143.0 includes bug ﬁxes in compatibility with Python 3.7 and Go 1.x. The Python 3.6 Lambda runtime is being deprecated. For more information, see Lambda runtimes. ARNs for version 1.0.143.0 The following table lists the ARNs to use for this version of the extension in each AWS Region where it is available. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension:21 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension:21 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension:20 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension:21 Africa (Cape Town) arn:aws:lambda:af-south-1:012438385374:layer: LambdaInsightsExtension:13 Asia Paciﬁc (Hong Kong) arn:aws:lambda:ap-east-1:519774774795:layer:L ambdaInsightsExtension:13 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension:21 Asia Paciﬁc (Osaka) arn:aws:lambda:ap-northeast-3:194566237122:la yer:LambdaInsightsExtension:2 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension:20 Get started with Lambda Insights 904 Amazon CloudWatch User Guide Region ARN Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension:21 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension:21 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension:32 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension:20 China (Beijing) arn:aws-cn:lambda:cn-north-1:488211338238:lay er:LambdaInsightsExtension:14 China (Ningxia); arn:aws-cn:lambda:cn-northwest-1:488211338238 :layer:LambdaInsightsExtension:14 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension:21 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension:21 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension:21 Europe (Milan) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension:13 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension:20 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension:20 Get started with Lambda Insights 905 Amazon CloudWatch User Guide Region ARN Middle East (Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension:13 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension:20 1.0.135.0 Version 1.0.135.0 includes bug ﬁxes for how Lambda Insights collects and reports disk and ﬁle descriptor usage. In previous versions of the extension, the tmp_free metric reported the maximum free space in the /tmp directory while a function runs. This version changes the metric to report the minimum value instead, making it more useful when assessing disk usage. For more information about tmp directory storage quotas, see Lambda quotas. Version 1.0.135.0 also now reports ﬁle descriptor usage (fd_use and fd_max) as the maximum value across processes rather than reporting the operating system level. ARNs for version 1.0.135.0 The following table lists the ARNs to use for this version of the extension in each AWS Region where it is available. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension:18 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension:18 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension:18 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension:18 Get started with Lambda Insights 906 Amazon CloudWatch User Guide Region ARN Africa (Cape Town) arn:aws:lambda:af-south-1:012438385374:layer: LambdaInsightsExtension:11 Asia Paciﬁc (Hong Kong) arn:aws:lambda:ap-east-1:519774774795:layer:L ambdaInsightsExtension:11 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension:18 Asia Paciﬁc (Osaka) arn:aws:lambda:ap-northeast-3:194566237122:la yer:LambdaInsightsExtension:1 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension:18 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension:18 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension:18 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension:25 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension:18 China (Beijing) arn:aws-cn:lambda:cn-north-1:488211338238:lay er:LambdaInsightsExtension:11 China (Ningxia); arn:aws-cn:lambda:cn-northwest-1:488211338238 :layer:LambdaInsightsExtension:11 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension:18 Get started with Lambda Insights 907 Amazon CloudWatch User Guide Region ARN Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension:18 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension:18 Europe (Milan) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension:11 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension:18 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension:18 Middle East (Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension:11 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension:18 1.0.119.0 ARNs for version 1.0.119.0 The following table lists the ARNs to use for this version of the extension in each AWS Region where it is available. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension:16 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension:16 Get started with Lambda Insights 908 Amazon CloudWatch User Guide Region ARN US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension:16 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension:16 Africa (Cape Town) arn:aws:lambda:af-south-1:012438385374:layer: LambdaInsightsExtension:9 Asia Paciﬁc (Hong Kong) arn:aws:lambda:ap-east-1:519774774795:layer:L ambdaInsightsExtension:9 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension:16 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension:16 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension:16 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension:16 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension:23 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension:16 China (Beijing) arn:aws-cn:lambda:cn-north-1:488211338238:lay er:LambdaInsightsExtension:9 China (Ningxia); arn:aws-cn:lambda:cn-northwest-1:488211338238 :layer:LambdaInsightsExtension:9 Get started with Lambda Insights 909 Amazon CloudWatch User Guide Region ARN Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension:16 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension:16 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension:16 Europe (Milan) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension:9 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension:16 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension:16 Middle East (Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension:9 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension:16 1.0.98.0 This version removes unnecessary logging and also addresses an issue with the AWS Serverless Application Model CLI local invokes. For more information about this issue, see Adding LambdaInsightsExtension results in timeout with 'sam local invoke'. ARNs for version 1.0.98.0 The following table lists the ARNs to use for this version of the extension in each AWS Region where it is available. Get started with Lambda Insights 910 Amazon CloudWatch User Guide Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension:14 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension:14 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L
acw-ug-273	acw-ug.pdf	273	(Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension:9 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension:16 1.0.98.0 This version removes unnecessary logging and also addresses an issue with the AWS Serverless Application Model CLI local invokes. For more information about this issue, see Adding LambdaInsightsExtension results in timeout with 'sam local invoke'. ARNs for version 1.0.98.0 The following table lists the ARNs to use for this version of the extension in each AWS Region where it is available. Get started with Lambda Insights 910 Amazon CloudWatch User Guide Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension:14 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension:14 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension:14 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension:14 Africa (Cape Town) arn:aws:lambda:af-south-1:012438385374:layer: LambdaInsightsExtension:8 Asia Paciﬁc (Hong Kong) arn:aws:lambda:ap-east-1:519774774795:layer:L ambdaInsightsExtension:8 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension:14 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension:14 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension:14 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension:14 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension:14 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension:14 Get started with Lambda Insights 911 Amazon CloudWatch User Guide Region ARN China (Beijing) arn:aws-cn:lambda:cn-north-1:488211338238:lay er:LambdaInsightsExtension:8 China (Ningxia); arn:aws-cn:lambda:cn-northwest-1:488211338238 :layer:LambdaInsightsExtension:8 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension:14 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension:14 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension:14 Europe (Milan) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension:8 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension:14 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension:14 Middle East (Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension:8 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension:14 1.0.89.0 This version corrects the performance event timestamp to always represent the start of the invocation of the function. ARNs for version 1.0.89.0 Get started with Lambda Insights 912 Amazon CloudWatch User Guide The following table lists the ARNs to use for this version of the extension in each AWS Region where it is available. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension:12 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension:12 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension:12 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension:12 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension:12 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension:12 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension:12 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension:12 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension:12 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension:12 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension:12 Get started with Lambda Insights 913 Amazon CloudWatch User Guide Region ARN Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension:12 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension:12 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension:12 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension:12 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension:12 1.0.86.0 With version 1.0.54.0 of the extension, memory metrics were sometimes reported incorrectly and sometimes were higher than 100%. Version 1.0.86.0 corrects the memory measurement issue by using the same event data as Lambda platform metrics. This means that you may see a dramatic change in the recorded memory metric values. This is achieved by using the new Lambda Logs API. This provides a more accurate measurement of Lambda sandbox memory usage. However, something to be aware of is that the Lambda Logs API can't deliver platform report events if a function sandbox times out and is subsequently spun down. In this case. Lambda Insights is unable to record the invocation metrics. For more information about Lambda Logs API, see AWS Lambda Logs API. New features in version 1.0.86.0 • Uses the Lambda Logs API to correct the memory metric. This solves the previous issue where memory statistics were greater than 100%. • Introduces Init Duration as a new CloudWatch metric. • Uses the invocation ARN to add a version dimension for aliases and invoked versions. If you are using Lambda aliases or versions to achieve incremental deployments (such as blue-green deployments), you can view your metrics based on the invoked alias. The version dimension is Get started with Lambda Insights 914 Amazon CloudWatch User Guide not applied if the function doesn't use an alias or version. For more information, see Lambda function aliases. • Adds a billed_mb_ms field to the performance events to display the cost per invoke. This does not consider any cost associated with provisioned concurrency. • Adds billed_duration and duration ﬁelds to the performance events. ARNs for version 1.0.86.0 The following table lists the ARNs to use for this version of the extension in each AWS Region where it is available. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension:11 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension:11 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension:11 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension:11 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension:11 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension:11 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension:11 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension:11 Get started with Lambda Insights 915 Amazon CloudWatch User Guide Region ARN Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension:11 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension:11 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension:11 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension:11 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension:11 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension:11 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension:11 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension:11 1.0.54.0 Version 1.0.54.0 was the initial release of the Lambda Insights extension. ARNs for version 1.0.54.0 The following table lists the ARNs to use for this version of the extension in each AWS Region where it is available. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension:2 Get started with Lambda Insights 916 Amazon CloudWatch User Guide Region ARN US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L
acw-ug-274	acw-ug.pdf	274	Guide Region ARN Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension:11 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension:11 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension:11 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension:11 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension:11 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension:11 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension:11 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension:11 1.0.54.0 Version 1.0.54.0 was the initial release of the Lambda Insights extension. ARNs for version 1.0.54.0 The following table lists the ARNs to use for this version of the extension in each AWS Region where it is available. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension:2 Get started with Lambda Insights 916 Amazon CloudWatch User Guide Region ARN US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension:2 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension:2 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension:2 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension:2 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension:2 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension:2 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension:2 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension:2 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension:2 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension:2 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension:2 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension:2 Get started with Lambda Insights 917 Amazon CloudWatch User Guide Region ARN Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension:2 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension:2 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension:2 ARM64 platforms This section lists the versions of the Lambda Insights extension for ARM64 platforms, and the ARNs to use for these extensions in each AWS Region. Important Lambda Insights extensions 1.0.317.0 and later don't support Amazon Linux 1. 1.0.404.0 Version 1.0.404.0 reduces the binary size of the Lambda Insights extension from ~9MB to ~5MB, and subsequently reduces the zip size of the Lambda Insights extension layer from ~3,7MB to ~2.5MB. It also reduces the overall memory consumption of the agent from ~11MB to ~7MB. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:23 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension-Arm64:25 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:21 Get started with Lambda Insights 918 Amazon CloudWatch User Guide Region ARN US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:23 Africa (Cape Town) arn:aws:lambda:af-south-1:012438385374:layer: LambdaInsightsExtension-Arm64:21 Asia Paciﬁc (Hong Kong) Asia Paciﬁc (Hyderabad) arn:aws:lambda:ap-east-1:519774774795:layer:L ambdaInsightsExtension-Arm64:21 arn:aws:lambda:ap-south-2:891564319516:layer: LambdaInsightsExtension-Arm64:9 Asia Paciﬁc (Jakarta) arn:aws:lambda:ap-southeast-3:439286490199:la yer:LambdaInsightsExtension-Arm64:21 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension-Arm64:25 Asia Paciﬁc (Osaka) arn:aws:lambda:ap-northeast-3:194566237122:la yer:LambdaInsightsExtension-Arm64:20 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:22 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:23 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:23 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:34 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:21 Get started with Lambda Insights 919 Amazon CloudWatch User Guide Region ARN Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:23 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:23 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:23 Europe (Milan) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension-Arm64:21 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension-Arm64:21 Europe (Spain) arn:aws:lambda:eu-south-2:352183217350:layer: LambdaInsightsExtension-Arm64:9 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension-Arm64:21 Middle East (Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension-Arm64:21 South America (São Paulo) AWS GovCloud (US- East) AWS GovCloud (US- West) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:21 arn:aws-us-gov:lambda:us-gov-east-1:122132214 140:layer:LambdaInsightsExtension-Arm64:6 arn:aws-us-gov:lambda:us-gov-west-1:751350123 760:layer:LambdaInsightsExtension-Arm64:6 Get started with Lambda Insights 920 Amazon CloudWatch 1.0.391.0 Important User Guide Version 1.0.391.0 changes how Lambda Insights collects and reports thread usage. In previous versions of the extension, the threads_max metric reported the maximum number of threads running in the process that has the process ID of 1. Starting with version 1.0.391.0, this metric reports the maximum number of threads that were running at any point of time during the function’s execution, across all processes in the execution environment. This includes the Lambda function's processes, extensions' processes, system/runtime speciﬁc processes, and so on. This makes the threads_max metric more comprehensive while assessing the remaining threads left for your use. For more information about thread and process quotas, see Lambda quotas. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:22 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension-Arm64:24 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:20 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:22 Africa (Cape Town) arn:aws:lambda:af-south-1:012438385374:layer: LambdaInsightsExtension-Arm64:20 Asia Paciﬁc (Hong Kong) Asia Paciﬁc (Hyderabad) arn:aws:lambda:ap-east-1:519774774795:layer:L ambdaInsightsExtension-Arm64:20 arn:aws:lambda:ap-south-2:891564319516:layer: LambdaInsightsExtension-Arm64:8 Get started with Lambda Insights 921 Amazon CloudWatch User Guide Region ARN Asia Paciﬁc (Jakarta) arn:aws:lambda:ap-southeast-3:439286490199:la yer:LambdaInsightsExtension-Arm64:20 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension-Arm64:24 Asia Paciﬁc (Osaka) arn:aws:lambda:ap-northeast-3:194566237122:la yer:LambdaInsightsExtension-Arm64:19 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:21 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:22 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:22 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:33 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:20 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:22 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:22 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:22 Europe (Milan) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension-Arm64:20 Get started with Lambda Insights 922 Amazon CloudWatch User Guide Region ARN Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension-Arm64:20 Europe (Spain) arn:aws:lambda:eu-south-2:352183217350:layer: LambdaInsightsExtension-Arm64:8 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension-Arm64:20 Middle East (Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension-Arm64:20 South America (São Paulo) AWS GovCloud (US- East) AWS GovCloud (US- West) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:20 arn:aws-us-gov:lambda:us-gov-east-1:122132214 140:layer:LambdaInsightsExtension-Arm64:5 arn:aws-us-gov:lambda:us-gov-west-1:751350123 760:layer:LambdaInsightsExtension-Arm64:5 1.0.333.0 Version 1.0.333.0 includes bug ﬁxes. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:20 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension-Arm64:22 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:18 Get started with Lambda Insights 923 Amazon CloudWatch User Guide Region ARN US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:20 Africa (Cape Town) arn:aws:lambda:af-south-1:012438385374:layer: LambdaInsightsExtension-Arm64:18 Asia Paciﬁc (Hong Kong) Asia Paciﬁc (Hyderabad) arn:aws:lambda:ap-east-1:519774774795:layer:L ambdaInsightsExtension-Arm64:18 arn:aws:lambda:ap-south-2:891564319516:layer: LambdaInsightsExtension-Arm64:6 Asia Paciﬁc (Jakarta) arn:aws:lambda:ap-southeast-3:439286490199:la yer:LambdaInsightsExtension-Arm64:18 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension-Arm64:22 Asia Paciﬁc (Osaka) arn:aws:lambda:ap-northeast-3:194566237122:la yer:LambdaInsightsExtension-Arm64:17 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:19 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:20 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:20 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:31 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:18 Get started
acw-ug-275	acw-ug.pdf	275	Version 1.0.333.0 includes bug ﬁxes. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:20 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension-Arm64:22 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:18 Get started with Lambda Insights 923 Amazon CloudWatch User Guide Region ARN US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:20 Africa (Cape Town) arn:aws:lambda:af-south-1:012438385374:layer: LambdaInsightsExtension-Arm64:18 Asia Paciﬁc (Hong Kong) Asia Paciﬁc (Hyderabad) arn:aws:lambda:ap-east-1:519774774795:layer:L ambdaInsightsExtension-Arm64:18 arn:aws:lambda:ap-south-2:891564319516:layer: LambdaInsightsExtension-Arm64:6 Asia Paciﬁc (Jakarta) arn:aws:lambda:ap-southeast-3:439286490199:la yer:LambdaInsightsExtension-Arm64:18 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension-Arm64:22 Asia Paciﬁc (Osaka) arn:aws:lambda:ap-northeast-3:194566237122:la yer:LambdaInsightsExtension-Arm64:17 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:19 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:20 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:20 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:31 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:18 Get started with Lambda Insights 924 Amazon CloudWatch User Guide Region ARN Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:20 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:20 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:20 Europe (Milan) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension-Arm64:18 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension-Arm64:18 Europe (Spain) arn:aws:lambda:eu-south-2:352183217350:layer: LambdaInsightsExtension-Arm64:6 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension-Arm64:18 Middle East (Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension-Arm64:18 arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:18 arn:aws-us-gov:lambda:us-gov-east-1:122132214 140:layer:LambdaInsightsExtension-Arm64:3 arn:aws-us-gov:lambda:us-gov-west-1:751350123 760:layer:LambdaInsightsExtension-Arm64:3 South America (São Paulo) AWS GovCloud (US- East) AWS GovCloud (US- West) 1.0.317.0 Version 1.0.317.0 includes the removal of support for the Amazon Linux 1 platform, and bug ﬁxes. It also includes support for AWS GovCloud (US) Regions. Get started with Lambda Insights 925 Amazon CloudWatch User Guide Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:19 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension-Arm64:21 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:17 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:19 Africa (Cape Town) arn:aws:lambda:af-south-1:012438385374:layer: LambdaInsightsExtension-Arm64:17 Asia Paciﬁc (Hong Kong) Asia Paciﬁc (Hyderabad) arn:aws:lambda:ap-east-1:519774774795:layer:L ambdaInsightsExtension-Arm64:17 arn:aws:lambda:ap-south-2:891564319516:layer: LambdaInsightsExtension-Arm64:5 Asia Paciﬁc (Jakarta) arn:aws:lambda:ap-southeast-3:439286490199:la yer:LambdaInsightsExtension-Arm64:17 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension-Arm64:21 Asia Paciﬁc (Osaka) arn:aws:lambda:ap-northeast-3:194566237122:la yer:LambdaInsightsExtension-Arm64:16 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:18 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:19 Get started with Lambda Insights 926 Amazon CloudWatch User Guide Region ARN Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:19 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:30 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:17 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:19 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:19 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:19 Europe (Milan) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension-Arm64:17 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension-Arm64:17 Europe (Spain) arn:aws:lambda:eu-south-2:352183217350:layer: LambdaInsightsExtension-Arm64:5 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension-Arm64:17 Middle East (Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension-Arm64:17 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:17 Get started with Lambda Insights 927 Amazon CloudWatch User Guide Region ARN arn:aws-us-gov:lambda:us-gov-east-1:122132214 140:layer:LambdaInsightsExtension-Arm64:1 arn:aws-us-gov:lambda:us-gov-west-1:751350123 760:layer:LambdaInsightsExtension-Arm64:1 AWS GovCloud (US- East) AWS GovCloud (US- West) 1.0.295.0 Version 1.0.295.0 includes dependency updates for all compatible runtimes. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:18 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension-Arm64:20 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:16 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:18 Africa (Cape Town) arn:aws:lambda:af-south-1:012438385374:layer: LambdaInsightsExtension-Arm64:16 Asia Paciﬁc (Hong Kong) Asia Paciﬁc (Hyderabad) arn:aws:lambda:ap-east-1:519774774795:layer:L ambdaInsightsExtension-Arm64:16 arn:aws:lambda:ap-south-2:891564319516:layer: LambdaInsightsExtension-Arm64:4 Asia Paciﬁc (Jakarta) arn:aws:lambda:ap-southeast-3:439286490199:la yer:LambdaInsightsExtension-Arm64:16 Get started with Lambda Insights 928 Amazon CloudWatch User Guide Region ARN Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension-Arm64:20 Asia Paciﬁc (Osaka) arn:aws:lambda:ap-northeast-3:194566237122:la yer:LambdaInsightsExtension-Arm64:15 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:17 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:18 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:18 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:29 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:16 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:18 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:18 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:18 Europe (Milan) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension-Arm64:16 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension-Arm64:16 Get started with Lambda Insights 929 Amazon CloudWatch User Guide Region ARN Europe (Spain) arn:aws:lambda:eu-south-2:352183217350:layer: LambdaInsightsExtension-Arm64:4 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension-Arm64:16 Middle East (Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension-Arm64:16 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:16 1.0.275.0 Version 1.0.275.0 includes bug ﬁxes for all compatible runtimes and support for the Europe (Spain) and Asia Paciﬁc (Hyderabad) Regions. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:16 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension-Arm64:18 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:14 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:16 Africa (Cape Town) arn:aws:lambda:af-south-1:012438385374:layer: LambdaInsightsExtension-Arm64:14 Asia Paciﬁc (Hong Kong) arn:aws:lambda:ap-east-1:519774774795:layer:L ambdaInsightsExtension-Arm64:14 Get started with Lambda Insights 930 Amazon CloudWatch User Guide Region ARN Asia Paciﬁc (Hyderabad) arn:aws:lambda:ap-south-2:891564319516:layer: LambdaInsightsExtension-Arm64:2 Asia Paciﬁc (Jakarta) arn:aws:lambda:ap-southeast-3:439286490199:la yer:LambdaInsightsExtension-Arm64:14 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension-Arm64:18 Asia Paciﬁc (Osaka) arn:aws:lambda:ap-northeast-3:194566237122:la yer:LambdaInsightsExtension-Arm64:13 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:15 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:16 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:16 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:27 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:14 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:16 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:16 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:16 Get started with Lambda Insights 931 Amazon CloudWatch User Guide Region ARN Europe (Milan) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension-Arm64:14 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension-Arm64:14 Europe (Spain) arn:aws:lambda:eu-south-2:352183217350:layer: LambdaInsightsExtension-Arm64:2 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension-Arm64:14 Middle East (Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension-Arm64:14 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:14 1.0.273.0 Version 1.0.273.0 includes bug ﬁxes for all compatible runtimes. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:12 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension-Arm64:14 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:9 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:12 Get started with Lambda Insights 932 Amazon CloudWatch User Guide Region ARN Africa (Cape Town) arn:aws:lambda:af-south-1:012438385374:layer: LambdaInsightsExtension-Arm64:9 Asia Paciﬁc (Hong Kong) arn:aws:lambda:ap-east-1:519774774795:layer:L ambdaInsightsExtension-Arm64:9 Asia Paciﬁc (Jakarta) arn:aws:lambda:ap-southeast-3:439286490199:la yer:LambdaInsightsExtension-Arm64:9 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension-Arm64:14 Asia Paciﬁc (Osaka) arn:aws:lambda:ap-northeast-3:194566237122:la yer:LambdaInsightsExtension-Arm64:9 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:11 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:12 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:12 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:23 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:10 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:12 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:12 Get started with Lambda Insights 933 Amazon CloudWatch User Guide Region ARN Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:12 Europe (Milan) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension-Arm64:9 Europe (Paris)
acw-ug-276	acw-ug.pdf	276	arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:9 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:12 Get started with Lambda Insights 932 Amazon CloudWatch User Guide Region ARN Africa (Cape Town) arn:aws:lambda:af-south-1:012438385374:layer: LambdaInsightsExtension-Arm64:9 Asia Paciﬁc (Hong Kong) arn:aws:lambda:ap-east-1:519774774795:layer:L ambdaInsightsExtension-Arm64:9 Asia Paciﬁc (Jakarta) arn:aws:lambda:ap-southeast-3:439286490199:la yer:LambdaInsightsExtension-Arm64:9 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension-Arm64:14 Asia Paciﬁc (Osaka) arn:aws:lambda:ap-northeast-3:194566237122:la yer:LambdaInsightsExtension-Arm64:9 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:11 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:12 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:12 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:23 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:10 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:12 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:12 Get started with Lambda Insights 933 Amazon CloudWatch User Guide Region ARN Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:12 Europe (Milan) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension-Arm64:9 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension-Arm64:10 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension-Arm64:10 Middle East (Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension-Arm64:9 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:10 1.0.229.0 Version 1.0.229.0 includes bug ﬁxes for all compatible runtimes. It also adds support for the following Regions: • US West (N. California) • Africa (Cape Town) • Asia Paciﬁc (Hong Kong) • Asia Paciﬁc (Jakarta) • Asia Paciﬁc (Osaka) • Asia Paciﬁc (Seoul) • Canada (Central) • Europe (Milan) • Europe (Paris) • Europe (Stockholm) • Middle East (Bahrain) Get started with Lambda Insights 934 Amazon CloudWatch • South America (São Paulo) Region ARN User Guide US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:5 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension-Arm64:7 US West (N. Californi a) arn:aws:lambda:us-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:3 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:5 Africa (Cape Town) arn:aws:lambda:af-south-1:012438385374:layer: LambdaInsightsExtension-Arm64:2 Asia Paciﬁc (Hong Kong) arn:aws:lambda:ap-east-1:519774774795:layer:L ambdaInsightsExtension-Arm64:2 Asia Paciﬁc (Jakarta) arn:aws:lambda:ap-southeast-3:439286490199:la yer:LambdaInsightsExtension-Arm64:2 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension-Arm64:7 Asia Paciﬁc (Osaka) arn:aws:lambda:ap-northeast-3:194566237122:la yer:LambdaInsightsExtension-Arm64:2 Asia Paciﬁc (Seoul) arn:aws:lambda:ap-northeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:4 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:5 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:5 Get started with Lambda Insights 935 Amazon CloudWatch User Guide Region ARN Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:11 Canada (Central) arn:aws:lambda:ca-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:3 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:5 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:5 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:5 Europe (Spain) arn:aws:lambda:eu-south-1:339249233099:layer: LambdaInsightsExtension-Arm64:2 Europe (Paris) arn:aws:lambda:eu-west-3:580247275435:layer:L ambdaInsightsExtension-Arm64:3 Europe (Stockholm) arn:aws:lambda:eu-north-1:580247275435:layer: LambdaInsightsExtension-Arm64:3 Middle East (Bahrain) arn:aws:lambda:me-south-1:285320876703:layer: LambdaInsightsExtension-Arm64:2 South America (São Paulo) arn:aws:lambda:sa-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:3 1.0.135.0 Version 1.0.135.0 includes bug ﬁxes for how Lambda Insights collects and reports disk and ﬁle descriptor usage. In previous versions of the extension, the tmp_free metric reported the maximum free space in the /tmp directory while a function runs. This version changes the metric to report the minimum value instead, making it more useful when assessing disk usage. For more information about tmp directory storage quotas, see Lambda quotas. Get started with Lambda Insights 936 Amazon CloudWatch User Guide Version 1.0.135.0 also now reports ﬁle descriptor usage (fd_use and fd_max) as the maximum value across processes rather than reporting the operating system level. Region ARN US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:2 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension-Arm64:2 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:2 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension-Arm64:2 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:2 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:2 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:2 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:2 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:2 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:2 Get started with Lambda Insights 937 Amazon CloudWatch 1.0.119.0 Region ARN User Guide US East (N. Virginia) arn:aws:lambda:us-east-1:580247275435:layer:L ambdaInsightsExtension-Arm64:1 US East (Ohio) arn:aws:lambda:us-east-2:580247275435:layer:L ambdaInsightsExtension-Arm64:1 US West (Oregon) arn:aws:lambda:us-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:1 Asia Paciﬁc (Mumbai) arn:aws:lambda:ap-south-1:580247275435:layer: LambdaInsightsExtension-Arm64:1 Asia Paciﬁc (Singapor e) arn:aws:lambda:ap-southeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:1 Asia Paciﬁc (Sydney) arn:aws:lambda:ap-southeast-2:580247275435:la yer:LambdaInsightsExtension-Arm64:1 Asia Paciﬁc (Tokyo) arn:aws:lambda:ap-northeast-1:580247275435:la yer:LambdaInsightsExtension-Arm64:1 Europe (Frankfurt) arn:aws:lambda:eu-central-1:580247275435:laye r:LambdaInsightsExtension-Arm64:1 Europe (Ireland) arn:aws:lambda:eu-west-1:580247275435:layer:L ambdaInsightsExtension-Arm64:1 Europe (London) arn:aws:lambda:eu-west-2:580247275435:layer:L ambdaInsightsExtension-Arm64:1 Using the console to enable Lambda Insights on an existing Lambda function Use the following steps in the Lambda Console to enable Lambda Insights on an existing Lambda function. Get started with Lambda Insights 938 Amazon CloudWatch User Guide To enable Lambda Insights on a Lambda function 1. Open the AWS Lambda console at https://console.aws.amazon.com/lambda/. 2. Choose the name of a function, and then select the Conﬁguration tab on the following screen. 3. Under the Conﬁguration tab, choose Monitoring and operations tools in the left navigation menu, and then choose Edit. You're directed to a screen where you can edit monitoring tools. 4. By Lambda Insights enhanced monitoring, choose Edit. 5. Under CloudWatch Lambda Insights, enable Enhanced monitoring, and then choose Save. Use the AWS CLI to enable Lambda Insights on an existing Lambda function Follow these steps to use the AWS CLI to enable Lambda Insights on an existing Lambda function. Step 1: Update function permissions To update the function's permissions • Attach the CloudWatchLambdaInsightsExecutionRolePolicy managed IAM policy to the function's execution role by entering the following command. aws iam attach-role-policy \ --role-name function-execution-role \ --policy-arn "arn:aws:iam::aws:policy/CloudWatchLambdaInsightsExecutionRolePolicy" Step 2: Install the Lambda extension Install the Lambda extension by entering the following command. Replace the ARN value for the layers parameter with the ARN matching your Region and the extension version that you want to use. For more information, see Available versions of the Lambda Insights extension. aws lambda update-function-configuration \ --function-name function-name \ --layers "arn:aws:lambda:us-west-1:580247275435:layer:LambdaInsightsExtension:14" Step 3: Enable the CloudWatch Logs VPC endpoint Get started with Lambda Insights 939 Amazon CloudWatch User Guide This step is necessary
acw-ug-277	acw-ug.pdf	277	policy to the function's execution role by entering the following command. aws iam attach-role-policy \ --role-name function-execution-role \ --policy-arn "arn:aws:iam::aws:policy/CloudWatchLambdaInsightsExecutionRolePolicy" Step 2: Install the Lambda extension Install the Lambda extension by entering the following command. Replace the ARN value for the layers parameter with the ARN matching your Region and the extension version that you want to use. For more information, see Available versions of the Lambda Insights extension. aws lambda update-function-configuration \ --function-name function-name \ --layers "arn:aws:lambda:us-west-1:580247275435:layer:LambdaInsightsExtension:14" Step 3: Enable the CloudWatch Logs VPC endpoint Get started with Lambda Insights 939 Amazon CloudWatch User Guide This step is necessary only for functions running in a private subnet with no internet access, and if you have not already conﬁgured a CloudWatch Logs virtual private cloud (VPC) endpoint. If you need to do this step, enter the following command, replacing the placeholders with information for your VPC. For more information, see Using CloudWatch Logs with Interface VPC Endpoints. aws ec2 create-vpc-endpoint \ --vpc-id vpcId \ --vpc-endpoint-type Interface \ --service-name com.amazonaws.region.logs \ --subnet-id subnetId --security-group-id securitygroupId Use the AWS SAM CLI to enable Lambda Insights on an existing Lambda function Follow these steps to use the AWS SAM AWS CLI to enable Lambda Insights on an existing Lambda function. If you don't already have the latest version of the AWS SAM CLI installed, you must ﬁrst install or upgrade it. For more information, see Installing the AWS SAM CLI. Step 1: Install the layer To make the Lambda Insights extension available to all of your Lambda functions, add a Layers property to the Globals section of your SAM template with the ARN of the Lambda Insights layer. The example below uses the layer for the initial release of Lambda Insights. For the latest release version of the Lambda Insights extension layer, see Available versions of the Lambda Insights extension. Globals: Function: Layers: - !Sub "arn:aws:lambda: ${AWS::Region}:580247275435:layer:LambdaInsightsExtension:14" To enable this layer for only a single function, add the Layers property to the function as shown in this example. Resources: Get started with Lambda Insights 940 Amazon CloudWatch MyFunction: Type: AWS::Serverless::Function Properties: Layers: - !Sub "arn:aws:lambda: ${AWS::Region}:580247275435:layer:LambdaInsightsExtension:14" Step 2: Add the managed policy User Guide For each function, add the CloudWatchLambdaInsightsExecutionRolePolicy IAM policy. AWS SAM doesn't support global policies, so you must enable those on each function individually, as shown in this example. For more information about globals, see Globals Section. Resources: MyFunction: Type: AWS::Serverless::Function Properties: Policies: - CloudWatchLambdaInsightsExecutionRolePolicy Invoking locally The AWS SAM CLI supports Lambda extensions. However, every locally executed invocation resets the runtime environment. Lambda Insights data won’t be available from local invocations because the runtime is restarted without a shutdown event. For more information, see Release 1.6.0 - Add support for local testing of AWS Lambda extensions. Troubleshooting To troubleshoot your Lambda Insights installation, add the following environment variable to your Lambda function to enable debug logging. Resources: MyFunction: Type: AWS::Serverless::Function Properties: Environment: Variables: LAMBDA_INSIGHTS_LOG_LEVEL: info Get started with Lambda Insights 941 Amazon CloudWatch User Guide Use AWS CloudFormation to enable Lambda Insights on an existing Lambda function Follow these steps to use AWS CloudFormation to enable Lambda Insights on an existing Lambda function. Step 1: Install the layer Add the Lambda Insights layer to the Layers property within the Lambda Insights layer ARN. The example below uses the layer for the initial release of Lambda Insights. For the latest release version of the Lambda Insights extension layer, see Available versions of the Lambda Insights extension. Resources: MyFunction: Type: AWS::Lambda::Function Properties: Layers: - !Sub "arn:aws:lambda: ${AWS::Region}:580247275435:layer:LambdaInsightsExtension:14" Step 2: Add the managed policy Add the CloudWatchLambdaInsightsExecutionRolePolicy IAM policy to your function execution role. Resources: MyFunctionExecutionRole: Type: 'AWS::IAM::Role' Properties: ManagedPolicyArns: - 'arn:aws:iam::aws:policy/CloudWatchLambdaInsightsExecutionRolePolicy' Step 3: (Optional) Add VPC endpoint This step is necessary only for functions running in a private subnet with no internet access, and if you have not already conﬁgured a CloudWatch Logs virtual private cloud (VPC) endpoint. For more information, see Using CloudWatch Logs with Interface VPC Endpoints. Resources: CloudWatchLogsVpcPrivateEndpoint: Get started with Lambda Insights 942 Amazon CloudWatch User Guide Type: AWS::EC2::VPCEndpoint Properties: PrivateDnsEnabled: 'true' VpcEndpointType: Interface VpcId: !Ref: VPC ServiceName: !Sub com.amazonaws.${AWS::Region}.logs SecurityGroupIds: - !Ref InterfaceVpcEndpointSecurityGroup SubnetIds: - !Ref PublicSubnet01 - !Ref PublicSubnet02 - !Ref PublicSubnet03 Use the AWS CDK to enable Lambda Insights on an existing Lambda function Follow these steps to use the AWS CDK to enable Lambda Insights on an existing Lambda function. To use these steps, you must already be using the AWS CDK to manage your resources. The commands in this section are in TypeScript. First, update the function permissions. executionRole.addManagedPolicy( ManagedPolicy.fromAwsManagedPolicyName('CloudWatchLambdaInsightsExecutionRolePolicy') ); Next, install the extension on the Lambda function. Replace the ARN value for the layerArn parameter with the ARN matching your Region and the extension version that you want to use. For more information, see Available versions of the Lambda Insights
acw-ug-278	acw-ug.pdf	278	CDK to enable Lambda Insights on an existing Lambda function Follow these steps to use the AWS CDK to enable Lambda Insights on an existing Lambda function. To use these steps, you must already be using the AWS CDK to manage your resources. The commands in this section are in TypeScript. First, update the function permissions. executionRole.addManagedPolicy( ManagedPolicy.fromAwsManagedPolicyName('CloudWatchLambdaInsightsExecutionRolePolicy') ); Next, install the extension on the Lambda function. Replace the ARN value for the layerArn parameter with the ARN matching your Region and the extension version that you want to use. For more information, see Available versions of the Lambda Insights extension. import lambda = require('@aws-cdk/aws-lambda'); const layerArn = 'arn:aws:lambda:us- west-1:580247275435:layer:LambdaInsightsExtension:14'; const layer = lambda.LayerVersion.fromLayerVersionArn(this, 'LayerFromArn', layerArn); If necessary, enable the virtual private cloud (VPC) endpoint for CloudWatch Logs. This step is necessary only for functions running in a private subnet with no internet access, and if you have not already conﬁgured a CloudWatch Logs VPC endpoint. const cloudWatchLogsEndpoint = vpc.addInterfaceEndpoint('cwl-gateway', { service: InterfaceVpcEndpointAwsService.CLOUDWATCH_LOGS, Get started with Lambda Insights 943 Amazon CloudWatch }); User Guide cloudWatchLogsEndpoint.connections.allowDefaultPortFromAnyIpv4(); Use Serverless Framework to enable Lambda Insights on an existing Lambda function Follow these steps to use Serverless Framework to enable Lambda Insights on an existing Lambda function. For more information about Serverless Framework, see serverless.com. This is done through a Lambda Insights plugin for Serverless. For more information, see serverless- plugin-lambda-insights. If you don't already have the latest version of the Serverless command-line interface installed, you must ﬁrst install or upgrade it. For more information, see Get started with Serverless Framework Open Source & AWS. To use Serverless Framework to enable Lambda Insights on a Lambda function 1. Install the Serverless plugin for Lambda Insights by running the following command in your Serverless directory: npm install --save-dev serverless-plugin-lambda-insights 2. In your serverless.yml ﬁle, add the plugin in the plugins section as shown: provider: name: aws plugins: - serverless-plugin-lambda-insights 3. Enable Lambda Insights. • You can enable Lambda Insights individually per function by adding the following property to the serverless.yml ﬁle functions: myLambdaFunction: handler: src/app/index.handler lambdaInsights: true #enables Lambda Insights for this function Get started with Lambda Insights 944 Amazon CloudWatch User Guide • You can enable Lambda Insights for all functions within the serverless.yml ﬁle by adding the following custom section: custom: lambdaInsights: defaultLambdaInsights: true #enables Lambda Insights for all functions 4. Re-deploy the Serverless service by entering the following command: serverless deploy This re-deploys all functions and enables Lambda Insights for those functions that you have speciﬁed. It enables Lambda Insights by adding the Lambda Insights layer and attaching the necessary permissions using the arn:aws:iam::aws:policy/ CloudWatchLambdaInsightsExecutionRolePolicy IAM policy. Enable Lambda Insights on a Lambda container image deployment To enable Lambda Insights on a Lambda function that is deployed as a container image, add lines in your Dockerﬁle. These lines install the Lambda Insights agent as an extension in your container image. The lines to add are diﬀerent for x86-64 containers and ARM64 containers. Note The Lambda Insights agent is supported only on Lambda runtimes that use Amazon Linux 2. Topics • x86-64 container image deployment • ARM64 container image deployment x86-64 container image deployment To enable Lambda Insights on a Lambda function that is deployed as a container image running on an x86-64 container, add the following lines in your Dockerﬁle. These lines install the Lambda Insights agent as an extension in your container image. Get started with Lambda Insights 945 Amazon CloudWatch User Guide RUN curl -O https://lambda-insights-extension.s3-ap-northeast-1.amazonaws.com/ amazon_linux/lambda-insights-extension.rpm && \ rpm -U lambda-insights-extension.rpm && \ rm -f lambda-insights-extension.rpm After you create your Lambda function, assign the CloudWatchLambdaInsightsExecutionRolePolicy IAM policy to the function's execution role, and Lambda Insights is enabled on the container image-based Lambda function. Note To use an older version of the Lambda Insights extension, replace the URL in the previous commands with this URL: https://lambda-insights-extension.s3- ap-northeast-1.amazonaws.com/amazon_linux/lambda-insights- extension.1.0.111.0.rpm. Currently, only Lambda Insights versions 1.0.111.0 and later are available. For more information, see Available versions of the Lambda Insights extension. To verify the signature of the Lambda Insights agent package on a Linux server 1. Enter the following command to download the public key. shell$ wget https://lambda-insights-extension.s3-ap-northeast-1.amazonaws.com/ lambda-insights-extension.gpg 2. Enter the following command to import the public key into your keyring. shell$ gpg --import lambda-insights-extension.gpg The output will be similar to the following. Make a note of the key value, you will need it in the next step. In this example output, the key value is 848ABDC8. gpg: key 848ABDC8: public key "Amazon Lambda Insights Extension" imported gpg: Total number processed: 1 gpg: imported: 1 (RSA: 1) 3. Verify the ﬁngerprint by entering the following command. Replace key-value with the value of the key from the preceding step. Get started with Lambda Insights 946 Amazon CloudWatch User Guide shell$ gpg --fingerprint key-value The ﬁngerprint string in the output of this command
acw-ug-279	acw-ug.pdf	279	shell$ gpg --import lambda-insights-extension.gpg The output will be similar to the following. Make a note of the key value, you will need it in the next step. In this example output, the key value is 848ABDC8. gpg: key 848ABDC8: public key "Amazon Lambda Insights Extension" imported gpg: Total number processed: 1 gpg: imported: 1 (RSA: 1) 3. Verify the ﬁngerprint by entering the following command. Replace key-value with the value of the key from the preceding step. Get started with Lambda Insights 946 Amazon CloudWatch User Guide shell$ gpg --fingerprint key-value The ﬁngerprint string in the output of this command should be E0AF FA11 FFF3 5BD7 349E E222 479C 97A1 848A BDC8. If the string doesn't match, don't install the agent and contact AWS. 4. After you have veriﬁed the ﬁngerprint, you can use it to verify the Lambda Insights agent package. Download the package signature ﬁle by entering the following command. shell$ wget https://lambda-insights-extension.s3-ap-northeast-1.amazonaws.com/ amazon_linux/lambda-insights-extension.rpm.sig 5. Verify the signature by entering the following command. shell$ gpg --verify lambda-insights-extension.rpm.sig lambda-insights-extension.rpm The output should look like the following: gpg: Signature made Thu 08 Apr 2021 06:41:00 PM UTC using RSA key ID 848ABDC8 gpg: Good signature from "Amazon Lambda Insights Extension" gpg: WARNING: This key is not certified with a trusted signature! gpg: There is no indication that the signature belongs to the owner. Primary key fingerprint: E0AF FA11 FFF3 5BD7 349E E222 479C 97A1 848A BDC8 In the expected output, there might be a warning about a trusted signature. A key is trusted only if you or someone who you trust has signed it. This doesn't mean that the signature is invalid, only that you have not veriﬁed the public key. If the output contains BAD signature, check whether you performed the steps correctly. If you continue to get a BAD signature response, contact AWS and avoid using the downloaded ﬁle. x86-64 Example This section includes an example of enabling Lambda Insights on a container image-based Python Lambda function. Get started with Lambda Insights 947 Amazon CloudWatch User Guide An example of enabling Lambda Insights on a Lambda container image 1. Create a Dockerﬁle that is similar to the following: FROM public.ecr.aws/lambda/python:3.8 // extra lines to install the agent here RUN curl -O https://lambda-insights-extension.s3-ap-northeast-1.amazonaws.com/ amazon_linux/lambda-insights-extension.rpm && \ rpm -U lambda-insights-extension.rpm && \ rm -f lambda-insights-extension.rpm COPY index.py ${LAMBDA_TASK_ROOT} CMD [ "index.handler" ] 2. Create a Python ﬁle named index.py that is similar to the following: def handler(event, context): return { 'message': 'Hello World!' } 3. Put the Dockerﬁle and index.py in the same directory. Then, in that directory, run the following steps to build the docker image and upload it to Amazon ECR. // create an ECR repository aws ecr create-repository --repository-name test-repository // build the docker image docker build -t test-image . // sign in to AWS aws ecr get-login-password \| docker login --username AWS --password-stdin "${ACCOUNT_ID}".dkr.ecr."${REGION}".amazonaws.com // tag the image docker tag test-image:latest "${ACCOUNT_ID}".dkr.ecr."${REGION}".amazonaws.com/ test-repository:latest // push the image to ECR docker push "${ACCOUNT_ID}".dkr.ecr."${REGION}".amazonaws.com/test- repository:latest 4. Use that Amazon ECR image that you just created to create the Lambda function. 5. Assign the CloudWatchLambdaInsightsExecutionRolePolicy IAM policy to the function's execution role. Get started with Lambda Insights 948 Amazon CloudWatch User Guide ARM64 container image deployment To enable Lambda Insights on a Lambda function that is deployed as a container image running on an AL2_aarch64 container (which uses ARM64 architecture), add the following lines in your Dockerﬁle. These lines install the Lambda Insights agent as an extension in your container image. RUN curl -O https://lambda-insights-extension-arm64.s3-ap-northeast-1.amazonaws.com/ amazon_linux/lambda-insights-extension-arm64.rpm && \ rpm -U lambda-insights-extension-arm64.rpm && \ rm -f lambda-insights-extension-arm64.rpm After you create your Lambda function, assign the CloudWatchLambdaInsightsExecutionRolePolicy IAM policy to the function's execution role, and Lambda Insights is enabled on the container image-based Lambda function. Note To use an older version of the Lambda Insights extension, replace the URL in the previous commands with this URL: https://lambda-insights-extension-arm64.s3-ap- northeast-1.amazonaws.com/amazon_linux/lambda-insights-extension- arm64.1.0.229.0.rpm. Currently, only Lambda Insights versions 1.0.229.0 and later are available. For more information, see Available versions of the Lambda Insights extension. To verify the signature of the Lambda Insights agent package on a Linux server 1. Enter the following command to download the public key. shell$ wget https://lambda-insights-extension-arm64.s3-ap- northeast-1.amazonaws.com/lambda-insights-extension.gpg 2. Enter the following command to import the public key into your keyring. shell$ gpg --import lambda-insights-extension.gpg The output will be similar to the following. Make a note of the key value, you will need it in the next step. In this example output, the key value is 848ABDC8. gpg: key 848ABDC8: public key "Amazon Lambda Insights Extension" imported Get started with Lambda Insights 949 Amazon CloudWatch User Guide gpg: Total number processed: 1 gpg: imported: 1 (RSA: 1) 3. Verify the ﬁngerprint by entering the following command. Replace key-value with the value of the key from the preceding step. shell$ gpg --fingerprint
acw-ug-280	acw-ug.pdf	280	following command to import the public key into your keyring. shell$ gpg --import lambda-insights-extension.gpg The output will be similar to the following. Make a note of the key value, you will need it in the next step. In this example output, the key value is 848ABDC8. gpg: key 848ABDC8: public key "Amazon Lambda Insights Extension" imported Get started with Lambda Insights 949 Amazon CloudWatch User Guide gpg: Total number processed: 1 gpg: imported: 1 (RSA: 1) 3. Verify the ﬁngerprint by entering the following command. Replace key-value with the value of the key from the preceding step. shell$ gpg --fingerprint key-value The ﬁngerprint string in the output of this command should be E0AF FA11 FFF3 5BD7 349E E222 479C 97A1 848A BDC8. If the string doesn't match, don't install the agent and contact AWS. 4. After you have veriﬁed the ﬁngerprint, you can use it to verify the Lambda Insights agent package. Download the package signature ﬁle by entering the following command. shell$ wget https://lambda-insights-extension-arm64.s3-ap- northeast-1.amazonaws.com/amazon_linux/lambda-insights-extension-arm64.rpm.sig 5. Verify the signature by entering the following command. shell$ gpg --verify lambda-insights-extension-arm64.rpm.sig lambda-insights- extension-arm64.rpm The output should look like the following: gpg: Signature made Thu 08 Apr 2021 06:41:00 PM UTC using RSA key ID 848ABDC8 gpg: Good signature from "Amazon Lambda Insights Extension" gpg: WARNING: This key is not certified with a trusted signature! gpg: There is no indication that the signature belongs to the owner. Primary key fingerprint: E0AF FA11 FFF3 5BD7 349E E222 479C 97A1 848A BDC8 In the expected output, there might be a warning about a trusted signature. A key is trusted only if you or someone who you trust has signed it. This doesn't mean that the signature is invalid, only that you have not veriﬁed the public key. If the output contains BAD signature, check whether you performed the steps correctly. If you continue to get a BAD signature response, contact AWS and avoid using the downloaded ﬁle. Get started with Lambda Insights 950 Amazon CloudWatch ARM64 Example User Guide This section includes an example of enabling Lambda Insights on a container image-based Python Lambda function. An example of enabling Lambda Insights on a Lambda container image 1. Create a Dockerﬁle that is similar to the following: FROM public.ecr.aws/lambda/python:3.8 // extra lines to install the agent here RUN curl -O https://lambda-insights-extension-arm64.s3-ap- northeast-1.amazonaws.com/amazon_linux/lambda-insights-extension-arm64.rpm && \ rpm -U lambda-insights-extension-arm64.rpm && \ rm -f lambda-insights-extension-arm64.rpm COPY index.py ${LAMBDA_TASK_ROOT} CMD [ "index.handler" ] 2. Create a Python ﬁle named index.py that is similar to the following: def handler(event, context): return { 'message': 'Hello World!' } 3. Put the Dockerﬁle and index.py in the same directory. Then, in that directory, run the following steps to build the docker image and upload it to Amazon ECR. // create an ECR repository aws ecr create-repository --repository-name test-repository // build the docker image docker build -t test-image . // sign in to AWS aws ecr get-login-password \| docker login --username AWS --password-stdin "${ACCOUNT_ID}".dkr.ecr."${REGION}".amazonaws.com // tag the image docker tag test-image:latest "${ACCOUNT_ID}".dkr.ecr."${REGION}".amazonaws.com/ test-repository:latest // push the image to ECR docker push "${ACCOUNT_ID}".dkr.ecr."${REGION}".amazonaws.com/test- repository:latest Get started with Lambda Insights 951 Amazon CloudWatch User Guide 4. Use that Amazon ECR image that you just created to create the Lambda function. 5. Assign the CloudWatchLambdaInsightsExecutionRolePolicy IAM policy to the function's execution role. Update the Lambda Insights extension version on a function As a best practice, we recommend that you keep your Lambda Insights extension updated to the latest version. The topics in this page explain how to do so. Note This page explains how to update the extension version used by a function that is already using Lambda Insights. For information about how to get started with Lambda Insights, see Get started with Lambda Insights. Use the Lambda console to update the Lambda Insights extension version Use the following steps to use the Lambda console to update the Lambda Insights extension version. To update using the Lambda console 1. Open the AWS Lambda console at https://console.aws.amazon.com/lambda/. 2. Choose the name of your function. 3. 4. In the Layers section, choose Edit. In the list of layers, search for LambdaInsightsExtension and then change the layer version to the latest version listed in Available versions of the Lambda Insights extension. 5. Choose Save. Use the AWS CLI to update the Lambda Insights extension version To use the AWS CLI to update the Lambda Insights extension version, enter the following command. Replace the ARN value for the layers parameter with the ARN matching your Region and the extension version that you want to use. For information about the latest release version of the Lambda Insights extension layer, see Available versions of the Lambda Insights extension. aws lambda update-function-configuration \ Get started with Lambda Insights 952 Amazon CloudWatch User Guide --function-name function-name \ --layers "arn:aws:lambda:us-west-1:111122223333:layer:LambdaInsightsExtension:53" Use the AWS SAM CLI to update
acw-ug-281	acw-ug.pdf	281	5. Choose Save. Use the AWS CLI to update the Lambda Insights extension version To use the AWS CLI to update the Lambda Insights extension version, enter the following command. Replace the ARN value for the layers parameter with the ARN matching your Region and the extension version that you want to use. For information about the latest release version of the Lambda Insights extension layer, see Available versions of the Lambda Insights extension. aws lambda update-function-configuration \ Get started with Lambda Insights 952 Amazon CloudWatch User Guide --function-name function-name \ --layers "arn:aws:lambda:us-west-1:111122223333:layer:LambdaInsightsExtension:53" Use the AWS SAM CLI to update the Lambda Insights extension on one or more functions To update the Lambda Insights Extension version for all of your Lambda functions, update the Layers property in the Globals section of your AWS Serverless Application Model (SAM) template with the ARN of the Lambda Insights layer. For information about the latest release version of the Lambda Insights extension layer, see Available versions of the Lambda Insights extension. The following updates all of your Lambda functions. Globals: Function: Layers: - !Sub "arn:aws:lambda: ${AWS::Region}:111122223333:layer:LambdaInsightsExtension:53" The following updates just one function. Resources: MyFunction: Type: AWS::Serverless::Function Properties: Layers: - !Sub "arn:aws:lambda: ${AWS::Region}:111122223333:layer:LambdaInsightsExtension:53" Use AWS CloudFormation to update the Lambda Insights extension on one or more functions To update the Lambda Insights Extension version by using AWS CloudFormation, update the extension layer in the Layers property within the function's AWS CloudFormation resource, as in the following example. For information about the latest release version of the Lambda Insights extension layer, see Available versions of the Lambda Insights extension. Resources: MyFunction: Type: AWS::Lambda::Function Properties: Layers: Get started with Lambda Insights 953 Amazon CloudWatch User Guide - !Sub "arn:aws:lambda: ${AWS::Region}:111122223333:layer:LambdaInsightsExtension:53" Use the AWS CDK to update the Lambda Insights extension on one or more functions You can update the extension version on the Lambda function by replacing the ARN value for the layerArn parameter with the ARN matching your Region and the extension version that you want to use. For information about the latest release version of the Lambda Insights extension layer, see Available versions of the Lambda Insights extension. import lambda = require('@aws-cdk/aws-lambda'); const layerArn = 'arn:aws:lambda:us- west-1:111122223333:layer:LambdaInsightsExtension:53'; const layer = lambda.LayerVersion.fromLayerVersionArn(this, 'LayerFromArn', layerArn); Use Serverless Framework to update the Lambda Insights extension on one or more functions Follow these steps to use Serverless Framework to update the Lambda Insights extension version on an existing Lambda function. For more information about Serverless Framework, see the Serverless Framework documentation. This method uses a Lambda Insights plugin for Serverless. For more information, see serverless- plugin-lambda-insights. If you don't already have the latest version of the Serverless command-line interface installed, you must ﬁrst install it or upgrade it. For more information, see Setting Up Serverless Framework With AWS. To update using the Lambda console 1. Update Lambda Insights. If you haven't already done so, add a custom section at the end of the ﬁle and specify the Lambda Insights version inside a lambdaInsightsVersion property. custom: lambdaInsights: lambdaInsightsVersion: 53 #specify the Layer Version 2. Re-deploy the Serverless service by entering the following command. serverless deploy Get started with Lambda Insights 954 Amazon CloudWatch User Guide Update the Lambda Insights extension version on a Lambda container image deployment To update Lambda Insights on a Lambda container image, follow the steps in Enable Lambda Insights on a Lambda container image deployment to rebuild the image with the latest version of Lambda Insights. Then, use the AWS CLI to update the function code and provide a container image URI as the value for the --image-uri parameter. Viewing your Lambda Insights metrics After you have installed the Lambda Insights extension on a Lambda function that has been invoked, you can use the CloudWatch console to see your metrics. You can see a multi-function overview, or focus on a single function. For a list of Lambda Insights metrics, see Metrics collected by Lambda Insights. To view the multi-function overview for your Lambda Insights metrics 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. In the left navigation pane, choose Insights, Lambda Insights. 3. Choose Multi-function. The top part of the page displays graphs with aggregated metrics of all your Lambda functions in the Region that have Lambda Insights enabled. Lower on the page is a table that lists the functions. 4. To ﬁlter by function name to reduce the number of functions displayed, type part of the function name in the box near the top of the page. 5. To add this view to a dashboard as a widget, choose Add to dashboard. To view metrics for a single function 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. In the left navigation pane, choose Insights, Lambda Insights. 3. Choose Single function. The top part of the page displays graphs with metrics for the selected function. 4.
acw-ug-282	acw-ug.pdf	282	Lambda Insights enabled. Lower on the page is a table that lists the functions. 4. To ﬁlter by function name to reduce the number of functions displayed, type part of the function name in the box near the top of the page. 5. To add this view to a dashboard as a widget, choose Add to dashboard. To view metrics for a single function 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. In the left navigation pane, choose Insights, Lambda Insights. 3. Choose Single function. The top part of the page displays graphs with metrics for the selected function. 4. If you have X-Ray enabled, you can choose a single trace ID. This opens the X-Ray Trace Map page for that invocation, and from there you can zoom out to see the distributed trace and the Viewing your Lambda Insights metrics 955 Amazon CloudWatch User Guide other services involved in handling that speciﬁc transaction. For more information about the X-Ray Trace Map, see Using the X-Ray Trace Map. 5. To open CloudWatch Logs Insights and zoom in on a speciﬁc error, choose View logs by the table at the bottom of the page. 6. To add this view to a dashboard as a widget, choose Add to dashboard. Integration with Application Insights Amazon CloudWatch Application Insights helps you monitor your applications and identiﬁes and sets up key metrics, logs, and alarms across your application resources and technology stack. For more information, see Detect common application problems with CloudWatch Application Insights. You can enable Application Insights to gather additional data from your Lambda functions. If you haven't done this already, you can enable it by choosing Auto-conﬁgure Application Insights in the Application Insights tab below the performance view in the Lambda Insights dashboard. If you have already set up CloudWatch Application Insights to monitor your Lambda functions, the Application Insights dashboard appears below the Lambda Insights dashboard, in the Application Insights tab. Metrics collected by Lambda Insights Lambda Insights collects several metrics from the Lambda functions where it is installed. Some of these metrics are available as time series aggregated data in CloudWatch Metrics. Other metrics are not aggregated into time series data but can be found in the embedded metric format log entries by using CloudWatch Logs Insights. The following metrics are available as time series aggregated data in CloudWatch Metrics in the LambdaInsights namespace. Metric name Dimensions Description cpu_total_time function_name function_name, version Sum of cpu_syste m_time and cpu_user_time . Unit: Milliseconds Integration with Application Insights 956 Amazon CloudWatch User Guide Metric name Dimensions Description init_duration function_name function_name, version memory_ut ilization function_name function_name, version rx_bytes function_name function_name, version tmp_used tx_bytes function_name function_name, version The amount of time spent in the init phase of the Lambda execution environme nt lifecycle. Unit: Milliseconds The maximum memory measured as a percentage of the memory allocated to the function. Unit: Percent The number of bytes received by the function. Unit: Bytes The amount of space used in the /tmp directory. Unit: Bytes The number of bytes sent by the function. Unit: Bytes Metrics collected by Lambda Insights 957 Amazon CloudWatch User Guide Metric name Dimensions total_memory function_name function_name, version total_network function_name function_name, version used_memory_max function_name function_name, version Description The amount of memory allocated to your Lambda function. This is the same as your function’s memory size. Unit: Megabytes Sum of rx_bytes and tx_bytes. Even for functions that don't perform I/ O tasks, this value is usually greater than zero because of network calls made by the Lambda runtime. Unit: Bytes The measured memory of the function sandbox. Unit: Megabytes The following metrics can be found in the embedded metric format log entries by using CloudWatch Logs Insights. For more information about CloudWatch Logs Insights, see Analyzing Log Data with CloudWatch Logs Insights. For more information about embedded metric format, see Embedding metrics within logs. Metrics collected by Lambda Insights 958 Amazon CloudWatch User Guide Metric name Description cpu_system_time The amount of time the CPU spent executing kernel code. Unit: Milliseconds cpu_total_time Sum of cpu_system_time and cpu_user_ time . Unit: Milliseconds cpu_user_time The amount of time the CPU spent executing user code. fd_max fd_use Unit: Milliseconds The maximum number of ﬁle descriptors available. Unit: Count The maximum number of ﬁle descriptors in use. Unit: Count memory_ut ilization The maximum memory measured as a percentage of the memory allocated to the function. Unit: Percent rx_bytes The number of bytes received by the function. Unit: Bytes tx_bytes The number of bytes sent by the function. Unit: Bytes Metrics collected by Lambda Insights 959 Amazon CloudWatch User Guide Metric name Description threads_max The number of threads in use by the function process. As a function author, you don't control the initial number of threads created by the runtime. Unit: Count tmp_max The amount of space available in the
acw-ug-283	acw-ug.pdf	283	The maximum number of ﬁle descriptors in use. Unit: Count memory_ut ilization The maximum memory measured as a percentage of the memory allocated to the function. Unit: Percent rx_bytes The number of bytes received by the function. Unit: Bytes tx_bytes The number of bytes sent by the function. Unit: Bytes Metrics collected by Lambda Insights 959 Amazon CloudWatch User Guide Metric name Description threads_max The number of threads in use by the function process. As a function author, you don't control the initial number of threads created by the runtime. Unit: Count tmp_max The amount of space available in the /tmp directory. Unit: Bytes total_memory The amount of memory allocated to your Lambda function. This is the same as your function’s memory size. total_network Unit: Megabytes Sum of rx_bytes and tx_bytes. Even for functions that don't perform I/O tasks, this value is usually greater than zero because of network calls made by the Lambda runtime. Unit: Bytes used_memory_max The measured memory of the function sandbox. Unit: Bytes Troubleshooting and known issues for CloudWatch Lambda Insights The ﬁrst step to troubleshooting any issues is to enable debug logging on the Lambda Insights extension. To do this, set the following environment variable on your Lambda function: LAMBDA_INSIGHTS_LOG_LEVEL=info. For more information, see Using AWS Lambda environment variables. Troubleshooting and known issues 960 Amazon CloudWatch User Guide The extension emits logs into the same log group as your function (/aws/lambda/function- name). Review those logs to see if the error might be related to a setup issue. I don't see any metrics from Lambda Insights If you don't see Lambda Insights metrics that you expect to see, check the following possibilities: • The metrics might just be delayed— If the function has not yet been invoked or the data has not been ﬂushed yet, you won't see the metrics in CloudWatch. For more information, see Known Issues later in this section. • Conﬁrm that the Lambda function has the correct permissions—Make sure that the CloudWatchLambdaInsightsExecutionRolePolicy IAM policy is assigned to the function's execution role. • Check the Lambda runtime—Lambda Insights supports only certain Lambda runtimes. For a list of supported runtimes, see Lambda Insights. For example, to use Lambda Insights on Java 8, you must use the java8.al2 runtime, not the java8 runtime. • Check network access—The Lambda function might be on a VPC private subnet with no internet access and you don't have a VPC endpoint conﬁgured for CloudWatch Logs. To help debug this issue, you can set the environment variable LAMBDA_INSIGHTS_LOG_LEVEL=info. Known issues Data delay can be as high as 20 minutes. When a function handler completes, Lambda freezes the sandbox, which also freezes the Lambda Insights extension. While the function is running, we use an adaptive batching strategy based on the function TPS to output data. However, if the function stops being invoked for an extended period and there is still event data in the buﬀer, this data can be delayed until Lambda shuts down the idle sandbox. When Lambda shuts down the sandbox, we ﬂush the buﬀered data. Example telemetry event in CloudWatch Lambda Insights Each invocation of a Lambda function that has Lambda Insights enabled writes a single log event to the /aws/lambda-insights log group. Each log event contains metrics in embedded metric format. For more information about embedded metric format, see Embedding metrics within logs. To analyze these log events, you can use the following methods: Example telemetry event 961 Amazon CloudWatch User Guide • The Lambda Insights section of the CloudWatch console, as explained in Viewing your Lambda Insights metrics. • Log event queries using CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights. • Metrics collected in the LambdaInsights namespace, which you graph by using CloudWatch metrics. The following is an example of a Lambda Insights log event with embedded metric format. { "_aws": { "Timestamp": 1605034324256, "CloudWatchMetrics": [ { "Namespace": "LambdaInsights", "Dimensions": [ [ "function_name" ], [ "function_name", "version" ] ], "Metrics": [ { "Name": "memory_utilization", "Unit": "Percent" }, { "Name": "total_memory", "Unit": "Megabytes" }, { "Name": "used_memory_max", "Unit": "Megabytes" }, { "Name": "cpu_total_time", "Unit": "Milliseconds" }, { "Name": "tx_bytes", "Unit": "Bytes" }, { "Name": "rx_bytes", "Unit": "Bytes" }, { "Name": "total_network", "Unit": "Bytes" }, { "Name": "init_duration", "Unit": "Milliseconds" } ] } ], "LambdaInsights": { "ShareTelemetry": true } }, "event_type": "performance", "function_name": "cpu-intensive", "version": "Blue", "request_id": "12345678-8bcc-42f7-b1de-123456789012", "trace_id": "1-5faae118-12345678901234567890", "duration": 45191, Example telemetry event 962 Amazon CloudWatch User Guide "billed_duration": 45200, "billed_mb_ms": 11571200, "cold_start": true, "init_duration": 130, "tmp_free": 538329088, "tmp_max": 551346176, "threads_max": 11, "used_memory_max": 63, "total_memory": 256, "memory_utilization": 24, "cpu_user_time": 6640, "cpu_system_time": 50, "cpu_total_time": 6690, "fd_use": 416, "fd_max": 32642, "tx_bytes": 4434, "rx_bytes": 6911, "timeout": true, "shutdown_reason": "Timeout", "total_network": 11345, "agent_version": "1.0.72.0", "agent_memory_avg": 10, "agent_memory_max": 10 } Example telemetry event 963 Amazon CloudWatch User Guide CloudWatch Database Insights Use CloudWatch Database
acw-ug-284	acw-ug.pdf	284	"total_network", "Unit": "Bytes" }, { "Name": "init_duration", "Unit": "Milliseconds" } ] } ], "LambdaInsights": { "ShareTelemetry": true } }, "event_type": "performance", "function_name": "cpu-intensive", "version": "Blue", "request_id": "12345678-8bcc-42f7-b1de-123456789012", "trace_id": "1-5faae118-12345678901234567890", "duration": 45191, Example telemetry event 962 Amazon CloudWatch User Guide "billed_duration": 45200, "billed_mb_ms": 11571200, "cold_start": true, "init_duration": 130, "tmp_free": 538329088, "tmp_max": 551346176, "threads_max": 11, "used_memory_max": 63, "total_memory": 256, "memory_utilization": 24, "cpu_user_time": 6640, "cpu_system_time": 50, "cpu_total_time": 6690, "fd_use": 416, "fd_max": 32642, "tx_bytes": 4434, "rx_bytes": 6911, "timeout": true, "shutdown_reason": "Timeout", "total_network": 11345, "agent_version": "1.0.72.0", "agent_memory_avg": 10, "agent_memory_max": 10 } Example telemetry event 963 Amazon CloudWatch User Guide CloudWatch Database Insights Use CloudWatch Database Insights to monitor and troubleshoot Amazon Aurora MySQL, Amazon Aurora PostgreSQL, Amazon RDS for SQL Server, RDS for MySQL, RDS for PostgreSQL, RDS for Oracle, and RDS for MariaDB databases at scale. With Database Insights, you can monitor your database ﬂeet with pre-built, opinionated dashboards. To help you analyze the performance of your ﬂeet, the Database Insights dashboards display curated metrics and visualizations, and you can customize these dashboards. By presenting metrics in a single dashboard for all databases in your ﬂeet, Database Insights allows you to monitor your databases simultaneously. For example, you can use Database Insights to ﬁnd a database that is performing poorly within a ﬂeet of hundreds of database instances. You can then choose that instance and use Database Insights to troubleshoot issues. For information about engine, AWS Region, and instance class support, see Aurora DB engine, Region, and instance class support for Database Insights and Amazon RDS DB engine, Region, and instance class support for Database Insights. Database Insights supports monitoring workloads only within the same AWS account. To get started with Database Insights, see the following topics. Topics • Get started with CloudWatch Database Insights • Viewing the Fleet Health Dashboard for CloudWatch Database Insights • Viewing the Database Instance Dashboard for CloudWatch Database Insights • Troubleshooting for CloudWatch Database Insights Modes for Database Insights Database Insights has an Advanced mode and a Standard mode. Standard mode is the default for Database Insights, and you can turn on the Advanced mode for your database. The following table shows which features CloudWatch supports for the Advanced mode and Standard mode of Database Insights. Database Insights 964 Amazon CloudWatch Feature User Guide Standard mode Advanced mode Analyze the top contributors to DB Load by dimension Supported Supported Query, graph, and set alarms on database metrics with up to 7 days of retention Deﬁne ﬁne‐grained access control policies to restrict access to potentially sensitive dimensions such as SQL text Analyze operating system processes happening in your databases with detailed metrics per running process You must have Amazon RDS Enhanced Monitoring enabled to use this feature. Supported Supported Supported Supported Not supported Supported Create and save ﬂeet‐wide monitoring views to assess health across hundreds of databases Not supported Supported Analyze SQL locks with 15 months of retention and a guided UX Not supported Analyze SQL execution plans with 15 months of retention and guided UX Not supported Supported only for Aurora PostgreSQL Supported only for Aurora PostgreSQL, RDS for Oracle, and RDS for SQL Server Visualize per‐query statistics Not supported Supported Analyze slow SQL queries Not supported Supported View calling services with CloudWatch Application Signals Not supported Supported Modes 965 Amazon CloudWatch Feature View a consolidated dashboard for all database telemetry, including metrics, logs, events, and applications User Guide Standard mode Advanced mode Not supported Supported Import Performance Insights counter metrics into CloudWatch automatically Not supported Supported View Amazon RDS events in CloudWatch Not supported Supported Analyze database performance for a time period of your choice with on‐demand analysis Not supported Supported only for Aurora PostgreSQL, Aurora MySQL, RDS for PostgreSQL, RDS for MySQL, and RDS for MariaDB Note Database Insights feature availability diﬀers in diﬀerent AWS Regions, because not all Advanced Mode features are available in all Regions. Data retention The Advanced mode of Database Insights retains 15 months of metrics collected by Performance Insights. If Performance Insights is enabled for the Standard mode, Amazon RDS retains 7 days of Performance Insights counter metrics. For information about counter metrics for Performance Insights, see Performance Insights counter metrics. For information about the retention period for CloudWatch metrics collected by Database Insights, see the following topics. • Amazon CloudWatch metrics for Amazon Aurora in the Amazon Aurora User Guide Data retention 966 Amazon CloudWatch User Guide • Amazon CloudWatch metrics for Amazon Relational Database Service in the Amazon RDS User Guide • Amazon CloudWatch metrics for Amazon RDS Performance Insights in the Amazon Aurora User Guide • Amazon CloudWatch metrics for Amazon RDS Performance Insights in the Amazon Aurora User Guide How Database Insights integrates with Performance Insights Performance Insights is a database performance monitoring service. Database Insights builds upon and extends the capabilities of Performance Insights. Database Insights
acw-ug-285	acw-ug.pdf	285	by Database Insights, see the following topics. • Amazon CloudWatch metrics for Amazon Aurora in the Amazon Aurora User Guide Data retention 966 Amazon CloudWatch User Guide • Amazon CloudWatch metrics for Amazon Relational Database Service in the Amazon RDS User Guide • Amazon CloudWatch metrics for Amazon RDS Performance Insights in the Amazon Aurora User Guide • Amazon CloudWatch metrics for Amazon RDS Performance Insights in the Amazon Aurora User Guide How Database Insights integrates with Performance Insights Performance Insights is a database performance monitoring service. Database Insights builds upon and extends the capabilities of Performance Insights. Database Insights adds monitoring, analysis, and optimization features. To enable the Advanced mode of Database Insights, you must enable Performance Insights. Database Insights imports Performance Insights counter metrics into CloudWatch automatically. The Advanced mode of Database Insights automatically retains 15 months of all metrics collected by Database Insights, including Performance Insights metrics and CloudWatch metrics. This automatically happens for you when you enable Advanced mode in an instance, with no further conﬁguration needed. For information about Performance Insights counter metrics, see Performance Insights counter metrics in the Amazon Aurora User Guide. Pricing For information about pricing, see Amazon CloudWatch Pricing. Get started with CloudWatch Database Insights The Standard mode of Database Insights is enabled by default for your Amazon RDS and Aurora databases. To get started with the Advanced mode of Database Insights, you can create a new database or modify a database. For information about enabling the Advanced mode or the Standard mode of Database Insights for an Amazon RDS database, see the following topics. • Turning on the Advanced mode of Database Insights for Amazon RDS in the Amazon RDS User Guide Performance Insights 967 Amazon CloudWatch User Guide • Turning on the Standard mode of Database Insights for Amazon RDS in the Amazon RDS User Guide • Turning CloudWatch Database Insights on or oﬀ when creating a DB instance or Multi-AZ DB cluster for Amazon RDS in the Amazon RDS User Guide For information about enabling the Advanced mode or the Standard mode of Database Insights for an Amazon Aurora database, see the following topics. • Turning on the Advanced mode of Database Insights for Amazon Aurora in the Amazon Aurora User Guide • Turning on the Standard mode of Database Insights for Amazon Aurora in the Amazon Aurora User Guide Required permissions for Database Insights Certain IAM permissions are required to use Database Insights. Database Insights requires permissions for CloudWatch, CloudWatch Logs, Amazon RDS, and Amazon RDS Performance Insights. You might not need to provide these permissions to your user or role if you have broader permissions. The following CloudWatch permissions are required to use Database Insights. • cloudwatch:BatchGetServiceLevelIndicatorReport • cloudwatch:DescribeAlarms • cloudwatch:GetDashboard • cloudwatch:GetMetricData • cloudwatch:ListMetrics • cloudwatch:PutDashboard The following CloudWatch Logs permissions are required to use Database Insights. • logs:DescribeLogGroups • logs:GetQueryResults • logs:StartQuery • logs:StopQuery Get started 968 Amazon CloudWatch User Guide The following Amazon RDS permissions are required to use Database Insights. • rds:DescribeDBClusters • rds:DescribeDBInstances • rds:DescribeEvents The following Performance Insights permissions are required to use Database Insights. • pi:ListAvailableResourceMetrics • pi:ListAvailableResourceDimensions • pi:DescribeDimensionKeys • pi:GetDimensionKeyDetails • pi:GetResourceMetrics • pi:ListPerformanceAnalysisReports • pi:GetResourceMetadata • pi:GetPerformanceAnalysisReport • pi:CreatePerformanceAnalysisReport • pi:DeletePerformanceAnalysisReport • pi:ListTagsForResource • pi:TagResource • pi:UntagResource The following sample policy contains the permissions required for full access to Database Insights. Sample policy for full access { "Version": "2012-10-17", "Statement": [{ "Effect" : "Allow", "Action" : [ "cloudwatch:BatchGetServiceLevelIndicatorReport", "cloudwatch:DescribeAlarms", "cloudwatch:GetMetricStatistics", "cloudwatch:GetMetricData", "cloudwatch:ListMetrics", Get started 969 Amazon CloudWatch User Guide "cloudwatch:PutDashboard" ], "Resource" : "" }, { "Effect" : "Allow", "Action" : [ "logs:DescribeLogGroups", "logs:GetQueryResults", "logs:StartQuery", "logs:StopQuery" ], "Resource" : "" }, { "Effect" : "Allow", "Action" : [ "pi:DescribeDimensionKeys", "pi:GetDimensionKeyDetails", "pi:GetResourceMetadata", "pi:GetResourceMetrics", "pi:ListAvailableResourceDimensions", "pi:ListAvailableResourceMetrics", "pi:CreatePerformanceAnalysisReport", "pi:GetPerformanceAnalysisReport", "pi:ListPerformanceAnalysisReports", "pi:DeletePerformanceAnalysisReport", "pi:TagResource", "pi:UntagResource", "pi:ListTagsForResource" ], "Resource" : "arn:aws:pi:::/rds/" }, { "Effect" : "Allow", "Action" : [ "rds:DescribeDBInstances", "rds:DescribeDBClusters", "rds:DescribeEvents" ], "Resource" : "*" } ] Get started 970 Amazon CloudWatch } User Guide Viewing the Fleet Health Dashboard for CloudWatch Database Insights You can use the Fleet Health Dashboard to view a snapshot of the health of your database ﬂeet. Fleet health views A database ﬂeet in Database Insights is a group of databases that you want to monitor. You can create a monitoring view for a database ﬂeet by choosing ﬁlters in the Filters component. This component allows you to apply ﬁlters on properties, such as cluster or instance names and tags. In the Fleet Health Dashboard, CloudWatch shows databases that match at least one of the ﬁlter conditions for the ﬂeet health view. To create, modify, or delete views for database ﬂeets, use the procedures in the following topics. • Create a ﬂeet health view for CloudWatch Database Insights • Edit a ﬂeet health view for CloudWatch Database Insights • Delete a ﬂeet health view for CloudWatch
acw-ug-286	acw-ug.pdf	286	You can create a monitoring view for a database ﬂeet by choosing ﬁlters in the Filters component. This component allows you to apply ﬁlters on properties, such as cluster or instance names and tags. In the Fleet Health Dashboard, CloudWatch shows databases that match at least one of the ﬁlter conditions for the ﬂeet health view. To create, modify, or delete views for database ﬂeets, use the procedures in the following topics. • Create a ﬂeet health view for CloudWatch Database Insights • Edit a ﬂeet health view for CloudWatch Database Insights • Delete a ﬂeet health view for CloudWatch Database Insights RDS instances overview table Use the RDS instances overview table to view the alarm state, max DB Load percentage, and the time of the last state update for each instance in your ﬂeet. Viewing the Fleet Health Dashboard 971 Amazon CloudWatch User Guide Instances state summary Use the Instances state summary to view the health of all instances in your ﬂeet. The Instances state summary provides two views based on Alarms and the DB Load metric. By default, CloudWatch displays the Alarms view. Viewing the Fleet Health Dashboard 972 Amazon CloudWatch User Guide Each node in the honeycomb represents an instance. For more information about an instance, you can choose the corresponding node and choose Filter view by this instance. The honeycomb component summarizes the alarm state for instances in your ﬂeet with the number of nodes in each state at the top of the honeycomb. CloudWatch displays the time of the last refresh of the data shown in the honeycomb. When you switch to the DB Load view, you can see the overall health of the ﬂeet from the point of view of the DB Load metric. Database load (DB Load) measures the number of active sessions in your database. DB Load is the key metric in Database Insights and is collected every second. CloudWatch categorizes DB instances into the following states based on thresholds for DB Load. • High • Warning • Ok • Idle Viewing the Fleet Health Dashboard 973 Amazon CloudWatch User Guide You can see the thresholds for DB Load by choosing the corresponding state icons. For information about DB Load for Amazon RDS, see Database load in the Amazon RDS User Guide. For information about DB Load for Amazon Aurora, see Database load in the Amazon Aurora User Guide. By default, CloudWatch displays the average DB Load. Choose Max to monitor the maximum DB Load for each instance. Choose a node from the Instances state summary to display alarms and DB Load for the instance. Top 10 charts Use the Top 10 instances per relative DB Load chart to view the DB Load trend over time for the 10 instances with the highest DB Load. The chart also provides the top queries and top wait events for the instance with the highest DB Load. Use the Top 10 instances per metric charts to compare two key metrics for the top 10 instances in your ﬂeet. You can select the following metrics. • CPU Utilization (%) • Freeable Memory (%) • DB Connections (%) • Network throughput • Read IOPS • Write IOPS Viewing the Fleet Health Dashboard 974 Amazon CloudWatch • Read Latency • Write Latency User Guide Amazon RDS events Use the Events summary and table to view RDS events for instances in your ﬂeet. To view the Events table, choose Details. Viewing the Fleet Health Dashboard 975 Amazon CloudWatch User Guide For a list of events for Amazon RDS and Amazon Aurora, see the following topics. • Amazon RDS event categories and event messages for Aurora in the Amazon Aurora User Guide • Amazon RDS event categories and event messages in the Amazon RDS User Guide Calling services table Use the Calling services table to view CloudWatch Application Signals services that are calling your database endpoints and related application-level metrics such as latency or errors. Viewing the Fleet Health Dashboard 976 Amazon CloudWatch User Guide Database Insights shows the services that are calling your top 10 instances by DB Load. To view calling services for another instance, choose the instance in the database instance dashboard. When the endpoint called by the application is an Aurora cluster, Database Insights will display either the writer or the reader endpoint for the Aurora cluster in the Calling services table, not the individual database instance. However, when the endpoint called by the application is an Amazon RDS cluster, Database Insights shows the speciﬁc database instance the application is calling within the Amazon RDS cluster. For more information about CloudWatch Application Signals, see Application Signals. Create a ﬂeet health view for CloudWatch Database Insights To create a ﬂeet health view, use the following procedure. To create a ﬂeet health view 1. Sign in to the
acw-ug-287	acw-ug.pdf	287	the application is an Aurora cluster, Database Insights will display either the writer or the reader endpoint for the Aurora cluster in the Calling services table, not the individual database instance. However, when the endpoint called by the application is an Amazon RDS cluster, Database Insights shows the speciﬁc database instance the application is calling within the Amazon RDS cluster. For more information about CloudWatch Application Signals, see Application Signals. Create a ﬂeet health view for CloudWatch Database Insights To create a ﬂeet health view, use the following procedure. To create a ﬂeet health view 1. Sign in to the AWS Management Console and open the CloudWatch console at https:// console.aws.amazon.com/cloudwatch/. 2. Choose Insights. 3. Choose Database Insights. 4. Choose ﬁlters for the ﬂeet of databases you want to monitor. 5. Choose Save ﬁlter as ﬂeet. 6. In the Save ﬁlter set (ﬂeet) window, enter a name for your ﬂeet. 7. Choose the Save button. To access the saved ﬂeet, choose the Saved ﬂeets dropdown. Then, choose a ﬂeet. Viewing the Fleet Health Dashboard 977 Amazon CloudWatch User Guide Edit a ﬂeet health view for CloudWatch Database Insights To edit a ﬂeet health view, use the following procedure. To edit a ﬂeet health view 1. Sign in to the AWS Management Console and open the CloudWatch console at https:// console.aws.amazon.com/cloudwatch/. 2. Choose Insights. 3. Choose Database Insights. 4. Choose the Saved ﬂeets dropdown. 5. Choose the vertical ellipsis for a ﬂeet health view you want to edit. 6. In the Edit ﬁlter set (ﬂeet) window, you can edit the name of the ﬂeet and the ﬁlters for the ﬂeet. 7. Choose the Save button. Delete a ﬂeet health view for CloudWatch Database Insights To delete a ﬂeet health view, use the following procedure. To delete a ﬂeet health view 1. Sign in to the AWS Management Console and open the CloudWatch console at https:// console.aws.amazon.com/cloudwatch/. 2. Choose Insights. 3. Choose Database Insights. 4. Choose the Saved ﬂeets dropdown. 5. Choose the vertical ellipsis for a ﬂeet health view you want to delete. 6. In the Delete ﬁlter set (ﬂeet) window, choose the Delete button. Viewing the Database Instance Dashboard for CloudWatch Database Insights Use the Database Instance Dashboard to view a snapshot of the health of a DB instance. Viewing the Database Instance Dashboard 978 Amazon CloudWatch User Guide To analyze lock trees and execution plans for Amazon Aurora PostgreSQL, see the following topics. Topics • Analyzing lock trees for Amazon Aurora PostgreSQL with CloudWatch Database Insights • Analyzing execution plans with CloudWatch Database Insights Database load chart Database load (DB Load) measures the level of session activity in your database. DB Load is the key metric in Database Insights, and Database Insights collects DB Load every second. For more information about DB Load, see Database load in the Amazon RDS User Guide or Database load in the Amazon Aurora User Guide. Use the Database load chart to view DB Load sliced (grouped) by the following dimensions for all supported database engines. • Blocking object (only for database engines that support locking analysis) • Blocking session (only for database engines that support locking analysis) • Blocking SQL (only for database engines that support locking analysis) • Database • Host • SQL • User • Waits • Application (only for Amazon Aurora PostgreSQL) • Plans (only for database engines that support execution plan capture) • Session type (only for Amazon Aurora PostgreSQL) Note For information about analyzing Oracle PDB load in Amazon RDS, see Analyzing top Oracle PDB load in the Amazon RDS User Guide. Viewing the Database Instance Dashboard 979 Amazon CloudWatch User Guide By default, CloudWatch displays DB Load with a bar chart. Choose Line to display DB Load with a stacked line chart. DB Load analysis tab Use the DB Load analysis tab to monitor the top contributors to DB Load for each of the following dimensions. • Database • Host • SQL • User Viewing the Database Instance Dashboard 980 Amazon CloudWatch • Waits • Lock analysis (only for database engines that support locking analysis) • Application (only for Amazon Aurora PostgreSQL) • Session type (only for Amazon Aurora PostgreSQL) User Guide Analyze statistics for a query You might want to analyze statistics for a query with a high DB Load. To analyze statistics for a query, use the following procedure. To analyze statistics for queries 1. Sign in to the AWS Management Console and open the CloudWatch console at https:// console.aws.amazon.com/cloudwatch/. 2. Choose Insights. 3. Choose Database Insights. 4. Choose the Database Instance view. 5. Choose a DB instance. 6. Choose the Top SQL tab. 7. To view statistics for a query, choose a query. Viewing the Database Instance Dashboard 981 Amazon CloudWatch Database telemetry tab User Guide Use the Database telemetry tab to view metrics,
acw-ug-288	acw-ug.pdf	288	You might want to analyze statistics for a query with a high DB Load. To analyze statistics for a query, use the following procedure. To analyze statistics for queries 1. Sign in to the AWS Management Console and open the CloudWatch console at https:// console.aws.amazon.com/cloudwatch/. 2. Choose Insights. 3. Choose Database Insights. 4. Choose the Database Instance view. 5. Choose a DB instance. 6. Choose the Top SQL tab. 7. To view statistics for a query, choose a query. Viewing the Database Instance Dashboard 981 Amazon CloudWatch Database telemetry tab User Guide Use the Database telemetry tab to view metrics, logs, events, and slow queries for the selected instance. Metrics section for database telemetry The Metrics section displays a default metrics dashboard customized for each engine type. You can customize this dashboard by adding OS metrics, database counter metrics, and CloudWatch metrics to it. You can also remove metrics from the dashboard. You can customize one dashboard for each engine type in a Region in your account. This means that all instances for a speciﬁc engine type in that Region in the same account will have the same metrics dashboard. Users who have edit permissions for your dashboards in your account can edit any dashboard for any engine. Changes you make to a dashboard are saved automatically, and apply to every instance of the database engine in that Region and account. To customize the dashboard in the Database telemetry tab for an engine type 1. Sign in to the AWS Management Console and open the CloudWatch console at https:// console.aws.amazon.com/cloudwatch/. 2. Choose Insights, Database Insights. 3. 4. For Database Views, choose Database Instance. In the Filters section, ﬁnd and choose the database instance that you want to view metrics for. 5. Choose the Database Telemetry tab, then choose the Metrics tab. The default database instance dashboard appears. 6. To add a widget to the dashboard, do the following: a. b. Choose Add Create widget. In the Create widget popup, ﬁnd the metric or metrics that you want to add, and select the checkbox for each one. If you select multiple metrics in this step, they will all appear in the same new widget on the dashboard. Then choose Create widget. Remember that any changes you make to this dashboard will apply to all Database Insights dashboards for this engine type in this Region in the account. Viewing the Database Instance Dashboard 982 Amazon CloudWatch User Guide 7. 8. To delete a graph from the dashboard, choose the vertical ellipsis in the widget, then choose Delete. To add more metrics to an existing widget in the dashboard, or change its title, choose the vertical ellipsis in the widget, and choose Edit. Then in the Update widget popup, ﬁnd the metric or metrics that you want to add, select their checkboxes, and choose Update Widget. You can also change the widget title. 9. After customizing a dashboard, you can reset it to its original default state by choosing Reset Dashboard. Logs section for database telemetry The Logs section provides a view of database logs exported to CloudWatch Logs for the selected DB instance. For information about publishing logs to CloudWatch Logs for Amazon RDS, see Publishing database logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. For information about publishing logs to CloudWatch Logs for Amazon Aurora, see Publishing database logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. Amazon RDS and OS processes data for database telemetry You can use the OS Processes tab within the Database telemetry tab to view metrics for the operating system (OS) that your DB instance runs on. The metrics provide a snapshot of OS Viewing the Database Instance Dashboard 983 Amazon CloudWatch User Guide processes running on your databases for a given timestamp, as well as key metrics such as memory and CPU utilization for each running process. Database Insights correlates these metrics with the metrics in your database load chart, so if you choose a data point in the database load chart, the OS processes data is updated to display telemetry from the same time stamp. When you choose a data point, Database Insights automatically select the period to display, depending on the time range you have chosen for the overall page. The farthest back that you can go depends on the retention time that you have conﬁgured for the RDSOSMetrics log group. If you haven't chosen a time stamp, by default the table is populated with telemetry for the latest timestamp. Note OS process information is available only if you have Amazon RDS Enhanced Monitoring enabled. Enhanced Monitoring incurs additional charges. For more information, see Cost of Enhanced Monitoring. In the OS processes view, the following data is displayed for each process: • Process ID –The ID of this
acw-ug-289	acw-ug.pdf	289	depending on the time range you have chosen for the overall page. The farthest back that you can go depends on the retention time that you have conﬁgured for the RDSOSMetrics log group. If you haven't chosen a time stamp, by default the table is populated with telemetry for the latest timestamp. Note OS process information is available only if you have Amazon RDS Enhanced Monitoring enabled. Enhanced Monitoring incurs additional charges. For more information, see Cost of Enhanced Monitoring. In the OS processes view, the following data is displayed for each process: • Process ID –The ID of this process. • Virtual memory –The amount of virtual memory allocated to the process, in Kibibytes. Viewing the Database Instance Dashboard 984 Amazon CloudWatch User Guide • Residual address – The actual physical memory being used by the process. • CPU % – The percentage of the total CPU bandwidth being used by the process. • Memory % – The percentage of the total memory being used by the process. • VM limit – The maximum amount of virtual memory that can be allocated to the process. If the value in this column is 0, then VM limits are not applicable to that process. The monitoring data that is displayed is retrieved from Amazon CloudWatch Logs. You can also retrieve these metrics directly from the log stream in CloudWatch Logs. For more information, see Viewing OS metrics using CloudWatch Logs. OS processes metrics are not returned during the following: • A failover of the database instance. • Changing the instance class of the database instance (scale compute). OS processes metrics are returned during a reboot of a database instance because only the database engine is rebooted. Metrics for the operating system are still reported. Slow SQL Queries section for database telemetry To view slow SQL queries and query patterns, you must enable log exports to CloudWatch Logs and conﬁgure DB parameters for your database. For information about publishing Amazon RDS logs to CloudWatch Logs, see Publishing database logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. For information about publishing Aurora logs to CloudWatch Logs, see Publishing database logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. For information about conﬁguring DB parameters for your database in Amazon RDS, see Conﬁguring your database to monitor slow SQL queries with Database Insights for Amazon RDS in the Amazon RDS User Guide. For information about conﬁguring DB parameters for your database in Amazon Aurora, see Conﬁguring your database to monitor slow SQL queries with Database Insights for Amazon Aurora in the Amazon Aurora User Guide. Viewing the Database Instance Dashboard 985 Amazon CloudWatch User Guide The Slow SQL Queries section provides a list of slow query patterns sorted by frequency. By selecting a pattern, you can view a list of slow queries that match the selected pattern. You can use the slow query list to identify slow queries aﬀecting your DB instance. Database Insights displays statistics for slow queries. The statistics represent only queries that exceed the conﬁgured slow query duration threshold. Important Slow queries may contain sensitive data. Mask your sensitive data with CloudWatch Logs. For more information about masking log data, see Help protect sensitive log data with masking in the Amazon CloudWatch Logs User Guide. Events table Use the Events table to view RDS events for your DB instance. For a list of events for Amazon Aurora, see Amazon RDS event categories and event messages for Aurora in the Amazon Aurora User Guide. For a list of events for Amazon Relational Database Service, see Amazon RDS event categories and event messages for Aurora in the Amazon RDS User Guide. Calling services tab Database Insights shows the services and operations that are calling your instance. Database Insights integrates with CloudWatch Application Signals to provide metrics for each service and operation, including availability, latency, errors, and volume. When the endpoint called by the application is an Aurora cluster, Database Insights will show either the writer or the reader endpoint for the Aurora cluster in the Calling services table, not the Viewing the Database Instance Dashboard 986 Amazon CloudWatch User Guide individual database instance. However, when the endpoint called by the application is an Amazon RDS cluster, Database Insights shows the speciﬁc database instance the application is calling within the Amazon RDS cluster." Analyze database performance on demand with CloudWatch Database Insights Analyze database performance with on-demand analyses for your Amazon RDS databases with CloudWatch Database Insights. Use the Performance analysis tab to view performance analysis reports for databases in your ﬂeet. For information about performance analysis reports for Amazon Aurora, see Analyzing database performance for a period of time in the Amazon Aurora User Guide. Note You must create performance analysis reports using the Amazon RDS console, AWS
acw-ug-290	acw-ug.pdf	290	by the application is an Amazon RDS cluster, Database Insights shows the speciﬁc database instance the application is calling within the Amazon RDS cluster." Analyze database performance on demand with CloudWatch Database Insights Analyze database performance with on-demand analyses for your Amazon RDS databases with CloudWatch Database Insights. Use the Performance analysis tab to view performance analysis reports for databases in your ﬂeet. For information about performance analysis reports for Amazon Aurora, see Analyzing database performance for a period of time in the Amazon Aurora User Guide. Note You must create performance analysis reports using the Amazon RDS console, AWS CLI, or API. For information about creating a performance analysis report for Amazon Aurora, see Creating a performance analysis report in Performance Insights in the Amazon Aurora User Guide. Integrating CloudWatch Database Insights with CloudWatch Application Signals Integrate CloudWatch Database Insights with CloudWatch Application Signals. Use the Calling services tab to view the CloudWatch Application Signals services and operations that called an endpoint of the selected instance. By default, CloudWatch sorts the table by Viewing the Database Instance Dashboard 987 Amazon CloudWatch User Guide fault rate. Choose values in the Services, Operations, or Endpoint address columns to view the corresponding resource in the CloudWatch Application Signals console. For more information about supported systems for CloudWatch Application Signals, see Supported systems. Viewing the Database Instance Dashboard 988 Amazon CloudWatch User Guide Analyzing lock trees for Amazon Aurora PostgreSQL with CloudWatch Database Insights To troubleshoot performance issues caused by locks, you can analyze lock trees for Amazon Aurora PostgreSQL databases with CloudWatch Database Insights using the following. • Sliced by dropdown – Choose the Blocking object, Blocking session, or Blocking SQL dimensions in the Database load chart to view how distinct top blockers contribute to DB Load over time. With the DB load chart, you can analyze if top blockers are constant or change often. Then, you can troubleshoot the blockers. • Lock analysis tab – Choose DB Load Analysis, then choose the Lock analysis tab to view information about lock contention in your database. Viewing the Database Instance Dashboard 989 Amazon CloudWatch User Guide Note CloudWatch Database Insights supports lock analysis for all Aurora PostgreSQL versions. To analyze lock trees, you must have Database Insights Advance Mode enabled. For information on how to turn on Advanced mode, see Turning on the Advanced mode of Database Insights for Amazon Aurora and Turning on the Advanced mode of Database Insights for Amazon Relational Database Service The lock analysis tab provides information about lock contention for your database. The lock tree visualization shows the relationships and dependencies between lock requests from diﬀerent sessions. Database Insights captures snapshots every 15 seconds. Snapshots show the lock data for your database at a point in time. Note When CloudWatch detects high locking, CloudWatch displays the High locking detected banner for the Lock analysis tab. CloudWatch detects high locking if CloudWatch takes a lock snapshot for each 15 second interval for 15 consecutive minutes. Viewing the Database Instance Dashboard 990 Amazon CloudWatch User Guide Each node in the tree represents a speciﬁc session. The parent node is a session that is blocking its child nodes. To analyze lock trees, use the following procedure. To analyze lock trees 1. Sign in to the AWS Management Console and open the CloudWatch console at https:// console.aws.amazon.com/cloudwatch/. 2. Choose Insights. 3. Choose Database Insights. 4. Choose the Database Instance view. 5. Choose a DB instance. 6. Choose the DB load analysis tab. 7. Choose the Lock analysis tab. To view lock data for a DB instance, choose a period of 1 day or less. 8. Choose a snapshot window. By default, Database Insights chooses the snapshot window with the most blocked sessions. 9. To view lock data for a snapshot, choose the time Database Insights took the snapshot. 10. To expand a lock tree, choose the arrow next to the session ID. Viewing the Database Instance Dashboard 991 Amazon CloudWatch User Guide Lock snapshot data Database Insights provides the following information for each lock request. To view columns that aren't enabled by default, choose the Settings icon for the Lock trees table and enable other columns. Column name Deﬁnition Notes Default column session_id The unique session identiﬁer. Yes The session_i d is derived from HEX(pg_st at_activi ty.backen d_start). HEX(pg_lo cks.pid) . pid The PID of this backend. blocked_s essions_c ount The number of sessions blocked by this lock. Yes Yes pg_locks.pid The blocked_s essions_count is derived from the number of session IDs blocked by this lock. Viewing the Database Instance Dashboard 992 Amazon CloudWatch User Guide Column name Deﬁnition Notes Default column last_quer y_execute The last query executed by this session. For blockers, it may not be the query that Yes pg_stat_a ctivity.query d holds the blocking lock. wait_event The wait event
acw-ug-291	acw-ug.pdf	291	session_id The unique session identiﬁer. Yes The session_i d is derived from HEX(pg_st at_activi ty.backen d_start). HEX(pg_lo cks.pid) . pid The PID of this backend. blocked_s essions_c ount The number of sessions blocked by this lock. Yes Yes pg_locks.pid The blocked_s essions_count is derived from the number of session IDs blocked by this lock. Viewing the Database Instance Dashboard 992 Amazon CloudWatch User Guide Column name Deﬁnition Notes Default column last_quer y_execute The last query executed by this session. For blockers, it may not be the query that Yes pg_stat_a ctivity.query d holds the blocking lock. wait_event The wait event name if the backend is currently waiting, otherwise the value is NULL. blocking_ time_(In Seconds) The time (in seconds) since the start of this lock. Yes pg_stat_a ctivity.w ait_event Yes The blocking_ time_(In Seconds) is derived from the start time of the waiting transacti on (pg_locks. waitstart ) for the ﬁrst waiter. blocking_ mode The lock mode held by the blocking session. No pg_locks.mode waiting_m ode The lock mode requested by the waiting session. No pg_locks.mode applicati on The name of the application that is connected to this backend. No pg_stat_a ctivity.a blocking_ txn_start _time waiting_s tart_time The start time of the blocking transaction or null if no transaction is active. No pplication_name pg_stat_a ctivity.x act_start The time when a waiting user session started waiting for this lock, or null if the lock is held. No pg_locks. waitstart Viewing the Database Instance Dashboard 993 Amazon CloudWatch User Guide Column name Deﬁnition Notes Default column session_s The time when a user session was started. No tart_time pg_stat_a ctivity.b ackend_start state The state of a backend. No pg_stat_a ctivity.state wait_even t_type The type of wait event for which this session is waiting. No pg_stat_a ctivity.w last_quer y_exec_ti me user host The time when the last query was started. No ait_event_type pg_stat_a ctivity.q uery_start The name of the user logged into this backend. No pg_stat_a ctivity.usename The host name of the connected client, as reported by a reverse DNS lookup of No pg_stat_a ctivity.c client_addr . This ﬁeld will only be non-null for IP connections, and only when log_hostname is enabled. port The TCP port number that the client is using for communication with this No backend, or -1 if a Unix socket is used. If this ﬁeld is null, it indicates that this is an internal server process. lient_hostname pg_stat_a ctivity.c lient_port Viewing the Database Instance Dashboard 994 Amazon CloudWatch User Guide Column name Deﬁnition Notes Default column client_ad dress The IP address of the client connected to this backend. If this ﬁeld is null, No it indicates either that the client is connected via a Unix socket on the server machine or that this is an internal process such as autovacuum. pg_stat_a ctivity.c lient_addr granted The value is true if lock is held and false if lock is awaited. No pg_locks.granted waiting_t uple The tuple number targeted by the lock within the page, or null if the target is not No pg_locks.tuple a tuple. waiting_p age The page number targeted by the lock within the relation, or null if the target is No pg_locks.page not a relation page or tuple. waiting_t ransactio The ID of the transaction targeted by the lock, or null if the target is not a transacti No pg_locks. transactionid n_id on ID. waiting_r elation The OID of the relation targeted by the lock, or null if the target is not a relation No pg_locks.relation or part of a relation. waiting_o bject_id The OID of the lock target within its system catalog, or null if the target is not a general database object. No pg_locks.objid waiting_d atabase_i d The OID of the database in which the lock target exists, or zero if the target is a shared object, or null if the target is a transaction ID. No pg_locks.database Viewing the Database Instance Dashboard 995 Amazon CloudWatch User Guide Column name Deﬁnition Notes Default column waiting_d atabase_n The name of the database in which the lock target exists. No pg_stat_a ctivity.datname ame waiting_l ocktype The type of the lockable object: relation, extend, frozenid, page, tuple, transacti No pg_locks.locktype onid, virtualxid, spectoken, object, userlock, advisory, or applytransaction. is_fastpa th The value is true if the lock was taken with the fast path and false if taken from the main lock table. No pg_locks.fastpath For more information about the values in the pg_stat_activity and pg_locks views, see the following topics in the PostgreSQL documentation. • pg_locks • pg_stat_activity Viewing the Database Instance Dashboard 996 Amazon CloudWatch User Guide Analyzing execution plans with CloudWatch Database Insights You can analyze execution plans for the Amazon Aurora PostgreSQL, RDS for Microsoft SQL Server and RDS for Oracle databases by using the following methods. • Sliced by dropdown – Choose the Plans dimension in
acw-ug-292	acw-ug.pdf	292	The value is true if the lock was taken with the fast path and false if taken from the main lock table. No pg_locks.fastpath For more information about the values in the pg_stat_activity and pg_locks views, see the following topics in the PostgreSQL documentation. • pg_locks • pg_stat_activity Viewing the Database Instance Dashboard 996 Amazon CloudWatch User Guide Analyzing execution plans with CloudWatch Database Insights You can analyze execution plans for the Amazon Aurora PostgreSQL, RDS for Microsoft SQL Server and RDS for Oracle databases by using the following methods. • Sliced by dropdown – Choose the Plans dimension in the Database load chart to view how diﬀerent plans contribute to DB Load over time. • Top SQL tab – Choose DB Load Analysis, then choose the Top SQL tab to view the number of plans for each digest query. To analyze execution plans for a digest query, choose the query and then choose the Plans tab. For more information, see the following procedure. Prerequisites To analyze execution plans, you must be using the Advanced mode of Database Insights. For information on how to turn on Advanced mode, see Turning on the Advanced mode of Database Insights for Amazon Aurora and Turning on the Advanced mode of Database Insights for Amazon Relational Database Service. If you are using Aurora PostgreSQL, you also have the following prerequisites: • Your DB instance must use Aurora PostgreSQL version 14.10, 15.5, or later. For information about upgrading your Aurora PostgreSQL DB cluster, see Upgrading Amazon Aurora PostgreSQL DB clusters in the Amazon Aurora User Guide. • You must conﬁgure your DB cluster to analyze execution plans by setting the parameter aurora_compute_plan_id to on with one of the following options. • Creating a DB cluster parameter group in Amazon Aurora in the Amazon Aurora User Guide • Modifying parameters in a DB cluster parameter group in Amazon Aurora in the Amazon Aurora User Guide Analyze execution plans To analyze execution plans, use the following procedure. Viewing the Database Instance Dashboard 997 Amazon CloudWatch To analyze execution plans User Guide 1. Sign in to the AWS Management Console and open the CloudWatch console at https:// console.aws.amazon.com/cloudwatch/. 2. Choose Insights. 3. Choose Database Insights. 4. Choose the Database Instance view. 5. Choose a DB instance. 6. Choose the Top SQL tab. The Plans Count column shows the number of plans collected for each digest query. 7. (Optional) If the Plans Count column doesn't appear, choose the Settings icon on the Top SQL table to customize the visibility and order of columns. 8. Choose a digest query to expand it into its component statements. Viewing the Database Instance Dashboard 998 Amazon CloudWatch User Guide 9. Scroll down and view the SQL text. Then, choose the Plans tab. By default, CloudWatch displays the estimated execution plan. For Aurora PostgreSQL, to view actual execution plans, enable the aurora_stat_plans.with_analyze parameter for your DB instance. For more information about the parameter aurora_stat_plans.with_analyze, see Monitoring query execution plans and peak memory for Aurora PostgreSQL in the Amazon Aurora User Guide. 10. To compare plans from the same digest query, choose two Plans from the Plans for digest query list. You can view either one or two plans for a query at a time. In the following example screenshot, both plans are for Aurora PostgreSQL. Viewing the Database Instance Dashboard 999 Amazon CloudWatch User Guide 11. You can also view how each plan contributes to DBLoad over time by choosing Plans in the Slice by drop-down in the DBLoad chart. Viewing the Database Instance Dashboard 1000 Amazon CloudWatch User Guide Troubleshooting for CloudWatch Database Insights Use the following information to troubleshoot issues for CloudWatch Database Insights. Applying tags to Amazon RDS resources To apply tags to your databases, use the Amazon RDS API, AWS CLI, or Amazon RDS console. For more information, see the following topics. • AddTagsToResource in the Amazon RDS API Reference • add-tags-to-resource in the Amazon RDS Command Line Reference • Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide Maximum DB instances for ﬂeets You can't monitor more than 500 DB instances in a database ﬂeet. You can use ﬁlters to create a ﬂeet health view with less than 500 DB instances. Troubleshooting 1001 Amazon CloudWatch User Guide Use Contributor Insights to analyze high-cardinality data You can use Contributor Insights to analyze log data and create time series that display contributor data. You can see metrics about the top-N contributors, the total number of unique contributors, and their usage. This helps you ﬁnd top talkers and understand who or what is impacting system performance. For example, you can ﬁnd bad hosts, identify the heaviest network users, or ﬁnd the URLs that generate the most errors. You can build your rules from scratch, and when you use
acw-ug-293	acw-ug.pdf	293	with less than 500 DB instances. Troubleshooting 1001 Amazon CloudWatch User Guide Use Contributor Insights to analyze high-cardinality data You can use Contributor Insights to analyze log data and create time series that display contributor data. You can see metrics about the top-N contributors, the total number of unique contributors, and their usage. This helps you ﬁnd top talkers and understand who or what is impacting system performance. For example, you can ﬁnd bad hosts, identify the heaviest network users, or ﬁnd the URLs that generate the most errors. You can build your rules from scratch, and when you use the AWS Management Console you can also use sample rules that AWS has created. Rules deﬁne the log ﬁelds that you want to use to deﬁne contributors, such as IpAddress. You can also ﬁlter the log data to ﬁnd and analyze the behavior of individual contributors. CloudWatch also provides built-in rules that you can use to analyze metrics from other AWS services. All rules analyze incoming data in real time. If you are signed in to an account that is set up as a monitoring account in CloudWatch cross- account observability, you can create Contributor Insights rules in that monitoring account that analyze log groups in source accounts and in the monitoring account. You can also create a single rule that analyzes log groups in multiple accounts. For more information, see CloudWatch cross- account observability. Important If you are using a log transformer on the log group, then when you create a Contributor Insights rule, you must specify the original ﬁeld key of the logs instead of the transformed ﬁeld key. With Contributor Insights, you are charged for each occurrence of a log event that matches a rule. For more information, see Amazon CloudWatch Pricing. Note Contributor Insights can only match log entries when the numeric values that the rule references are between -1e9 and 1e9. If a value in a log entry is outside of this range, Contributor Insights skips that log entry. Use Contributor Insights to analyze high-cardinality data 1002 User Guide Amazon CloudWatch Topics • Create a Contributor Insights rule in CloudWatch • Contributor Insights rule syntax in CloudWatch • CloudWatch Contributor Insights rule examples • Viewing Contributor Insights reports in CloudWatch • Graphing metrics generated by rules in CloudWatch • Using Contributor Insights built-in rules in CloudWatch Create a Contributor Insights rule in CloudWatch You can create rules to analyze log data. Any logs in JSON or Common Log Format (CLF) can be evaluated. This includes your custom logs that follow one of these formats and logs from AWS services such as Amazon VPC ﬂow logs, Amazon Route 53 DNS query logs, Amazon ECS container logs, and logs from AWS CloudTrail, Amazon SageMaker AI, Amazon RDS, AWS AppSync and API Gateway. In a rule, when you specify ﬁeld names or values, all matching is case sensitive. You can use built-in sample rules when you create a rule or you can create your own rule from scratch. Contributor Insights includes sample rules for the following types of logs: • Amazon API Gateway logs • Amazon Route 53 public DNS query logs • Amazon Route 53 resolver query logs • CloudWatch Container Insights logs • VPC ﬂow logs If you are signed in to an account that is set up as a monitoring account in CloudWatch cross- account observability, you can create Contributor Insights rules for log groups in the source accounts linked to this monitoring account, in addition to creating rules for log groups in the monitoring account. You can also set up a single rule that monitors log groups in diﬀerent accounts. For more information, see CloudWatch cross-account observability. Create a Contributor Insights rule in CloudWatch 1003 Amazon CloudWatch Important User Guide When you grant a user the cloudwatch:PutInsightRule permission, by default that user can create a rule that evaluates any log group in CloudWatch Logs. You can add IAM policy conditions that limit these permissions for a user to include and exclude speciﬁc log groups. For more information, see Using condition keys to limit Contributor Insights users' access to log groups. To create a rule using a built-in sample rule 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. In the navigation pane, choose Logs, Contributor Insights. 3. Choose Create rule. 4. For Select log group(s), select the log group(s) that you want your rule to monitor. You can select as many as 20 log groups. If you are signed in to a monitoring account that is set up for CloudWatch cross-account observability, you can select log groups in source accounts, and you can also set up a single rule to analyze log groups in diﬀerent accounts. • (Optional) To select all log groups that have names beginning with a speciﬁc string, choose the Select by
acw-ug-294	acw-ug.pdf	294	at https://console.aws.amazon.com/cloudwatch/. 2. In the navigation pane, choose Logs, Contributor Insights. 3. Choose Create rule. 4. For Select log group(s), select the log group(s) that you want your rule to monitor. You can select as many as 20 log groups. If you are signed in to a monitoring account that is set up for CloudWatch cross-account observability, you can select log groups in source accounts, and you can also set up a single rule to analyze log groups in diﬀerent accounts. • (Optional) To select all log groups that have names beginning with a speciﬁc string, choose the Select by preﬁx match dropdown, and then enter the preﬁx. If this is a monitoring account, you can optionally select the accounts to search in, otherwise all accounts are selected. Note You incur charges for each log event that matches your rule. If you choose the Select by preﬁx match dropdown, be aware of how many log groups the preﬁx can match. If you search more log groups than you want, you might incur unexpected charges. For more information, see Amazon CloudWatch Pricing. 5. 6. For Rule type, choose Sample rule. Then choose Select sample rule and select the rule. The sample rule has ﬁlled out the Log format, Contribution, Filters, and Aggregate on ﬁelds. You can adjust those values, if you like. 7. Choose Next. Create a Contributor Insights rule in CloudWatch 1004 Amazon CloudWatch User Guide 8. For Rule name, enter a name. Valid characters are A-Z, a-z, 0-9, (hyphen), (underscore), and (period). 9. Choose whether to create the rule in a disabled or enabled state. If you choose to enable it, the rule immediately starts analyzing your data. You incur costs when you run enabled rules. For more information, see Amazon CloudWatch Pricing. Contributor Insights analyzes only new log events after a rule is created. A rule cannot process logs events that were previously processed by CloudWatch Logs. 10. (Optional) For Tags, add one or more key-value pairs as tags for this rule. Tags can help you identify and organize your AWS resources and track your AWS costs. For more information, see Tagging your Amazon CloudWatch resources. 11. Choose Create. To create a rule from scratch 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. In the navigation pane, choose Logs, Contributor Insights. 3. Choose Create rule. 4. For Select log group(s), select the log group(s) that you want your rule to monitor. You can select as many as 20 log groups. If you are signed in to a monitoring account that is set up for CloudWatch cross-account observability, you can select log groups in source accounts, and you can also set up a single rule to analyze log groups in diﬀerent accounts. • (Optional) To select all log groups that have names beginning with a speciﬁc string, choose the Select by preﬁx match dropdown, and then enter the preﬁx. Note You incur charges for each log event that matches your rule. If you choose the Select by preﬁx match dropdown, be aware of how many log groups the preﬁx can match. If you search more log groups than you want, you might incur unexpected charges. For more information, see Amazon CloudWatch Pricing. 5. 6. For Rule type, choose Custom rule. For Log format, choose JSON or CLF. Create a Contributor Insights rule in CloudWatch 1005 Amazon CloudWatch User Guide 7. You can ﬁnish creating the rule by using the wizard or by choosing the Syntax tab and specifying your rule syntax manually. To continue using the wizard, do the following: a. For Contribution, Key, enter a contributor type that you want to report on. The report displays the top-N values for this contributor type. Valid entries are any log ﬁeld that has values. Examples include requestId, sourceIPaddress, and containerID. For information about ﬁnding the log ﬁeld names for the logs in a certain log group, see Finding Log Fields. Keys larger than 1 KB are truncated to 1KB. b. (Optional) Choose Add new key to add more keys. You can include as many as four keys in a rule. If you enter more than one key, the contributors in the report are deﬁned by unique value combinations of the keys. For example, if you specify three keys, each unique combination of values for the three keys is counted as a unique contributor. c. (Optional) If you want to add a ﬁlter that narrows the scope of your results, choose Add ﬁlter. For Match, enter the name of the log ﬁeld that you want to ﬁlter on. For Condition, choose a comparison operator, and enter a value that you want to ﬁlter for. You can add as many as four ﬁlters in a rule. Multiple ﬁlters are joined by AND logic, so only log events that match all ﬁlters are
acw-ug-295	acw-ug.pdf	295	keys. For example, if you specify three keys, each unique combination of values for the three keys is counted as a unique contributor. c. (Optional) If you want to add a ﬁlter that narrows the scope of your results, choose Add ﬁlter. For Match, enter the name of the log ﬁeld that you want to ﬁlter on. For Condition, choose a comparison operator, and enter a value that you want to ﬁlter for. You can add as many as four ﬁlters in a rule. Multiple ﬁlters are joined by AND logic, so only log events that match all ﬁlters are evaluated. Note Arrays that follow comparison operators, such as In, NotIn, or StartsWith, can include as many as 10 string values. For more information about the Contributor Insights rules syntax, see Contributor Insights rule syntax in CloudWatch. d. For Aggregate on, choose Count or Sum. Choosing Count causes the contributor ranking to be based on the number of occurrences. Choosing Sum causes the ranking to be based on the aggregated sum of the values of the ﬁeld that you specify for Contribution, Value. 8. To enter your rule as a JSON object instead of using the wizard, do the following: a. Choose the Syntax tab. Create a Contributor Insights rule in CloudWatch 1006 Amazon CloudWatch User Guide b. In Rule body, enter the JSON object for your rule. For information about rule syntax, see Contributor Insights rule syntax in CloudWatch. 9. Choose Next. 10. For Rule name, enter a name. Valid characters are A-Z, a-z, 0-9, "-", "_', and ".". 11. Choose whether to create the rule in a disabled or enabled state. If you choose to enable it, the rule immediately starts analyzing your data. You incur costs when you run enabled rules. For more information, see Amazon CloudWatch Pricing. Contributor Insights analyzes only new log events after a rule is created. A rule cannot process logs events that were previously processed by CloudWatch Logs. 12. (Optional) For Tags, add one or more key-value pairs as tags for this rule. Tags can help you identify and organize your AWS resources and track your AWS costs. For more information, see Tagging your Amazon CloudWatch resources. 13. Choose Next. 14. Conﬁrm the settings that you entered, and choose Create rule. You can disable, enable, or delete rules that you have created. To enable, disable, or delete a rule in Contributor Insights 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. 3. In the navigation pane, choose Logs, Contributor Insights. In the list of rules, select the check box next to a single rule. Built-in rules are created by AWS services and can't be edited, disabled, or deleted. 4. Choose Actions, and then choose the option you want. Finding log ﬁelds When you create a rule, you need to know the names of ﬁelds in the log entries in a log group. To ﬁnd the log ﬁelds in a log group 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. In the navigation pane, under Logs, choose Insights. Create a Contributor Insights rule in CloudWatch 1007 Amazon CloudWatch User Guide 3. Above the query editor, select one or more log groups to query. When you select a log group, CloudWatch Logs Insights automatically detects ﬁelds in the data in the log group and displays them in the right pane in Discovered ﬁelds. Contributor Insights rule syntax in CloudWatch This section explains the syntax for Contributor Insights rules. Use this syntax only when you are creating a rule by entering a JSON block. If you use the wizard to create a rule, you don't need to know the syntax. For more information about creating rules using the wizard, see Create a Contributor Insights rule in CloudWatch. All matching of rules to log event ﬁeld names and values is case sensitive. The following example illustrates the syntax for JSON logs. { "Schema": { "Name": "CloudWatchLogRule", "Version": 1 }, "LogGroupNames": [ "API-Gateway-Access-Logs", "Log-group-name2" ], "LogFormat": "JSON", "Contribution": { "Keys": [ "$.ip" ], "ValueOf": "$.requestBytes", "Filters": [ { "Match": "$.httpMethod", "In": [ "PUT" ] } ] }, "AggregateOn": "Sum" } Contributor Insights rule syntax in CloudWatch 1008 Amazon CloudWatch User Guide Fields in Contributor Insights rules Schema The value of Schema for a rule that analyzes CloudWatch Logs data must always be {"Name": "CloudWatchLogRule", "Version": 1} LogGroupNames An array of strings. For each element in the array, you can optionally use at the end of a string to include all log groups with names that start with that preﬁx. Be careful about using wildcards with log group names. You incur charges for each log event that matches a rule. If you accidentally search more log groups than you intend, you might incur unexpected charges. For more information, see Amazon CloudWatch Pricing. LogGroupARNs If you are creating this
acw-ug-296	acw-ug.pdf	296	value of Schema for a rule that analyzes CloudWatch Logs data must always be {"Name": "CloudWatchLogRule", "Version": 1} LogGroupNames An array of strings. For each element in the array, you can optionally use * at the end of a string to include all log groups with names that start with that preﬁx. Be careful about using wildcards with log group names. You incur charges for each log event that matches a rule. If you accidentally search more log groups than you intend, you might incur unexpected charges. For more information, see Amazon CloudWatch Pricing. LogGroupARNs If you are creating this rule in a CloudWatch cross-account observability monitoring account, you can use LogGroupARNs to specify log groups in source accounts that are linked to the monitoring account, and to specify log groups in the monitoring account itself. You must specify either LogGroupNames or LogGroupARNs in your rule, but not both. LogGroupARNs is an array of strings. For each element in the array, you can optionally use * as a wildcard in certain situations. For example you can specify arn:aws:logs:us- west-1::log-group/MyLogGroupName2 to specify log groups named MyLogGroupName2 in all source accounts and in the monitoring account, in the US West (N. California) Region. You can also specify arn:aws:logs:us-west-1:111122223333:log-group/ GroupNamePrefix to specify all log groups in US West (N. California) in 111122223333 that have names starting with GroupNamePrefix. You can't specify a partial AWS account ID as a preﬁx with a wild card. Be careful about using wildcards with log group ARNs. You incur charges for each log event that matches a rule. If you accidentally search more log groups than you intend, you might incur unexpected charges. For more information, see Amazon CloudWatch Pricing. LogFormat Valid values are JSON and CLF. Contributor Insights rule syntax in CloudWatch 1009 Amazon CloudWatch Contribution User Guide This object includes a Keys array with as many as four members, optionally a single ValueOf, and optionally an array of as many as four Filters. Keys An array of up to four log ﬁelds that are used as dimensions to classify contributors. If you enter more than one key, each unique combination of values for the keys is counted as a unique contributor. The ﬁelds must be speciﬁed using JSON property format notation. ValueOf (Optional) Specify this only when you are specifying Sum as the value of AggregateOn. ValueOf speciﬁes a log ﬁeld with numerical values. In this type of rule, the contributors are ranked by their sum of the value of this ﬁeld, instead of their number of occurrences in the log entries. For example, if you want to sort contributors by their total BytesSent over a period, you would set ValueOf to BytesSent and specify Sum for AggregateOn. Filters Speciﬁes an array of as many as four ﬁlters to narrow the log events that are included in the report. If you specify multiple ﬁlters, Contributor Insights evaluates them with a logical AND operator. You can use this to ﬁlter out irrelevant log events in your search or you can use it to select a single contributor to analyze their behavior. Each member in the array must include a Match ﬁeld and a ﬁeld indicating the type of matching operator to use. The Match ﬁeld speciﬁes a log ﬁeld to evaluate in the ﬁlter. The log ﬁeld is speciﬁed using JSON property format notation. The matching operator ﬁeld must be one of the following: In, NotIn, StartsWith, GreaterThan, LessThan, EqualTo, NotEqualTo, or IsPresent. If the operator ﬁeld is In, NotIn, or StartsWith, it is followed by an array of string values to check for. Contributor Insights evaluates the array of string values with an OR operator. The array can include as many as 10 string values. If the operator ﬁeld is GreaterThan, LessThan, EqualTo, or NotEqualTo, it is followed by a single numerical value to compare with. If the operator ﬁeld is IsPresent, it is followed by either true or false. This operator matches log events based on whether the speciﬁed log ﬁeld is present in the log event. The Contributor Insights rule syntax in CloudWatch 1010 Amazon CloudWatch User Guide isPresent works only with values in the leaf node of JSON properties. For example, a ﬁlter that looks for matches to c-count does not evaluate a log event with a value of details.c- count.c1. See the following four ﬁlter examples: {"Match": "$.httpMethod", "In": [ "PUT", ] } {"Match": "$.StatusCode", "EqualTo": 200 } {"Match": "$.BytesReceived", "GreaterThan": 10000} {"Match": "$.eventSource", "StartsWith": [ "ec2", "ecs" ] } AggregateOn Valid values are Count and Sum. Speciﬁes whether to aggregate the report based on a count of occurrences or a sum of the values of the ﬁeld that is speciﬁed in the ValueOf ﬁeld. JSON property format notation The Keys, ValueOf, and Match ﬁelds follow JSON property format with dot notation,
acw-ug-297	acw-ug.pdf	297	that looks for matches to c-count does not evaluate a log event with a value of details.c- count.c1. See the following four ﬁlter examples: {"Match": "$.httpMethod", "In": [ "PUT", ] } {"Match": "$.StatusCode", "EqualTo": 200 } {"Match": "$.BytesReceived", "GreaterThan": 10000} {"Match": "$.eventSource", "StartsWith": [ "ec2", "ecs" ] } AggregateOn Valid values are Count and Sum. Speciﬁes whether to aggregate the report based on a count of occurrences or a sum of the values of the ﬁeld that is speciﬁed in the ValueOf ﬁeld. JSON property format notation The Keys, ValueOf, and Match ﬁelds follow JSON property format with dot notation, where $ represents the root of the JSON object. This is followed by a period and then an alphanumeric string with the name of the subproperty. Multiple property levels are supported. The ﬁrst character of the string can only be A-Z or a-z. The following characters of the string can be A-Z, a-z, or 0-9. The following list illustrates valid examples of JSON property format: $.userAgent $.endpoints[0] $.users[1].name $.requestParameters.instanceId Additional ﬁeld in rules for CLF logs Common Log Format (CLF) log events do not have names for the ﬁelds like JSON does. To provide the ﬁelds to use for Contributor Insights rules, a CLF log event can be treated as array with an index starting from 1. You can specify the ﬁrst ﬁeld as "1", the second ﬁeld as "2", and so on. To make a rule for a CLF log easier to read, you can use Fields. This enables you to provide a naming alias for CLF ﬁeld locations. For example, you can specify that the location "4" is an IP Contributor Insights rule syntax in CloudWatch 1011 Amazon CloudWatch User Guide address. Once speciﬁed, IpAddress can be used as property in the Keys, ValueOf, and Filters in the rule. The following is an example of a rule for a CLF log that uses the Fields ﬁeld. { "Schema": { "Name": "CloudWatchLogRule", "Version": 1 }, "LogGroupNames": [ "API-Gateway-Access-Logs*" ], "LogFormat": "CLF", "Fields": { "4": "IpAddress", "7": "StatusCode" }, "Contribution": { "Keys": [ "IpAddress" ], "Filters": [ { "Match": "StatusCode", "EqualTo": 200 } ] }, "AggregateOn": "Count" } CloudWatch Contributor Insights rule examples This section contains examples that illustrate use cases for Contributor Insights rules. VPC Flow Logs: Byte transfers by source and destination IP address { "Schema": { "Name": "CloudWatchLogRule", "Version": 1 }, Example rules 1012 Amazon CloudWatch "LogGroupNames": [ "/aws/containerinsights/sample-cluster-name/flowlogs" ], User Guide "LogFormat": "CLF", "Fields": { "4": "srcaddr", "5": "dstaddr", "10": "bytes" }, "Contribution": { "Keys": [ "srcaddr", "dstaddr" ], "ValueOf": "bytes", "Filters": [] }, "AggregateOn": "Sum" } VPC Flow Logs: Highest number of HTTPS requests { "Schema": { "Name": "CloudWatchLogRule", "Version": 1 }, "LogGroupNames": [ "/aws/containerinsights/sample-cluster-name/flowlogs" ], "LogFormat": "CLF", "Fields": { "5": "destination address", "7": "destination port", "9": "packet count" }, "Contribution": { "Keys": [ "destination address" ], "ValueOf": "packet count", "Filters": [ { Example rules 1013 Amazon CloudWatch User Guide "Match": "destination port", "EqualTo": 443 } ] }, "AggregateOn": "Sum" } VPC Flow Logs: Rejected TCP connections { "Schema": { "Name": "CloudWatchLogRule", "Version": 1 }, "LogGroupNames": [ "/aws/containerinsights/sample-cluster-name/flowlogs" ], "LogFormat": "CLF", "Fields": { "3": "interfaceID", "4": "sourceAddress", "8": "protocol", "13": "action" }, "Contribution": { "Keys": [ "interfaceID", "sourceAddress" ], "Filters": [ { "Match": "protocol", "EqualTo": 6 }, { "Match": "action", "In": [ "REJECT" ] } ] }, Example rules 1014 Amazon CloudWatch "AggregateOn": "Sum" } Route 53 NXDomain responses by source address User Guide { "Schema": { "Name": "CloudWatchLogRule", "Version": 1 }, "AggregateOn": "Count", "Contribution": { "Filters": [ { "Match": "$.rcode", "StartsWith": [ "NXDOMAIN" ] } ], "Keys": [ "$.srcaddr" ] }, "LogFormat": "JSON", "LogGroupNames": [ "<loggroupname>" ] } Route 53 resolver queries by domain name { "Schema": { "Name": "CloudWatchLogRule", "Version": 1 }, "AggregateOn": "Count", "Contribution": { "Filters": [], "Keys": [ "$.query_name" ] Example rules 1015 User Guide Amazon CloudWatch }, "LogFormat": "JSON", "LogGroupNames": [ "<loggroupname>" ] } Route 53 resolver queries by query type and source address { "Schema": { "Name": "CloudWatchLogRule", "Version": 1 }, "AggregateOn": "Count", "Contribution": { "Filters": [], "Keys": [ "$.query_type", "$.srcaddr" ] }, "LogFormat": "JSON", "LogGroupNames": [ "<loggroupname>" ] } Viewing Contributor Insights reports in CloudWatch To view graphs of report data and a ranked list of contributors found by your rules, follow these steps. To view your rule reports 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. In the navigation pane, choose Logs, Contributor Insights. 3. In the list of rules, choose the name of a rule. The graph displays the results of the rule over the last three hours. The table under the graph shows the top 10 contributors. Viewing Contributor Insights reports in CloudWatch 1016 Amazon CloudWatch User Guide 4. To change the number of contributors shown in the table, choose Top 10 contributors at the top of the graph. 5. To ﬁlter the graph to
acw-ug-298	acw-ug.pdf	298	by your rules, follow these steps. To view your rule reports 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. In the navigation pane, choose Logs, Contributor Insights. 3. In the list of rules, choose the name of a rule. The graph displays the results of the rule over the last three hours. The table under the graph shows the top 10 contributors. Viewing Contributor Insights reports in CloudWatch 1016 Amazon CloudWatch User Guide 4. To change the number of contributors shown in the table, choose Top 10 contributors at the top of the graph. 5. To ﬁlter the graph to show only the results from a single contributor, choose that contributor in the table legend. To again show all contributors, choose that same contributor again in the legend. 6. To change the time range shown in the report, choose 15m, 30m, 1h, 2h, 3h, or custom at the top of the graph. The maximum time range for the report is 24 hours, but you can choose a 24-hour window that occurred up to 15 days ago. To choose a time window in the past, choose custom, absolute, and then specify your time window. To change the length of the time period used for the aggregation and ranking of contributors, choose period at the top of the graph. Viewing a longer time period generally shows a smoother report with few spikes. Choosing a shorter time period is more likely to display spikes. To add this graph to a CloudWatch dashboard, choose Add to dashboard. To open the CloudWatch Logs Insights query window, with the log groups in this report already loaded in the query box, choose View logs. 7. 8. 9. 10. To export the report data to your clipboard or a CSV ﬁle, choose Export. Graphing metrics generated by rules in CloudWatch Contributor Insights provides a metric math function, INSIGHT_RULE_METRIC. You can use this function to add data from a Contributor Insights report to a graph in the Metrics tab of the CloudWatch console. You can also set an alarm based on this math function. For more information about metric math functions, see Using math expressions with CloudWatch metrics. To use this metric math function, you must be signed in to an account that has both the cloudwatch:GetMetricData and cloudwatch:GetInsightRuleReport permissions. The syntax is INSIGHT_RULE_METRIC(ruleName, metricName). ruleName is the name of a Contributor Insights rule. metricName is one of the values in the following list. The value of metricName determines which type of data the math function returns. • UniqueContributors — the number of unique contributors for each data point. Graphing metrics generated by rules in CloudWatch 1017 Amazon CloudWatch User Guide • MaxContributorValue — the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph. If this rule aggregates by Count, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by Sum, the top contributor is the contributor with the greatest sum in the log ﬁeld speciﬁed by the rule's Value during that period. • SampleCount — the number of data points matched by the rule. • Sum — the sum of the values from all contributors during the time period represented by that data point. • Minimum — the minimum value from a single observation during the time period represented by that data point. • Maximum — the maximum value from a single observation during the time period represented by that data point. • Average — the average value from all contributors during the time period represented by that data point. Setting an alarm on Contributor Insights metric data Using the function INSIGHT_RULE_METRIC, you can set alarms on metrics that Contributor Insights generates. For example, you can create an alarm that's based on the percentage of rejected transmission control protocol (TCP) connections. To get started with this type of alarm, you can create rules like the ones shown in the following two examples: Example rule: "RejectedConnectionsRule" { "Schema": { "Name": "CloudWatchLogRule", "Version": 1 }, "LogGroupNames": [ "/aws/containerinsights/sample-cluster-name/flowlogs" ], "LogFormat": "CLF", "Fields": { "3": "interfaceID", "4": "sourceAddress", Graphing metrics generated by rules in CloudWatch 1018 Amazon CloudWatch User Guide "8": "protocol", "13": "action" }, "Contribution": { "Keys": [ "interfaceID", "sourceAddress" ], "Filters": [ { "Match": "protocol", "EqualTo": 6 }, { "Match": "action", "In": [ "REJECT" ] } ] }, "AggregateOn": "Sum" } Example rule: "TotalConnectionsRule" { "Schema": { "Name": "CloudWatchLogRule", "Version": 1 }, "LogGroupNames": [ "/aws/containerinsights/sample-cluster-name/flowlogs" ], "LogFormat": "CLF", "Fields": { "3": "interfaceID", "4": "sourceAddress", "8": "protocol", "13": "action" }, "Contribution": { "Keys": [ Graphing metrics generated by rules in CloudWatch 1019 Amazon CloudWatch User Guide "interfaceID", "sourceAddress" ], "Filters": [{ "Match": "protocol", "EqualTo": 6 }], "AggregateOn": "Sum" } } After you create your
acw-ug-299	acw-ug.pdf	299	1018 Amazon CloudWatch User Guide "8": "protocol", "13": "action" }, "Contribution": { "Keys": [ "interfaceID", "sourceAddress" ], "Filters": [ { "Match": "protocol", "EqualTo": 6 }, { "Match": "action", "In": [ "REJECT" ] } ] }, "AggregateOn": "Sum" } Example rule: "TotalConnectionsRule" { "Schema": { "Name": "CloudWatchLogRule", "Version": 1 }, "LogGroupNames": [ "/aws/containerinsights/sample-cluster-name/flowlogs" ], "LogFormat": "CLF", "Fields": { "3": "interfaceID", "4": "sourceAddress", "8": "protocol", "13": "action" }, "Contribution": { "Keys": [ Graphing metrics generated by rules in CloudWatch 1019 Amazon CloudWatch User Guide "interfaceID", "sourceAddress" ], "Filters": [{ "Match": "protocol", "EqualTo": 6 }], "AggregateOn": "Sum" } } After you create your rules, you can select the Metrics tab in the CloudWatch Console, where you can use the following example metric math expressions to graph the data that Contributor Insights reports: Example: Metric math expressions e1 INSIGHT_RULE_METRIC("RejectedConnectionsRule", "Sum") e2 INSIGHT_RULE_METRIC("TotalConnectionsRule", "Sum") e3 (e1/e2)*100 In the example, the metric math expression e3 returns all of the rejected TCP connections. If you want to be notiﬁed when 20 percent of the TCP connections are rejected, you can modify the expression by changing the threshold from 100 to 20. Note You can set an alarm on a metric that you're monitoring from the Metrics section. While on the Graphed metrics tab, you can select the Create alarm icon under the Actions column. The Create alarm icon looks like a bell. For more information about graphing metrics and using metric math functions, see the following section: Add a math expression to a CloudWatch graph. Using Contributor Insights built-in rules in CloudWatch You can use Contributor Insights built-in rules to analyze metrics from other AWS services. The following services support built-in rules: Using Contributor Insights built-in rules in CloudWatch 1020 Amazon CloudWatch User Guide • Contributor Insights for Amazon DynamoDB in the Amazon DynamoDB Developer Guide. • Use built-in Contributor Insights rules in the AWS PrivateLink Guide. Detect common application problems with CloudWatch Application Insights You can use Amazon CloudWatch Application Insights to detect problems with your applications. CloudWatch Application Insights facilitates observability for your applications and underlying AWS resources. It helps you set up the best monitors for your application resources to continuously analyze data for signs of problems with your applications. Application Insights, which is powered by SageMaker and other AWS technologies, provides automated dashboards that show potential problems with monitored applications, which help you to quickly isolate ongoing issues with your applications and infrastructure. The enhanced visibility into the health of your applications that Application Insights provides helps reduce mean time to repair (MTTR) to troubleshoot your application issues. When you add your applications to Amazon CloudWatch Application Insights, it scans the resources in the applications and recommends and conﬁgures metrics and logs on CloudWatch for application components. Example application components include SQL Server backend databases and Microsoft IIS/Web tiers. Application Insights analyzes metric patterns using historical data to detect anomalies, and continuously detects errors and exceptions from your application, operating system, and infrastructure logs. It correlates these observations using a combination of classiﬁcation algorithms and built-in rules. Then, it automatically creates dashboards that show the relevant observations and problem severity information to help you prioritize your actions. For common problems in .NET and SQL application stacks, such as application latency, SQL Server failed backups, memory leaks, large HTTP requests, and canceled I/O operations, it provides additional insights that point to a possible root cause and steps for resolution. Built-in integration with AWS SSM OpsCenter allows you to resolve issues by running the relevant Systems Manager Automation document. Sections • What is Amazon CloudWatch Application Insights? • How Amazon CloudWatch Application Insights works • Prerequisites, IAM policies, and permissions needed to access CloudWatch Application Insights • Set up application for monitoring using the AWS Management Console CloudWatch Application Insights 1021 Amazon CloudWatch User Guide • Application Insights cross-account observability • Work with component conﬁgurations • Create and conﬁgure CloudWatch Application Insights monitoring using CloudFormation templates • Tutorial: Set up monitoring for SAP ASE • Tutorial: Set up monitoring for SAP HANA • Tutorial: Set up monitoring for SAP NetWeaver • View and troubleshoot problems detected by Amazon CloudWatch Application Insights • Logs and metrics supported by Amazon CloudWatch Application Insights What is Amazon CloudWatch Application Insights? CloudWatch Application Insights helps you monitor your applications that use Amazon EC2 instances along with other application resources. It identiﬁes and sets up key metrics, logs, and alarms across your application resources and technology stack (for example, your Microsoft SQL Server database, web (IIS) and application servers, OS, load balancers, and queues). It continuously monitors metrics and logs to detect and correlate anomalies and errors. When errors and anomalies are detected, Application Insights generates CloudWatch Events that you can use to set up notiﬁcations or take actions. To assist with troubleshooting, it creates automated dashboards for detected problems,
acw-ug-300	acw-ug.pdf	300	Application Insights? CloudWatch Application Insights helps you monitor your applications that use Amazon EC2 instances along with other application resources. It identiﬁes and sets up key metrics, logs, and alarms across your application resources and technology stack (for example, your Microsoft SQL Server database, web (IIS) and application servers, OS, load balancers, and queues). It continuously monitors metrics and logs to detect and correlate anomalies and errors. When errors and anomalies are detected, Application Insights generates CloudWatch Events that you can use to set up notiﬁcations or take actions. To assist with troubleshooting, it creates automated dashboards for detected problems, which include correlated metric anomalies and log errors, along with additional insights to point you to a potential root cause. The automated dashboards help you to take remedial actions to keep your applications healthy and to prevent impact to the end- users of your application. It also creates OpsItems so that you can resolve problems using AWS SSM OpsCenter. You can conﬁgure important counters, such as Mirrored Write Transaction/sec, Recovery Queue Length, and Transaction Delay, as well as Windows Event Logs on CloudWatch. When a failover event or problem occurs with your SQL HA workload, such as a restricted access to query a target database, CloudWatch Application Insights provides automated insights . CloudWatch Application Insights integrates with AWS Launch Wizard to provide a one-click monitoring setup experience for deploying SQL Server HA workloads on AWS. When you select the option to set up monitoring and insights with Application Insights on the Launch Wizard console, CloudWatch Application Insights automatically sets up relevant metrics, logs, and alarms on CloudWatch, and starts monitoring newly deployed workloads. You can view automated What is Amazon CloudWatch Application Insights? 1022 Amazon CloudWatch User Guide insights and detected problems, along with the health of your SQL Server HA workloads, on the CloudWatch console. Contents • Features • Concepts • Pricing • Related services • Supported application components • Supported technology stacks Features Application Insights provides the following features. Automatic set up of monitors for application resources CloudWatch Application Insights reduces the time it takes to set up monitoring for your applications. It does this by scanning your application resources, providing a customizable list of recommended metrics and logs, and setting them up on CloudWatch to provide necessary visibility into your application resources, such as Amazon EC2 and Elastic Load Balancers (ELB). It also sets up dynamic alarms on monitored metrics. The alarms are automatically updated based on anomalies detected in the previous two weeks. Problem detection and notiﬁcation CloudWatch Application Insights detects signs of potential problems with your application, such as metric anomalies and log errors. It correlates these observations to surface potential problems with your application. It then generates CloudWatch Events, which can be conﬁgured to receive notiﬁcations or take actions. This eliminates the need for you to create individual alarms on metrics or log errors. Additionally, you can Conﬁgure Amazon SNS notiﬁcations to receive alerts for detected problems. Troubleshooting CloudWatch Application Insights creates CloudWatch automatic dashboards for problems that are detected. The dashboards show details about the problem, including the associated metric What is Amazon CloudWatch Application Insights? 1023 Amazon CloudWatch User Guide anomalies and log errors to help you with troubleshooting. They also provide additional insights that point to potential root causes of the anomalies and errors. Concepts The following concepts are important for understanding how Application Insights monitors your application. Component An auto-grouped, standalone, or custom grouping of similar resources that make up an application. We recommend grouping similar resources into custom components for better monitoring. Observation An individual event (metric anomaly, log error, or exception) that is detected with an application or application resource. Problem Problems are detected by correlating, classifying, and grouping related observations. For deﬁnitions of other key concepts for CloudWatch Application Insights, see Amazon CloudWatch Concepts. Pricing CloudWatch Application Insights sets up recommended metrics and logs for selected application resources using CloudWatch metrics, Logs, and Events for notiﬁcations on detected problems. These features are charged to your AWS account according to CloudWatch pricing. For detected problems, SSM OpsItems are also created by Application Insights to notify you about problems. Additionally, Application Insights creates SSM Parameter Store parameters to conﬁgure the CloudWatch agents on your instances. The Amazon EC2 Systems Manager features are charged according to SSM pricing. You are not charged for setup assistance, monitoring, data analysis, or problem detection. Costs for CloudWatch Application Insights Costs for Amazon EC2 include usage of the following features: • CloudWatch Agent • CloudWatch Agent log groups What is Amazon CloudWatch Application Insights? 1024 User Guide Amazon CloudWatch • CloudWatch Agent metrics • Prometheus log groups (for JMX workloads) Costs for all resources include usage of the following features: • CloudWatch alarms (majority of cost) • SSM OpsItems (minimal cost) Example cost calculation
acw-ug-301	acw-ug.pdf	301	the CloudWatch agents on your instances. The Amazon EC2 Systems Manager features are charged according to SSM pricing. You are not charged for setup assistance, monitoring, data analysis, or problem detection. Costs for CloudWatch Application Insights Costs for Amazon EC2 include usage of the following features: • CloudWatch Agent • CloudWatch Agent log groups What is Amazon CloudWatch Application Insights? 1024 User Guide Amazon CloudWatch • CloudWatch Agent metrics • Prometheus log groups (for JMX workloads) Costs for all resources include usage of the following features: • CloudWatch alarms (majority of cost) • SSM OpsItems (minimal cost) Example cost calculation The costs in this example are considered according to the following scenario. You created a resource group that includes the following: • An Amazon EC2 instance with SQL Server installed. • An attached Amazon EBS volume. When you onboard this resource group with CloudWatch Application Insights, the SQL Server workload installed on the Amazon EC2 instance is detected. CloudWatch Application Insights starts monitoring the following metrics. The following metrics are monitored for the SQL Server instance: • CPUUtilization • StatusCheckFailed • Memory % Committed Bytes in Use • Memory Available Mbytes • Network Interface Bytes Total/sec • Paging File % Usage • Physical Disk % Disk Time • Processor % Processor Time • SQLServer:Buﬀer Manager cache hit ratio • SQLServer:Buﬀer Manager life expectancy • SQLServer:General Statistics Processes blocked • SQLServer:General Statistics User Connections What is Amazon CloudWatch Application Insights? 1025 Amazon CloudWatch User Guide • SQLServer:Locks Number of Deadlocks/sec • SQLServer:SQL Statistics Batch Requests/sec • System Processor Queue Length The following metrics are monitored for the volumes attached to the SQL Server instance: • VolumeReadBytes • VolumeWriteBytes • VolumeReadOps • VolumeWriteOps • VolumeTotalReadTime • VolumeTotalWriteTime • VolumeIdleTime • VolumeQueueLength • VolumeThroughputPercentage • VolumeConsumedReadWriteOps • BurstBalance For this scenario, the costs are calculated according to the CloudWatch pricing page and the SSM pricing page: • Custom metrics For this scenario, 13 of the above metrics are emitted to CloudWatch using the CloudWatch agent. These metrics are treated as custom metrics. The cost for each custom metric is $.3/ month. The total cost for these custom metrics is 13 * $.3 = $3.90/month. • Alarms For this scenario, CloudWatch Application Insights monitors 26 metrics in total, which creates 26 alarms. The cost for each alarm is $.1/month. The total cost for alarms is 26 * $.1 = $2.60/ month. • Data ingestion and error logs The cost of data ingestion is $.05/GB and storage for the SQL Server error log is $.03/GB. The total cost for data ingestion and the error log is $.05/GB + $.03/GB= $.08/GB. What is Amazon CloudWatch Application Insights? 1026 Amazon CloudWatch User Guide • Amazon EC2 Systems Manager OpsItems An SSM OpsItem is created for each problem detected by CloudWatch Application Insights. For n number of problems in your application, the total cost is $.00267 * n/month. Related services The following services are used along with CloudWatch Application Insights: Related AWS services • Amazon CloudWatch provides system‐wide visibility into resource utilization, application performance, and operational health. It collects and tracks metrics, sends alarm notiﬁcations, automatically updates resources that you are monitoring based on the rules that you deﬁne, and allows you to monitor your own custom metrics. CloudWatch Application Insights is initiated through CloudWatch—speciﬁcally, within the CloudWatch default operational dashboards. For more information, see the Amazon CloudWatch User Guide. • CloudWatch Container Insights collects, aggregates, and summarizes metrics and logs from your containerized applications and microservices. You can use Container Insights to monitor Amazon ECS, Amazon Elastic Kubernetes Service, and Kubernetes platforms on Amazon EC2. When Application Insights is enabled on the Container Insights or Application Insights consoles, Application Insights displays detected problems on your Container Insights dashboard. For more information, see Container Insights . • Amazon DynamoDB is a fully managed NoSQL database service that lets you oﬄoad the administrative burdens of operating and scaling a distributed database so that you don't have to worry about hardware provisioning, setup and conﬁguration, replication, software patching, or cluster scaling. DynamoDB also oﬀers encryption at rest, which eliminates the operational burden and complexity involved in protecting sensitive data. • Amazon EC2 provides scalable computing capacity in the AWS Cloud. You can use Amazon EC2 to launch as many or as few virtual servers as you need, to conﬁgure security and networking, and to manage storage. You can scale up or down to handle changes in requirements or spikes in popularity, which reduces your need to forecast traﬃc. For more information, see the Amazon EC2 User Guide for Linux Instances or Amazon EC2 Guide for Windows Instances. • Amazon Elastic Block Store (Amazon EBS) provides block-level storage volumes for use with Amazon EC2 instances. Amazon EBS volumes behave like raw, unformatted block devices. You can mount these volumes as devices
acw-ug-302	acw-ug.pdf	302	You can use Amazon EC2 to launch as many or as few virtual servers as you need, to conﬁgure security and networking, and to manage storage. You can scale up or down to handle changes in requirements or spikes in popularity, which reduces your need to forecast traﬃc. For more information, see the Amazon EC2 User Guide for Linux Instances or Amazon EC2 Guide for Windows Instances. • Amazon Elastic Block Store (Amazon EBS) provides block-level storage volumes for use with Amazon EC2 instances. Amazon EBS volumes behave like raw, unformatted block devices. You can mount these volumes as devices on your instances. Amazon EBS volumes that are attached to an instance are exposed as storage volumes that persist independently from the life of the What is Amazon CloudWatch Application Insights? 1027 Amazon CloudWatch User Guide instance. You can create a ﬁle system on top of these volumes, or use them in any way you would use a block device (such as a hard drive). You can dynamically change the conﬁguration of a volume attached to an instance. For more information, see the Amazon EBS User Guide. • Amazon EC2 Auto Scaling helps ensure that you have the correct number of EC2 instances available to handle the load for your application. For more information, see the Amazon EC2 Auto Scaling User Guide. • Elastic Load Balancing distributes incoming applications or network traﬃc across multiple targets, such as EC2 instances, containers, and IP addresses, in multiple Availability Zones. For more information, see the Elastic Load Balancing User Guide. • IAM is a web service that helps you to securely control access to AWS resources for your users. Use IAM to control who can use your AWS resources (authentication), and to control the resources they can use and how they can use them (authorization). For more information, see Authentication and Access Control for Amazon CloudWatch. • AWS Lambda lets you build serverless applications composed of functions that are triggered by events and automatically deploy them using CodePipeline and AWS CodeBuild. For more information, see AWS Lambda Applications. • AWS Launch Wizard for SQL Server reduces the time it takes to deploy SQL Server high availability solution to the cloud. You input your application requirements, including performance, number of nodes, and connectivity on the service console, and AWS Launch Wizard identiﬁes the right AWS resources to deploy and run your SQL Server Always On application. • AWS Resource Groups help you to organize the resources that make up your application. With Resource Groups, you can manage and automate tasks on a large number of resources at one time. Only one Resource Group can be registered for a single application. For more information, see the AWS Resource Groups User Guide. • Amazon SQS oﬀers a secure, durable, and available hosted queue that allows you to integrate and decouple distributed software systems and components. For more information, see the Amazon SQS User Guide. • AWS Step Functions is a serverless function composer that allows you to sequence a variety of AWS services and resources, including AWS Lambda functions, into structured, visual workﬂows. For more information, see the AWS Step Functions User Guide. • AWS SSM OpsCenter aggregates and standardizes OpsItems across services while providing contextual investigation data about each OpsItem, related OpsItems, and related resources. OpsCenter also provides Systems Manager Automation documents (runbooks) that you can use to quickly resolve issues. You can specify searchable, custom data for each OpsItem. You can also What is Amazon CloudWatch Application Insights? 1028 Amazon CloudWatch User Guide view automatically-generated summary reports about OpsItems by status and source. For more information, see the AWS Systems Manager User Guide. • Amazon API Gateway is an AWS service for creating, publishing, maintaining, monitoring, and securing REST, HTTP, and WebSocket APIs at any scale. API developers can create APIs that access AWS or other web services, as well as data stored in the AWS Cloud. For more information, see the Amazon API Gateway User Guide. Note Application Insights supports only REST API protocols (v1 of the API Gateway service). • Amazon Elastic Container Service (Amazon ECS) is a fully managed container orchestration service. You can use Amazon ECS to run your most sensitive and mission-critical applications. For more information, see the Amazon Elastic Container Service Developer Guide. • Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that you can use to run Kubernetes on AWS without having to install, operate, and maintain your own Kubernetes control plane or nodes. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications. For more information, see the Amazon EKS User Guide. • Kubernetes on Amazon EC2. Kubernetes is open-source software that helps you deploy and manage containerized applications at scale. Kubernetes manages clusters of Amazon EC2 compute instances
acw-ug-303	acw-ug.pdf	303	sensitive and mission-critical applications. For more information, see the Amazon Elastic Container Service Developer Guide. • Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that you can use to run Kubernetes on AWS without having to install, operate, and maintain your own Kubernetes control plane or nodes. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications. For more information, see the Amazon EKS User Guide. • Kubernetes on Amazon EC2. Kubernetes is open-source software that helps you deploy and manage containerized applications at scale. Kubernetes manages clusters of Amazon EC2 compute instances and runs containers on those instances with processes for deployment, maintenance, and scaling. With Kubernetes, you can run any type of containerized application with the same toolset on-premises and in the cloud. For more information, see Kubernetes Documentation: Getting started. • Amazon FSx helps you to launch and run popular ﬁle systems that are fully managed by AWS. With Amazon FSx, you can leverage the feature sets and performance of common open source and commercially-licensed ﬁle systems to avoid time-consuming administrative tasks. For more information, see the Amazon FSx Documentation. • Amazon Simple Notiﬁcation Service (SNS) is a fully-managed messaging service for both application-to-application and application-to-person communication. You can conﬁgure Amazon SNS for monitoring by Application Insights. When Amazon SNS is conﬁgured as a resource for monitoring, Application Insights tracks SNS metrics to help determine why SNS messages may encounter issues or fail. • Amazon Elastic File System (Amazon EFS) is a fully-managed elastic NFS ﬁle system for use with AWS Cloud services and on-premises resources. It is built to scale to petabytes on demand What is Amazon CloudWatch Application Insights? 1029 Amazon CloudWatch User Guide without disrupting applications. It grows and shrinks automatically as you add and remove ﬁles, which eliminates the need to provision and manage capacity to accommodate growth. For more information, see the Amazon Elastic File System documentation. Related third-party services • For some workloads and applications monitored in Application Insights, Prometheus JMX exporter is installed using AWS Systems Manager Distributor so that CloudWatch Application Insights can retrieve Java-speciﬁc metrics. When you choose to monitor a Java application, Application Insights automatically installs the Prometheus JMX exporter for you. Supported application components CloudWatch Application Insights scans your resource group to identify application components. Components can be standalone, auto-grouped (such as instances in an Auto Scaling group or behind a load balancer), or custom (by grouping together individual Amazon EC2 instances). The following components are supported by CloudWatch Application Insights: AWS components • Amazon EC2 • Amazon EBS • Amazon RDS • Elastic Load Balancing: Application Load Balancer and Classic Load Balancer (all target instances of these load balancers are identiﬁed and conﬁgured). • Amazon EC2 Auto Scaling groups: AWS Auto Scaling (Auto Scaling groups are dynamically conﬁgured for all target instances; if your application scales up, CloudWatch Application Insights automatically conﬁgures the new instances). Auto Scaling groups are not supported for CloudFormation stack-based resource groups. • AWS Lambda • Amazon Simple Queue Service (Amazon SQS) • Amazon DynamoDB table • Amazon S3 bucket metrics • AWS Step Functions What is Amazon CloudWatch Application Insights? 1030 Amazon CloudWatch User Guide • Amazon API Gateway REST API stages • Amazon Elastic Container Service (Amazon ECS): cluster, service, and task • Amazon Elastic Kubernetes Service (Amazon EKS): cluster • Kubernetes on Amazon EC2: Kubernetes cluster running on EC2 • Amazon SNS topic Any other component type resources are not currently tracked by CloudWatch Application Insights. If a component type that is supported does not appear in your Application Insights application, the component may already be registered and managed by another application you own that is monitored by Application Insights. Supported technology stacks You can use CloudWatch Application Insights to monitor your applications running on Windows Server and Linux operating systems by selecting the application tier dropdown menu option for one of the following technologies: • Front‐end: Microsoft Internet Information Services (IIS) Web Server • Worker‐tier: • .NET Framework • .NET Core • Applications: • Java • SAP NetWeaver standard, distributed, and high availability deployments • Active Directory • SharePoint • Databases: • Microsoft SQL Server running on Amazon RDS or Amazon EC2 (including SQL Server High Availability conﬁgurations. See, Component conﬁguration examples). • MySQL running on Amazon RDS, Amazon Aurora, or Amazon EC2 • PostgreSQL running on Amazon RDS or Amazon EC2 • Amazon DynamoDB table • Oracle running on Amazon RDS or Amazon EC2 What is Amazon CloudWatch Application Insights? 1031 Amazon CloudWatch User Guide • SAP HANA database on a single Amazon EC2 instance and multiple EC2 instances • Cross-AZ SAP HANA database high availability setup • SAP Sybase ASE database on a single Amazon EC2 instance • Cross-AZ SAP Sybase ASE database high availability setup If none
acw-ug-304	acw-ug.pdf	304	Amazon EC2 (including SQL Server High Availability conﬁgurations. See, Component conﬁguration examples). • MySQL running on Amazon RDS, Amazon Aurora, or Amazon EC2 • PostgreSQL running on Amazon RDS or Amazon EC2 • Amazon DynamoDB table • Oracle running on Amazon RDS or Amazon EC2 What is Amazon CloudWatch Application Insights? 1031 Amazon CloudWatch User Guide • SAP HANA database on a single Amazon EC2 instance and multiple EC2 instances • Cross-AZ SAP HANA database high availability setup • SAP Sybase ASE database on a single Amazon EC2 instance • Cross-AZ SAP Sybase ASE database high availability setup If none of the technology stacks listed above apply to your application resources, you can monitor your application stack by choosing Custom from the application tier dropdown menu on the Manage monitoring page. How Amazon CloudWatch Application Insights works CloudWatch Application Insights provides monitoring of your application resources. The following information describes how Application Insights works. Topics • How Application Insights monitors applications • Data retention • Quotas • AWS Systems Manager (SSM) packages used by CloudWatch Application Insights • AWS Systems Manager (SSM) Documents used by CloudWatch Application Insights How Application Insights monitors applications The following information describes how Application Insights monitors applications. Application discovery and conﬁguration The ﬁrst time an application is added to CloudWatch Application Insights it scans the application components to recommend key metrics, logs, and other data sources to monitor for your application. You can then conﬁgure your application based on these recommendations. Data preprocessing CloudWatch Application Insights continuously analyzes the data sources being monitored across the application resources to discover metric anomalies and log errors (observations). Intelligent problem detection How Application Insights works 1032 Amazon CloudWatch User Guide The CloudWatch Application Insights engine detects problems in your application by correlating observations using classiﬁcation algorithms and built-in rules. To assist in troubleshooting, it creates automated CloudWatch dashboards, which include contextual information about the problems. Alert and action When CloudWatch Application Insights detects a problem with your application, it generates CloudWatch Events to notify you of the problem. See Application Insights CloudWatch Events for detected problems for more information about how to set up these Events. Additionally, you can conﬁgure Amazon SNS notiﬁcations to receive alerts for detected problems. Example scenario You have an ASP .NET application that is backed by a SQL Server database. Suddenly, your database begins to malfunction because of high memory pressure. This leads to application performance degradation and possibly HTTP 500 errors in your web servers and load balancer. With CloudWatch Application Insights and its intelligent analytics, you can identify the application layer that is causing the problem by checking the dynamically created dashboard that shows the related metrics and log ﬁle snippets. In this case, the problem might be at the SQL database layer. Data retention CloudWatch Application Insights retains problems for 55 days and observations for 60 days. Quotas For default quotas for CloudWatch Application Insights, see Amazon CloudWatch Application Insights endpoints and quotas. Unless otherwise noted, each quota is per AWS Region. Contact AWS Support to request an increase in your service quota. Many services contain quotas that cannot be changed. For more information about the quotas for a speciﬁc service, see the documentation for that service. AWS Systems Manager (SSM) packages used by CloudWatch Application Insights The packages listed in this section are used by Application Insights, and can be independently managed and deployed with AWS Systems Manager Distributor. For more information about SSM Distributor, see AWS Systems Manager Distributor in the AWS Systems Manager User Guide. How Application Insights works 1033 Amazon CloudWatch Packages: • AWSObservabilityExporter-JMXExporterInstallAndConﬁgure • AWSObservabilityExporter-SAP-HANADBExporterInstallAndConﬁgure • AWSObservabilityExporter-HAClusterExporterInstallAndConﬁgure • AWSObservabilityExporter-SAP-SAPHostExporterInstallAndConﬁgure • AWSObservabilityExporter-SQLExporterInstallAndConﬁgure User Guide AWSObservabilityExporter-JMXExporterInstallAndConfigure You can retrieve workload-speciﬁc Java metrics from Prometheus JMX exporter for Application Insights to conﬁgure and monitor alarms. In the Application Insights console, on the Manage monitoring page, select JAVA application from the Application tier dropdown. Then under JAVA Prometheus exporter conﬁguration, select your Collection method and JMX port number. To use AWS Systems Manager Distributor to package, install, and conﬁgure the AWS-provided Prometheus JMX exporter package independently of Application Insights, complete the following steps. Prerequisites for using the Prometheus JMX exporter SSM package • SSM agent version 2.3.1550.0 or later installed • The JAVA_HOME environment variable is set Install and conﬁgure the AWSObservabilityExporter-JMXExporterInstallAndConfigure package The AWSObservabilityExporter-JMXExporterInstallAndConfigure package is an SSM Distributor package that you can use to install and conﬁgure Prometheus JMX Exporter. When Java metrics are sent by the Prometheus JMX exporter, the CloudWatch agent can be conﬁgured to retrieve the metrics for the CloudWatch service. 1. Based on your preferences, prepare the Prometheus JMX exporter YAML conﬁguration ﬁle located in the Prometheus GitHub repository. Use the example conﬁguration and option descriptions to guide you. 2. Copy the Prometheus JMX exporter YAML conﬁguration ﬁle encoded as Base64 to a
acw-ug-305	acw-ug.pdf	305	installed • The JAVA_HOME environment variable is set Install and conﬁgure the AWSObservabilityExporter-JMXExporterInstallAndConfigure package The AWSObservabilityExporter-JMXExporterInstallAndConfigure package is an SSM Distributor package that you can use to install and conﬁgure Prometheus JMX Exporter. When Java metrics are sent by the Prometheus JMX exporter, the CloudWatch agent can be conﬁgured to retrieve the metrics for the CloudWatch service. 1. Based on your preferences, prepare the Prometheus JMX exporter YAML conﬁguration ﬁle located in the Prometheus GitHub repository. Use the example conﬁguration and option descriptions to guide you. 2. Copy the Prometheus JMX exporter YAML conﬁguration ﬁle encoded as Base64 to a new SSM parameter in SSM Parameter Store. How Application Insights works 1034 Amazon CloudWatch User Guide 3. Navigate to the SSM Distributor console and open the Owned by Amazon tab. Select AWSObservabilityExporter-JMXExporterInstallAndConﬁgure and choose Install one time. 4. Update the SSM parameter you created in the ﬁrst step by replacing "Additional Arguments" with the following: { "SSM_EXPORTER_CONFIGURATION": "{{ssm:<SSM_PARAMETER_STORE_NAME>}}", "SSM_EXPOSITION_PORT": "9404" } Note Port 9404 is the default port used to send Prometheus JMX metrics. You can update this port. Example: Conﬁgure CloudWatch agent to retrieve Java metrics 1. Install the Prometheus JMX exporter, as described in the previous procedure. Then verify that it is correctly installed on your instance by checking the port status. Successful installation on Windows instance example PS C:\> curl http://localhost:9404 (http://localhost:9404/) StatusCode : 200 StatusDescription : OK Content : # HELP jvm_info JVM version info Successful installation on Linux instance example $ curl localhost:9404 # HELP jmx_config_reload_failure_total Number of times configuration have failed to be reloaded. # TYPE jmx_config_reload_failure_total counter jmx_config_reload_failure_total 0.0 2. Create the Prometheus service discovery YAML ﬁle. The following example service discovery ﬁle performs the following: How Application Insights works 1035 Amazon CloudWatch User Guide • Speciﬁes the Prometheus JMX exporter host port as localhost: 9404. • Attaches labels (Application, ComponentName, and InstanceId) to the metrics, which can be set as CloudWatch metric dimensions. $ cat prometheus_sd_jmx.yaml - targets: - 127.0.0.1:9404 labels: Application: myApp ComponentName: arn:aws:elasticloadbalancing:us- east-1:123456789012:loadbalancer/app/sampl-Appli-MMZW8E3GH4H2/aac36d7fea2a6e5b InstanceId: i-12345678901234567 3. Create the Prometheus JMX exporter conﬁguration YAML ﬁle. The following example conﬁguration ﬁle speciﬁes the following: • The metrics retrieval job interval and timeout period. • The metrics retrieval jobs (jmx and sap), also known as scraping, which include the job name, maximum time series returned at a time, and service discovery ﬁle path. $ cat prometheus.yaml global: scrape_interval: 1m scrape_timeout: 10s scrape_configs: - job_name: jmx sample_limit: 10000 file_sd_configs: - files: ["/tmp/prometheus_sd_jmx.yaml"] - job_name: sap sample_limit: 10000 file_sd_configs: - files: ["/tmp/prometheus_sd_sap.yaml"] 4. Verify that the CloudWatch agent is installed on your Amazon EC2 instance and that the version is 1.247346.1b249759 or later. To install the CloudWatch agent on your EC2 instance, see Installing the CloudWatch Agent. To verify the version, see Finding information about CloudWatch agent versions. How Application Insights works 1036 Amazon CloudWatch User Guide 5. Conﬁgure the CloudWatch agent. For more information about how to conﬁgure the CloudWatch agent conﬁguration ﬁle, see Manually create or edit the CloudWatch agent conﬁguration ﬁle. The following example CloudWatch agent conﬁguration ﬁle performs the following: • Speciﬁes the Prometheus JMX exporter conﬁguration ﬁle path. • Speciﬁes the target log group to which to publish EMF metric logs. • Speciﬁes two sets of dimensions for each metric name. • Sends 8 (4 metric names * 2 sets of dimensions per metric name) CloudWatch metrics. { "logs":{ "logs_collected":{ .... }, "metrics_collected":{ "prometheus":{ "cluster_name":"prometheus-test-cluster", "log_group_name":"prometheus-test", "prometheus_config_path":"/tmp/prometheus.yaml", "emf_processor":{ "metric_declaration_dedup":true, "metric_namespace":"CWAgent", "metric_unit":{ "jvm_threads_current":"Count", "jvm_gc_collection_seconds_sum":"Second", "jvm_memory_bytes_used":"Bytes" }, "metric_declaration":[ { "source_labels":[ "job" ], "label_matcher":"^jmx$", "dimensions":[ [ "InstanceId", "ComponentName" ], [ "ComponentName" How Application Insights works 1037 Amazon CloudWatch User Guide ] ], "metric_selectors":[ "^java_lang_threading_threadcount$", "^java_lang_memory_heapmemoryusage_used$", "^java_lang_memory_heapmemoryusage_committed$" ] } ] } } } }, "metrics":{ .... } } AWSObservabilityExporter-SAP-HANADBExporterInstallAndConfigure You can retrieve workload-speciﬁc SAP HANA metrics from Prometheus HANA database exporter for Application Insights to conﬁgure and monitor alarms. For more information, see Set up your SAP HANA database for monitoring in this guide. To use AWS Systems Manager Distributor to package, install, and conﬁgure the AWS-provided Prometheus HANA database exporter package independently of Application Insights, complete the following steps. Prerequisites for using the Prometheus HANA database exporter SSM package • SSM agent version 2.3.1550.0 or later installed • SAP HANA database • Linux operating system (SUSE Linux, RedHat Linux) • A secret with SAP HANA database monitoring credentials, using AWS Secrets Manager. Create a secret using the key/value pairs format, specify the key username, and enter the database user for the value. Add a second key password, and then enter the password for the value. For more information about how to create secrets, see Create a secret in the AWS Secrets Manager User Guide. The secret must be formatted as follows: { How Application Insights works 1038 Amazon CloudWatch User Guide "username": "<database_user>", "password": "<database_password>" } Install and conﬁgure the AWSObservabilityExporter-SAP- HANADBExporterInstallAndConfigure
acw-ug-306	acw-ug.pdf	306	Linux operating system (SUSE Linux, RedHat Linux) • A secret with SAP HANA database monitoring credentials, using AWS Secrets Manager. Create a secret using the key/value pairs format, specify the key username, and enter the database user for the value. Add a second key password, and then enter the password for the value. For more information about how to create secrets, see Create a secret in the AWS Secrets Manager User Guide. The secret must be formatted as follows: { How Application Insights works 1038 Amazon CloudWatch User Guide "username": "<database_user>", "password": "<database_password>" } Install and conﬁgure the AWSObservabilityExporter-SAP- HANADBExporterInstallAndConfigure package The AWSObservabilityExporter-SAP-HANADBExporterInstallAndConfigure package is an SSM Distributor package that you can use to install and conﬁgure Prometheus HANA database Exporter. When HANA database metrics are sent by the Prometheus HANA database exporter, the CloudWatch agent can be conﬁgured to retrieve the metrics for the CloudWatch service. 1. Create an SSM parameter in SSM Parameter Store to store the Exporter conﬁgurations. The following is an example parameter value. {\"exposition_port\":9668,\"multi_tenant\":true,\"timeout\":600,\"hana\":{\"host\": \"localhost\",\"port\":30013,\"aws_secret_name\":\"HANA_DB_CREDS\",\"scale_out_mode \":true}} Note In this example, the export runs only on the Amazon EC2 instance with the active SYSTEM database, and it will remain idle on the other EC2 instances in order to avoid duplicate metrics. The exporter can retrieve all of the database tenant information from the SYSTEM database. 2. Create an SSM parameter in SSM Parameter Store to store the Exporter metrics queries. The package can accept more than one metrics parameter. Each parameter must have a valid JSON object format. The following is an example parameter value: {\"SELECT MAX(TIMESTAMP) TIMESTAMP, HOST, MEASURED_ELEMENT_NAME CORE, SUM(MAP(CAPTION, 'User Time', TO_NUMBER(VALUE), 0)) USER_PCT, SUM(MAP(CAPTION, 'System Time', TO_NUMBER(VALUE), 0)) SYSTEM_PCT, SUM(MAP(CAPTION, 'Wait Time', TO_NUMBER(VALUE), 0)) WAITIO_PCT, SUM(MAP(CAPTION, 'Idle Time', 0, TO_NUMBER(VALUE))) BUSY_PCT, SUM(MAP(CAPTION, 'Idle Time', TO_NUMBER(VALUE), 0)) IDLE_PCT FROM sys.M_HOST_AGENT_METRICS WHERE MEASURED_ELEMENT_TYPE = 'Processor' GROUP BY HOST, MEASURED_ELEMENT_NAME;\":{\"enabled\":true,\"metrics\":[{\"name\": \"hanadb_cpu_user\",\"description\":\"Percentage of CPU time spent by HANA DB in user space, over the last minute (in seconds)\",\"labels\":[\"HOST\",\"CORE\"],\"value\": How Application Insights works 1039 Amazon CloudWatch User Guide \"USER_PCT\",\"unit\":\"percent\",\"type\":\"gauge\"},{\"name\":\"hanadb_cpu_system \",\"description\":\"Percentage of CPU time spent by HANA DB in Kernel space, over the last minute (in seconds)\",\"labels\":[\"HOST\",\"CORE\"],\"value\": \"SYSTEM_PCT\",\"unit\":\"percent\",\"type\":\"gauge\"},{\"name\":\"hanadb_cpu_waitio \",\"description\":\"Percentage of CPU time spent by HANA DB in IO mode, over the last minute (in seconds)\",\"labels\":[\"HOST\",\"CORE\"],\"value\":\"WAITIO_PCT\", \"unit\":\"percent\",\"type\":\"gauge\"},{\"name\":\"hanadb_cpu_busy\",\"description \":\"Percentage of CPU time spent by HANA DB, over the last minute (in seconds)\", \"labels\":[\"HOST\",\"CORE\"],\"value\":\"BUSY_PCT\",\"unit\":\"percent\",\"type\": \"gauge\"},{\"name\":\"hanadb_cpu_idle\",\"description\":\"Percentage of CPU time not spent by HANA DB, over the last minute (in seconds)\",\"labels\":[\"HOST\",\"CORE \"],\"value\":\"IDLE_PCT\",\"unit\":\"percent\",\"type\":\"gauge\"}]}} For more information about metrics queries, see the SUSE / hanadb_exporter repo on GitHub. 3. Navigate to the SSM Distributor console and open the Owned by Amazon tab. Select AWSObservabilityExporter-SAP-HANADBExporterInstallAndConﬁgure* and choose Install one time. 4. Update the SSM parameter you created in the ﬁrst step by replacing "Additional Arguments" with the following: { "SSM_EXPORTER_CONFIG": "{{ssm:<SSM_CONFIGURATIONS_PARAMETER_STORE_NAME>}}", "SSM_SID": "<SAP_DATABASE_SID>", "SSM_EXPORTER_METRICS_1": "{{ssm:<SSM_FIRST_METRICS_PARAMETER_STORE_NAME>}}", "SSM_EXPORTER_METRICS_2": "{{ssm:<SSM_SECOND_METRICS_PARAMETER_STORE_NAME>}}" } 5. Select the Amazon EC2 instances with SAP HANA database, and choose Run. AWSObservabilityExporter-HAClusterExporterInstallAndConfigure You can retrieve workload-speciﬁc High Availability (HA) cluster metrics from Prometheus HANA cluster exporter for Application Insights to conﬁgure and monitor alarms for an SAP HANA database High Availability setup. For more information, see Set up your SAP HANA database for monitoring in this guide. To use AWS Systems Manager Distributor to package, install, and conﬁgure the AWS-provided Prometheus HA cluster exporter package independently of Application Insights, complete the following steps. How Application Insights works 1040 Amazon CloudWatch User Guide Prerequisites for using the Prometheus HA cluster exporter SSM package • SSM agent version 2.3.1550.0 or later installed • HA cluster for Pacemaker, Corosync, SBD, and DRBD • Linux operating system (SUSE Linux, RedHat Linux) Install and conﬁgure the AWSObservabilityExporter- HAClusterExporterInstallAndConfigure package The AWSObservabilityExporter-HAClusterExporterInstallAndConfigure package is an SSM Distributor package that you can use to install and conﬁgure Prometheus HA Cluster Exporter. When cluster metrics are sent by the Prometheus HANA database exporter, the CloudWatch agent can be conﬁgured to retrieve the metrics for the CloudWatch service. 1. Create an SSM parameter in SSM Parameter Store to store the Exporter conﬁgurations in JSON format. The following is an example parameter value. {\"port\":\"9664\",\"address\":\"0.0.0.0\",\"log-level\":\"info\",\"crm-mon-path \":\"/usr/sbin/crm_mon\",\"cibadmin-path\":\"/usr/sbin/cibadmin\",\"corosync- cfgtoolpath-path\":\"/usr/sbin/corosync-cfgtool\",\"corosync-quorumtool-path\":\"/ usr/sbin/corosync-quorumtool\",\"sbd-path\":\"/usr/sbin/sbd\",\"sbd-config-path\": \"/etc/sysconfig/sbd\",\"drbdsetup-path\":\"/sbin/drbdsetup\",\"enable-timestamps \":false} For more information about the exporter conﬁgurations, see the ClusterLabs / ha_cluster_exporter repo on GitHub. 2. Navigate to the SSM Distributor console and open the Owned by Amazon tab. Select AWSObservabilityExporter-HAClusterExporterInstallAndConﬁgure* and choose Install one time. 3. Update the SSM parameter you created in the ﬁrst step by replacing "Additional Arguments" with the following: { "SSM_EXPORTER_CONFIG": "{{ssm:<SSM_CONFIGURATIONS_PARAMETER_STORE_NAME>}}" } 4. Select the Amazon EC2 instances with SAP HANA database, and choose Run. How Application Insights works 1041 Amazon CloudWatch User Guide AWSObservabilityExporter-SAP-SAPHostExporterInstallAndConfigure You can retrieve workload-speciﬁc SAP NetWeaver metrics from Prometheus SAP host exporter for Application Insights to conﬁgure and monitor alarms for SAP NetWeaver Distributed and High Availability deployments. To use AWS Systems Manager Distributor to package, install, and conﬁgure the SAP host exporter package independently of
acw-ug-307	acw-ug.pdf	307	Amazon tab. Select AWSObservabilityExporter-HAClusterExporterInstallAndConﬁgure* and choose Install one time. 3. Update the SSM parameter you created in the ﬁrst step by replacing "Additional Arguments" with the following: { "SSM_EXPORTER_CONFIG": "{{ssm:<SSM_CONFIGURATIONS_PARAMETER_STORE_NAME>}}" } 4. Select the Amazon EC2 instances with SAP HANA database, and choose Run. How Application Insights works 1041 Amazon CloudWatch User Guide AWSObservabilityExporter-SAP-SAPHostExporterInstallAndConfigure You can retrieve workload-speciﬁc SAP NetWeaver metrics from Prometheus SAP host exporter for Application Insights to conﬁgure and monitor alarms for SAP NetWeaver Distributed and High Availability deployments. To use AWS Systems Manager Distributor to package, install, and conﬁgure the SAP host exporter package independently of Application Insights, complete the following steps. Prerequisites for using the Prometheus SAP host exporter SSM package • SSM agent version 2.3.1550.0 or later installed • SAP NetWeaver application servers • Linux operating system (SUSE Linux, RedHat Linux) Install and conﬁgure the AWSObservabilityExporter-SAP- SAPHostExporterInstallAndConfigure package The AWSObservabilityExporter-SAP-SAPHostExporterInstallAndConfigure package is an SSM Distributor package that you can use to install and conﬁgure SAP NetWeaver Prometheus metrics exporter. When SAP NetWeaver metrics are sent by the Prometheus exporter, the CloudWatch agent can be conﬁgured to retrieve the metrics for the CloudWatch service. 1. Create an SSM parameter in SSM Parameter Store to store the Exporter conﬁgurations in JSON format. The following is an example parameter value. {\"address\":\"0.0.0.0\",\"port\":\"9680\",\"log-level\":\"info\",\"is-HA\":false} • address The target address to which to send the Prometheus metrics. The default value is localhost. • port The target port to which to send the Prometheus metrics. The default value is 9680. • is-HA true for SAP NetWeaver High Availability deployments. For all other deployments the value is false. How Application Insights works 1042 Amazon CloudWatch User Guide 2. Navigate to the SSM Distributor console and open the Owned by Amazon tab. Select AWSObservabilityExporter-SAP-SAPHostExporterInstallAndConﬁgure and choose Install one time. 3. Update the SSM parameter you created in the ﬁrst step by replacing "Additional Arguments" with the following: { "SSM_EXPORTER_CONFIG": "{{ssm:<SSM_CONFIGURATIONS_PARAMETER_STORE_NAME>}}", "SSM_SID": "<SAP_DATABASE_SID>", "SSM_INSTANCES_NUM": "<instances_number seperated by comma>" } Example { "SSM_EXPORTER_CONFIG": "{{ssm:exporter_config_paramter}}", "SSM_INSTANCES_NUM": "11,12,10", "SSM_SID": "PR1" } 4. Select the Amazon EC2 instances with SAP NetWeaver applications, and choose Run. Note The Prometheus exporter services the SAP NetWeaver metrics on a local endpoint. The local endpoint can be accessed by only the operating system users on the Amazon EC2 instance. Therefore, after the exporter package is installed, the metrics are available to all of the operating system users. The default local endpoint is localhost:9680/metrics. AWSObservabilityExporter-SQLExporterInstallAndConfigure You can retrieve workload-speciﬁc SQL Server metrics from Prometheus SQL exporter for Application Insights to monitor key metrics. To use AWS Systems Manager Distributor to package, install, and conﬁgure the SQL exporter package independently of Application Insights, complete the following steps. How Application Insights works 1043 Amazon CloudWatch User Guide Prerequisites for using the Prometheus SQL exporter SSM package • SSM agent version 2.3.1550.0 or later installed • Amazon EC2 instance running SQL Server on Windows with SQL Server user authentication enabled. • A SQL Server user with the following permissions: GRANT VIEW ANY DEFINITION TO GRANT VIEW SERVER STATE TO • A secret containing the database connection string using AWS Secrets Manager. For more information about how to create secrets, see Create a secret in the AWS Secrets Manager User Guide. The secret must be formatted as follows: { "data_source_name":"sqlserver://<username>:<password>@localhost:1433" } Note If the password or username contains special characters, you must percent encode the special characters to ensure a successful connection to the database. Install and conﬁgure the AWSObservabilityExporter-SQLExporterInstallAndConfigure package The AWSObservabilityExporter-SQLExporterInstallAndConfigure package is an SSM Distributor package that you can use to install and conﬁgure SQL Prometheus metrics exporter. When metrics are sent by the Prometheus exporter, the CloudWatch agent can be conﬁgured to retrieve the metrics for the CloudWatch service. 1. Based on your preferences, prepare the SQL Exporter YAML conﬁguration. The following sample conﬁguration has a single metric conﬁgured. Use the example conﬁguration to update the conﬁguration with additional metrics or create your own conﬁguration. --- How Application Insights works 1044 User Guide Amazon CloudWatch global: scrape_timeout_offset: 500ms min_interval: 0s max_connections: 3 max_idle_connections: 3 target: aws_secret_name: <SECRET_NAME> collectors: - mssql_standard collectors: - collector_name: mssql_standard metrics: - metric_name: mssql_batch_requests type: counter help: 'Number of command batches received.' values: [cntr_value] query: \| SELECT cntr_value FROM sys.dm_os_performance_counters WITH (NOLOCK) WHERE counter_name = 'Batch Requests/sec' 2. Copy the Prometheus SQL exporter YAML conﬁguration ﬁle encoded as Base64 to a new SSM parameter in SSM Parameter Store. 3. Navigate to the SSM Distributor console and open the Owned by Amazon tab. Select AWSObservabilityExporter-SQLExporterInstallAndConﬁgure and choose Install one time. 4. Replace the "Additional Arguments" with the following information. The SSM_PARAMETER_NAME is the name of the parameter you created in Step 2. { "SSM_EXPORTER_CONFIGURATION": "{{ssm:<SSM_PARAMETER_STORE_NAME>}}", "SSM_PROMETHEUS_PORT": "9399", "SSM_WORKLOAD_NAME": "SQL" } 5. Select the Amazon EC2 instance with the SQL Server database, then choose run. How Application Insights works 1045 Amazon CloudWatch
acw-ug-308	acw-ug.pdf	308	WITH (NOLOCK) WHERE counter_name = 'Batch Requests/sec' 2. Copy the Prometheus SQL exporter YAML conﬁguration ﬁle encoded as Base64 to a new SSM parameter in SSM Parameter Store. 3. Navigate to the SSM Distributor console and open the Owned by Amazon tab. Select AWSObservabilityExporter-SQLExporterInstallAndConﬁgure and choose Install one time. 4. Replace the "Additional Arguments" with the following information. The SSM_PARAMETER_NAME is the name of the parameter you created in Step 2. { "SSM_EXPORTER_CONFIGURATION": "{{ssm:<SSM_PARAMETER_STORE_NAME>}}", "SSM_PROMETHEUS_PORT": "9399", "SSM_WORKLOAD_NAME": "SQL" } 5. Select the Amazon EC2 instance with the SQL Server database, then choose run. How Application Insights works 1045 Amazon CloudWatch User Guide AWS Systems Manager (SSM) Documents used by CloudWatch Application Insights Application Insights uses the SSM Documents listed in this section to deﬁne the actions that AWS Systems Manager performs on your managed instances. These documents use the Run Command capability of Systems Manager to automate the tasks necessary for carrying out Application Insights monitoring capabilities. The run schedules for these documents are maintained by Application Insights and can't be altered. For more information about SSM Documents, see AWS Systems Manager Documents in the AWS Systems Manager User Guide. Documents managed by CloudWatch Application Insights The following table lists the SSM documents that are managed by Application Insights. Document name Description Run schedule AWSEC2-DetectWorkl oad Auto detects applications running in your application This document runs hourly in your application environment environment that can be to get up-to-date application set up to be monitored by details. Application Insights. AWSEC2-CheckPerfor manceCounterSets Checks whether Performan ce Counter namespaces are This document runs hourly in your application environment enabled on your Amazon EC2 and only monitors Performan Windows instances. ce Counter metrics if the AWSEC2-Application InsightsCloudwatch AgentInstallAndCon figure Installs and conﬁgures CloudWatch Agent based on the monitoring conﬁgura tion of your application components. corresponding namespaces are enabled. This document runs every 30 minutes to ensure that the CloudWatch Agent conﬁgura tion is always accurate and up-to-date. The document also runs immediately after a change is made to your application monitoring setup How Application Insights works 1046 Amazon CloudWatch User Guide Document name Description Run schedule such as adding or removing metrics or updating log conﬁgurations. Documents managed by AWS Systems Manager The following documents are used by CloudWatch Application Insights and managed by Systems Manager. AWS-ConfigureAWSPackage Application Insights uses this document to install and uninstall Prometheus exporter distributor packages, to collect workload speciﬁc metrics, and to enable comprehensive monitoring of workloads on customer Amazon EC2 instances. CloudWatch Application Insights installs the Prometheus exporter distributor packages only if the correlated target workload is running on your instance. The following table lists the Prometheus exporter distributor packages and the correlated target workloads. Prometheus exporter distributor package name Target workload AWSObservabilityExporter-HA SAP HANA HA ClusterExporterInstallAndCo nfigure AWSObservabilityExporter-JM Java/JMX XExporterInstallAndConfigure AWSObservabilityExporter-SA SAP HANA P-HANADBExporterInstallAndC onfigure AWSObservabilityExporter-SA NetWeaver P-SAPHostExporterInstallAnd Configure How Application Insights works 1047 Amazon CloudWatch User Guide Prometheus exporter distributor package name Target workload AWSObservabilityExporter-SQ SQL Server (Windows) and SAP ASE (Linux) LExporterInstallAndConfigure AmazonCloudWatch-ManageAgent Application Insights uses this document to manage the status and conﬁguration of CloudWatch Agent on your instances and to collect internal system level metrics and logs from Amazon EC2 instances across operating systems. Prerequisites, IAM policies, and permissions needed to access CloudWatch Application Insights To get started with CloudWatch Application Insights, verify that you have met the following prerequisites, have created an IAM policy, and have attached permissions if needed. Topics • Prerequisites to conﬁgure an application for monitoring • IAM policy for CloudWatch Application Insights • IAM role permissions for account-based application onboarding Prerequisites to conﬁgure an application for monitoring You must complete the following prerequisites to conﬁgure an application with CloudWatch Application Insights: • AWS Systems Manager enablement – Install Systems Manager Agent (SSM Agent) on your Amazon EC2 instances, and enable the instances for SSM. For information about how to install the SSM Agent, see Setting up AWS Systems Manager in the AWS Systems Manager User Guide. • EC2 instance role – You must attach the following Amazon EC2 instance roles to enable Systems Manager • You must attach the AmazonSSMManagedInstanceCore role to enable Systems Manager. For more information, see AWS Systems Manager identity-based policy examples. Prerequisites, IAM policies, and permissions 1048 Amazon CloudWatch User Guide • You must attach the CloudWatchAgentServerPolicy policy to enable instance metrics and logs to be emitted through CloudWatch. For more information, see Create IAM roles and users for use with CloudWatch agent. • AWS resource groups – To onboard your applications to CloudWatch Application Insights, create a resource group that includes all of the associated AWS resources used by your application stack. This includes application load balancers, Amazon EC2 instances running IIS and web front‐end, .NET worker tiers, and SQL Server databases. For more information about application components and technology stacks supported by
acw-ug-309	acw-ug.pdf	309	and permissions 1048 Amazon CloudWatch User Guide • You must attach the CloudWatchAgentServerPolicy policy to enable instance metrics and logs to be emitted through CloudWatch. For more information, see Create IAM roles and users for use with CloudWatch agent. • AWS resource groups – To onboard your applications to CloudWatch Application Insights, create a resource group that includes all of the associated AWS resources used by your application stack. This includes application load balancers, Amazon EC2 instances running IIS and web front‐end, .NET worker tiers, and SQL Server databases. For more information about application components and technology stacks supported by Application Insights, see Supported application components. CloudWatch Application Insights automatically includes Auto Scaling groups using the same tags or CloudFormation stacks as your resource group, because Auto Scaling groups are not supported by CloudFormation resource groups. For more information, see Getting Started with AWS Resource Groups. • IAM permissions – For users who don't have administrative access, you must create an AWS Identity and Access Management (IAM) policy that allows Application Insights to create a service- linked role and attach it to the user's identity. For more information about how to create the IAM policy, see IAM policy for CloudWatch Application Insights. • Service-linked role – Application Insights uses AWS Identity and Access Management (IAM) service-linked roles. A service-linked role is created for you when you create your ﬁrst Application Insights application in the Application Insights console. For more information, see Using service- linked roles for CloudWatch Application Insights. • Performance Counter metrics support for EC2 Windows instances – To monitor Performance Counter metrics on your Amazon EC2 Windows instances, Performance Counters must be installed on the instances. For Performance Counter metrics and corresponding Performance Counter set names, see Performance Counter metrics. For more information about Performance Counters, see Performance Counters. • Amazon CloudWatch agent – Application Insights installs and conﬁgures the CloudWatch agent. If you have CloudWatch agent installed, Application Insights retains your conﬁguration. To avoid a merge conﬂict, remove the conﬁguration of resources that you want to use in Application Insights from the existing CloudWatch agent conﬁguration ﬁle. For more information, see Manually create or edit the CloudWatch agent conﬁguration ﬁle. IAM policy for CloudWatch Application Insights To use CloudWatch Application Insights, you must create an AWS Identity and Access Management (IAM) policy and attach it to your user, group, or role. For more information about users, groups, Prerequisites, IAM policies, and permissions 1049 Amazon CloudWatch User Guide and roles, see IAM Identities (users, user groups, and roles). The IAM policy deﬁnes the user permissions. To create an IAM policy using the console To create an IAM policy using the IAM console, perform the following steps. 1. Go to the IAM console. In the left navigation pane, select Policies. 2. At the top of the page, select Create policy. 3. Select the JSON tab. 4. Copy and paste the following JSON document under the JSON tab. { "Version": "2012-10-17", "Statement": [ { "Action": [ "applicationinsights:", "iam:CreateServiceLinkedRole", "iam:ListRoles", "resource-groups:ListGroups" ], "Effect": "Allow", "Resource": "" } ] } Select Review Policy. Enter a Name for the policy, for example, “AppInsightsPolicy.” Optionally, enter a Description. Select Create Policy. In the left navigation pane, select User groups, Users, or Roles. Select the name of the user group, user, or role to which you would like to attach the policy. 5. 6. 7. 8. 9. 10. Select Add permissions. 11. Select Attach existing policies directly. 12. Search for the policy that you just created, and select the check box to the left of the policy name. 13. Select Next: Review. Prerequisites, IAM policies, and permissions 1050 Amazon CloudWatch User Guide 14. Make sure that the correct policy is listed, and select Add permissions. 15. Make sure that you log in with the user associated with the policy that you just created when you use CloudWatch Application Insights. To create an IAM policy using the AWS CLI To create an IAM policy using the AWS CLI, run the create-policy operation from the command line using the JSON document above as a ﬁle in your current folder. To create an IAM policy using AWS Tools for Windows PowerShell To create an IAM policy using the AWS Tools for Windows PowerShell, run the New-IAMPolicy cmdlt using the JSON document above as a ﬁle in your current folder. IAM role permissions for account-based application onboarding If you want to onboard all of the resources in your account, and you choose not to use the Application Insights managed policy for full access to Application Insights functionality, you must attach the following permissions to your IAM role so that Application Insights can discover all of the resources in your account: "ec2:DescribeInstances" "ec2:DescribeNatGateways" "ec2:DescribeVolumes" "ec2:DescribeVPCs" "rds:DescribeDBInstances" "rds:DescribeDBClusters" "sqs:ListQueues" "elasticloadbalancing:DescribeLoadBalancers" "autoscaling:DescribeAutoScalingGroups" "lambda:ListFunctions" "dynamodb:ListTables" "s3:ListAllMyBuckets" "sns:ListTopics" "states:ListStateMachines" "apigateway:GET" "ecs:ListClusters" "ecs:DescribeTaskDefinition" "ecs:ListServices" "ecs:ListTasks"
acw-ug-310	acw-ug.pdf	310	AWS Tools for Windows PowerShell, run the New-IAMPolicy cmdlt using the JSON document above as a ﬁle in your current folder. IAM role permissions for account-based application onboarding If you want to onboard all of the resources in your account, and you choose not to use the Application Insights managed policy for full access to Application Insights functionality, you must attach the following permissions to your IAM role so that Application Insights can discover all of the resources in your account: "ec2:DescribeInstances" "ec2:DescribeNatGateways" "ec2:DescribeVolumes" "ec2:DescribeVPCs" "rds:DescribeDBInstances" "rds:DescribeDBClusters" "sqs:ListQueues" "elasticloadbalancing:DescribeLoadBalancers" "autoscaling:DescribeAutoScalingGroups" "lambda:ListFunctions" "dynamodb:ListTables" "s3:ListAllMyBuckets" "sns:ListTopics" "states:ListStateMachines" "apigateway:GET" "ecs:ListClusters" "ecs:DescribeTaskDefinition" "ecs:ListServices" "ecs:ListTasks" "eks:ListClusters" Prerequisites, IAM policies, and permissions 1051 User Guide Amazon CloudWatch "eks:ListNodegroups" "fsx:DescribeFileSystems" "route53:ListHealthChecks" "route53:ListHostedZones" "route53:ListQueryLoggingConfigs" "route53resolver:ListFirewallRuleGroups" "route53resolver:ListFirewallRuleGroupAssociations" "route53resolver:ListResolverEndpoints" "route53resolver:ListResolverQueryLogConfigs" "route53resolver:ListResolverQueryLogConfigAssociations" "logs:DescribeLogGroups" "resource-explorer:ListResources" Set up application for monitoring using the AWS Management Console This section provides steps to set up, conﬁgure, and manage your CloudWatch Application Insights application using the console, the AWS CLI, and AWS Tools for Windows PowerShell. Topics • Set up, conﬁgure, and manage your application for monitoring from the CloudWatch console • Set up, conﬁgure, and manage your application for monitoring using the command line • Application Insights CloudWatch Events for detected problems • Receive notiﬁcations for detected problems Set up, conﬁgure, and manage your application for monitoring from the CloudWatch console This section provides steps to set up, conﬁgure, and manage your application for monitoring from the CloudWatch console. Console procedures • Add and conﬁgure an application • Enable Application Insights for Amazon ECS and Amazon EKS resource monitoring • Disable monitoring for an application component • Delete an application Set up application for monitoring 1052 Amazon CloudWatch User Guide Add and conﬁgure an application Add and conﬁgure an application from the CloudWatch console To get started with CloudWatch Application Insights from the CloudWatch console, perform the following steps. 1. Start. Open the CloudWatch console landing page. From the left navigation pane, under Insights, choose Application Insights. The page that opens shows the list of applications that are monitored with CloudWatch Application Insights, along with their monitoring status. 2. Add an application. To set up monitoring for your application, choose Add an application. When you choose Add an application, you are prompted to Choose Application Type. • Resource group-based application. When you select this option, you can choose which resource groups in this account to monitor. To use multiple applications on a component, you must use resource group-based monitoring. • Account-based application. When you select this option, you can monitor all of the resources in this account. If you want to monitor all of the resources in an account, we recommend this option over the resource group-based option because the application onboarding process is faster. Note You can't combine resource group-based monitoring with account-based monitoring using Application Insights. In order to change the application type, you must delete all of the applications that are being monitored, and Choose Application Type. When you add your ﬁrst application for monitoring, CloudWatch Application Insights creates a service-linked role in your account, which gives Application Insights permissions to call other AWS services on your behalf. For more information about the service-linked role created in your account by Application Insights, see Using service-linked roles for CloudWatch Application Insights. 3. Resource-based application monitoring 1. Select an application or resource group. On the Specify application details page, select the AWS resource group that contains your application resources from the Set up application for monitoring 1053 Amazon CloudWatch User Guide dropdown list. These resources include front-end servers, load balancers, auto scaling groups, and database servers. If you have not created a resource group for your application, you can create one by choosing Create new resource group. For more information about creating resource groups, see the AWS Resource Groups User Guide. 2. Notiﬁcations for problem insights. To view and get notiﬁed when problems are detected for selected applications, choose Amazon SNS notiﬁcations or Systems Manager OpsCenter Opsitems. a. Set up Amazon SNS notiﬁcation (Recommended). Choose Select existing topic or Create new topic. b. Integrate with AWS Systems Manager OpsCenter. Under Advanced Settings, select the Generate Systems Manager OpsCenter OpsItems for remedial actions check box. To track the operations that are taken to resolve operational work items (OpsItems) that are related to your AWS resources, provide the Amazon SNS topic ARN. 3. Monitor CloudWatch Events. Select the check box to integrate Application Insights monitoring with CloudWatch Events to get insights from Amazon EBS, Amazon EC2, AWS CodeDeploy, Amazon ECS, AWS Health APIs And Notiﬁcations, Amazon RDS, Amazon S3, and AWS Step Functions. 4. Tags — optional. CloudWatch Application Insights supports both tag-based and CloudFormation-based resource groups (with the exception of Auto Scaling groups). For more information, see Working with Tag Editor. 5. Choose Next. An ARN is generated for the application in the following format.
acw-ug-311	acw-ug.pdf	311	work items (OpsItems) that are related to your AWS resources, provide the Amazon SNS topic ARN. 3. Monitor CloudWatch Events. Select the check box to integrate Application Insights monitoring with CloudWatch Events to get insights from Amazon EBS, Amazon EC2, AWS CodeDeploy, Amazon ECS, AWS Health APIs And Notiﬁcations, Amazon RDS, Amazon S3, and AWS Step Functions. 4. Tags — optional. CloudWatch Application Insights supports both tag-based and CloudFormation-based resource groups (with the exception of Auto Scaling groups). For more information, see Working with Tag Editor. 5. Choose Next. An ARN is generated for the application in the following format. arn:partition:applicationinsights:region:account-id:application/resource- group/resource-group-name Example arn:aws:applicationinsights:us-east-1:123456789012:application/resource-group/ my-resource-group 6. On the Review detected components page, under Review components for monitoring, the table lists the detected components and their associated detected workloads. Set up application for monitoring 1054 Amazon CloudWatch User Guide Note For components that support multiple customized workloads, you can monitor up to ﬁve workloads for each component. These workloads will be monitored separately from the component. Under Associated workloads, there are several possible messages that appear if a workload is not listed. • Couldn't detect workloads – An issue occurred when trying to detect workloads. Make sure that you have completed the Prerequisites to conﬁgure an application for monitoring. If you need to add workloads, choose Edit component. • No workloads detected – We didn't detect any workloads. You may need to add workloads. To do so, choose Edit component. • Not applicable – The component doesn't support customized workloads and will be monitored with default metrics, alarms, and logs. You can't add workloads to these components. 7. To edit a component, select a component, and then choose Edit component. A side panel opens with workloads detected on the component. In this panel, you can edit the component details and add new workloads. Set up application for monitoring 1055 Amazon CloudWatch User Guide • To edit the workload type or name, use the dropdown list. • To add a workload to the component, choose Add new workload. Set up application for monitoring 1056 Amazon CloudWatch User Guide • If Add new workload doesn't appear, this component doesn't support multiple workloads. • If the Associated workloads heading doesn't appear, this component doesn't support customized workloads. • To remove a workload, choose Remove next to the workload that you want to remove from monitoring. • To disable monitoring for the entire component, clear the Monitoring check box. • When you are done editing the component, choose Save changes in the lower right corner. Any changes to workloads for a component are visible on the Review components for monitoring table under Associated workloads. 8. On the Review detected components page, choose Next. 9. The Specify component details page includes all components with customizable associated workloads from the previous step. Set up application for monitoring 1057 Amazon CloudWatch User Guide Note If a component header has an optional tag, additional details for the workloads in that component are optional. If a component doesn't appear on this page, the component doesn't have any additional details that can be speciﬁed in this step. 10.Choose Next. 11.On the Review and submit page, review all monitored component and workload details. 12.Choose Submit. Account-based application monitoring 1. Application name. Enter a name for your account-based application. 2. Automated monitoring of new resources. By default, Application Insights uses recommended settings to conﬁgure monitoring for resource components that are added to your account after you onboard the application. You can exclude monitoring for resources added after onboarding your application by clearing the check box. 3. Monitor CloudWatch Events. Select the check box to integrate Application Insights monitoring with CloudWatch Events to get insights from Amazon EBS, Amazon EC2, AWS CodeDeploy, Amazon ECS, AWS Health APIs And Notiﬁcations, Amazon RDS, Amazon S3, and AWS Step Functions. 4. Integrate with AWS Systems Manager OpsCenter. To view and get notiﬁed when problems are detected for selected applications, select the Generate Systems Manager OpsCenter OpsItems for remedial actions check box. To track the operations that are taken to resolve operational work items (OpsItems) that are related to your AWS resources, provide the SNS topic ARN. 5. Tags — optional. CloudWatch Application Insights supports both tag-based and CloudFormation-based resource groups (with the exception of Auto Scaling groups). For more information, see Working with Tag Editor. 6. Discovered resources. All of the resources discovered in your account are added to this list. If Application Insights is unable to discover all of the resources in your account, Set up application for monitoring 1058 Amazon CloudWatch User Guide an error message appears at the top of the page. This message includes a link to the documentation for how to add the required permissions. 7. Choose Next. An ARN is generated for the application in the following format. arn:partition:applicationinsights:region:account-id:application/ TBD/application-name Example
acw-ug-312	acw-ug.pdf	312	CloudFormation-based resource groups (with the exception of Auto Scaling groups). For more information, see Working with Tag Editor. 6. Discovered resources. All of the resources discovered in your account are added to this list. If Application Insights is unable to discover all of the resources in your account, Set up application for monitoring 1058 Amazon CloudWatch User Guide an error message appears at the top of the page. This message includes a link to the documentation for how to add the required permissions. 7. Choose Next. An ARN is generated for the application in the following format. arn:partition:applicationinsights:region:account-id:application/ TBD/application-name Example arn:aws:applicationinsights:us-east-1:123456789012:application/TBD/my- application 4. After you submit your application monitoring conﬁguration, you will be taken to the details page for the application, where you can view the Application summary, the list of Monitored components and Unmonitored components, and, by selecting the tabs next to Components, the Conﬁguration history, Log patterns, and any Tags that you have applied. To view insights for the application, choose View Insights. You can update your selections for CloudWatch Events monitoring and integration with AWS Systems Manager OpsCenter by choosing Edit. Under Components, you can select the Actions menu to Create, Modify, or Ungroup an instance group. You can manage monitoring for components, including application tier, log groups, event logs, metrics, and custom alarms, by selecting the bullet next to a component and choosing Manage monitoring. Enable Application Insights for Amazon ECS and Amazon EKS resource monitoring You can enable Application Insights to monitor containerized applications and microservices from the Container Insights console. Application Insights supports monitoring for the following resources: • Amazon ECS clusters • Amazon ECS services Set up application for monitoring 1059 Amazon CloudWatch • Amazon ECS tasks • Amazon EKS clusters User Guide When Application Insights is enabled, it provides recommended metrics and logs, detects potential problems, generates CloudWatch Events, and creates automatic dashboards for your containerized applications and microservices. You can enable Application Insights for containerized resources from the Container Insights or Application Insights consoles. Enable Application Insights from the Container Insights console From the Container Insights console, on the Container Insights Performance monitoring dashboard, choose Auto-conﬁgure Application Insights. When Application Insights is enabled, it displays details about detected problems. Enable Application Insights from the Application Insights console When ECS clusters appear in the component list, Application Insights automatically enables additional container monitoring with Container Insights. For EKS clusters, you can enable additional monitoring with Container Insights to provide diagnostics information, such as container restart failures, to help you isolate and resolve problems. Additional steps are required to set up Container Insights for EKS. For information, see Setting up Container Insights on Amazon EKS and Kubernetes for steps to set up Container Insights on EKS. Additional monitoring for EKS with Container Insights is supported on Linux instances with EKS. For more information about Container Insights support for ECS and EKS clusters, see Container Insights. Disable monitoring for an application component To disable monitoring for an application component, from the application details page, select the component for which you want to disable monitoring. Choose Actions, and then Remove from monitoring. Delete an application To delete an application, from the CloudWatch dashboard, on the left navigation pane, choose Application Insights under Insights. Select the application that you want to delete. Under Actions, Set up application for monitoring 1060 Amazon CloudWatch User Guide choose Delete application. This deletes monitoring and deletes all of the saved monitors for application components. The application resources are not deleted. Set up, conﬁgure, and manage your application for monitoring using the command line This section provides steps for setting up, conﬁguring, and managing your application for monitoring using the AWS CLI and AWS Tools for Windows PowerShell. Command line procedures • Add and manage an application • Manage and update monitoring • Conﬁgure monitoring for SQL Always On Availability Groups • Conﬁgure monitoring for MySQL RDS • Conﬁgure monitoring for MySQL EC2 • Conﬁgure monitoring for PostgreSQL RDS • Conﬁgure monitoring for PostgreSQL EC2 • Conﬁgure monitoring for Oracle RDS • Conﬁgure monitoring for Oracle EC2 Add and manage an application You can add, get information about, manage, and conﬁgure your Application Insights application using the command line. Topics • Add an application • Describe an application • List components in an application • Describe a component • Group similar resources into a custom component • Ungroup a custom component • Update an application • Update a custom component Set up application for monitoring 1061 Amazon CloudWatch Add an application Add an application using the AWS CLI User Guide To use the AWS CLI to add an application for your resource group called my-resource-group, with OpsCenter enabled to deliver the created opsItem to the SNS topic ARN arn:aws:sns:us- east-1:123456789012:MyTopic, use the following command. aws application-insights create-application --resource-group-name my-resource-group -- ops-center-enabled
acw-ug-313	acw-ug.pdf	313	Add an application • Describe an application • List components in an application • Describe a component • Group similar resources into a custom component • Ungroup a custom component • Update an application • Update a custom component Set up application for monitoring 1061 Amazon CloudWatch Add an application Add an application using the AWS CLI User Guide To use the AWS CLI to add an application for your resource group called my-resource-group, with OpsCenter enabled to deliver the created opsItem to the SNS topic ARN arn:aws:sns:us- east-1:123456789012:MyTopic, use the following command. aws application-insights create-application --resource-group-name my-resource-group -- ops-center-enabled --ops-item-sns-topic-arn arn:aws:sns:us-east-1:123456789012:MyTopic Add an application using AWS Tools for Windows PowerShell To use AWS Tools for Windows PowerShell to add an application for your resource group called my-resource-group with OpsCenter enabled to deliver the created opsItem to the SNS topic ARN arn:aws:sns:us-east-1:123456789012:MyTopic, use the following command. New-CWAIApplication -ResourceGroupName my-resource-group -OpsCenterEnabled true - OpsItemSNSTopicArn arn:aws:sns:us-east-1:123456789012:MyTopic Describe an application Describe an application using the AWS CLI To use the AWS CLI to describe an application created on a resource group called my-resource- group, use the following command. aws application-insights describe-application --resource-group-name my-resource-group Describe an application using AWS Tools for Windows PowerShell To use the AWS Tools for Windows PowerShell to describe an application created on a resource group called my-resource-group, use the following command. Get-CWAIApplication -ResourceGroupName my-resource-group List components in an application List components in an application using the AWS CLI Set up application for monitoring 1062 Amazon CloudWatch User Guide To use the AWS CLI to list the components created on a resource group called my-resource- group, use the following command. aws application-insights list-components --resource-group-name my-resource-group List components in an application using AWS Tools for Windows PowerShell To use the AWS Tools for Windows PowerShell to list the components created on a resource group called my-resource-group, use the following command. Get-CWAIComponentList -ResourceGroupName my-resource-group Describe a component Describe a component using the AWS CLI You can use the following AWS CLI command to describe a component called my-component that belongs to an application created on a resource group called my-resource-group. aws application-insights describe-component --resource-group-name my-resource-group -- component-name my-component Describe a component using AWS Tools for Windows PowerShell You can use the following AWS Tools for Windows PowerShell command to describe a component called my-component that belongs to an application created on a resource group called my- resource-group. Get-CWAIComponent -ComponentName my-component -ResourceGroupName my-resource-group Group similar resources into a custom component We recommend grouping similar resources, such as .NET web server instances, into custom components for easier onboarding and better monitoring and insights. Currently, CloudWatch Application Insights supports custom groups for EC2 instances. To group resources into a custom component using the AWS CLI To use the AWS CLI to group three instances (arn:aws:ec2:us- east-1:123456789012:instance/i-11111, arn:aws:ec2:us- east-1:123456789012:instance/i-22222, and arn:aws:ec2:us- Set up application for monitoring 1063 Amazon CloudWatch User Guide east-1:123456789012:instance/i-33333) together into a custom component called my- component for an application created for the resource group called my-resource-group, use the following command. aws application-insights create-component --resource-group-name my- resource-group --component-name my-component --resource-list arn:aws:ec2:us- east-1:123456789012:instance/i-11111 arn:aws:ec2:us-east-1:123456789012:instance/ i-22222 arn:aws:ec2:us-east-1:123456789012:instance/i-33333 To group resources into a custom component using AWS Tools for Windows PowerShell To use AWS Tools for Windows PowerShell to group three instances (arn:aws:ec2:us- east-1:123456789012:instance/i-11111, arn:aws:ec2:us- east-1:123456789012:instance/i-22222, and arn:aws:ec2:us- east-1:123456789012:instance/i-33333) together into a custom component called my- component, for an application created for the resource group called my-resource-group, use the following command. New-CWAIComponent -ResourceGroupName my-resource-group -ComponentName my-component -ResourceList arn:aws:ec2:us-east-1:123456789012:instance/i-11111,arn:aws:ec2:us- east-1:123456789012:instance/i-22222,arn:aws:ec2:us-east-1:123456789012:instance/ i-33333 Ungroup a custom component To ungroup a custom component using the AWS CLI To use the AWS CLI to ungroup a custom component named my-component in an application created on the resource group, my-resource-group, use the following command. aws application-insights delete-component --resource-group-name my-resource-group -- component-name my-new-component To ungroup a custom component using AWS Tools for Windows PowerShell To use the AWS Tools for Windows PowerShell to ungroup a custom component named my- component in an application created on the resource group, my-resource-group, use the following command. Remove-CWAIComponent -ComponentName my-component -ResourceGroupName my-resource-group Set up application for monitoring 1064 Amazon CloudWatch Update an application Update an application using the AWS CLI User Guide You can use the AWS CLI to update an application to generate AWS Systems Manager OpsCenter OpsItems for problems detected with the application, and to associate the created OpsItems to the SNS topic arn:aws:sns:us-east-1:123456789012:MyTopic, using the following command. aws application-insights update-application --resource-group-name my-resource-group -- ops-center-enabled --ops-item-sns-topic-arn arn:aws:sns:us-east-1:123456789012:MyTopic Update an application using AWS Tools for Windows PowerShell You can use the AWS Tools for Windows PowerShell to update an application to generate AWS SSM OpsCenter OpsItems for problems detected with the application, and to associate the created OpsItems to the SNS topic arn:aws:sns:us-east-1:123456789012:MyTopic , using the following command. Update-CWAIApplication -ResourceGroupName my-resource-group -OpsCenterEnabled true - OpsItemSNSTopicArn arn:aws:sns:us-east-1:123456789012:MyTopic Update a custom component Update a custom component using the
acw-ug-314	acw-ug.pdf	314	OpsCenter OpsItems for problems detected with the application, and to associate the created OpsItems to the SNS topic arn:aws:sns:us-east-1:123456789012:MyTopic, using the following command. aws application-insights update-application --resource-group-name my-resource-group -- ops-center-enabled --ops-item-sns-topic-arn arn:aws:sns:us-east-1:123456789012:MyTopic Update an application using AWS Tools for Windows PowerShell You can use the AWS Tools for Windows PowerShell to update an application to generate AWS SSM OpsCenter OpsItems for problems detected with the application, and to associate the created OpsItems to the SNS topic arn:aws:sns:us-east-1:123456789012:MyTopic , using the following command. Update-CWAIApplication -ResourceGroupName my-resource-group -OpsCenterEnabled true - OpsItemSNSTopicArn arn:aws:sns:us-east-1:123456789012:MyTopic Update a custom component Update a custom component using the AWS CLI You can use the AWS CLI to update a custom component called my-component with a new component name, my-new-component, and an updated group of instances, by using the following command. aws application-insights update-component --resource-group-name my-resource- group --component-name my-component --new-component-name my-new-component -- resource-list arn:aws:ec2:us-east-1:123456789012:instance/i-44444 arn:aws:ec2:us- east-1:123456789012:instance/i-55555 Update a custom component using AWS Tools for Windows PowerShell You can use the AWS Tools for Windows PowerShell to update a custom component called my-component with a new component name, my-new-component, and an updated group of instances, by using the following command. Set up application for monitoring 1065 Amazon CloudWatch User Guide Update-CWAIComponent -ComponentName my-component -NewComponentName my-new- component -ResourceGroupName my-resource-group -ResourceList arn:aws:ec2:us- east-1:123456789012:instance/i-44444,arn:aws:ec2:us-east-1:123456789012:instance/ i-55555 Manage and update monitoring You can manage and update monitoring for your Application Insights application using the command line. Topics • List problems with your application • Describe an application problem • Describe the anomalies or errors associated with a problem • Describe an anomaly or error with the application • Describe the monitoring conﬁgurations of a component • Describe the recommended monitoring conﬁguration of a component • Update the monitoring conﬁgurations for a component • Remove a speciﬁed resource group from Application Insights monitoring List problems with your application List problems with your application using the AWS CLI To use the AWS CLI to list problems with your application detected between 1,000 and 10,000 milliseconds since Unix Epoch for an application created on a resource group called my-resource- group, use the following command. aws application-insights list-problems --resource-group-name my-resource-group --start- time 1000 --end-time 10000 List problems with your application using AWS Tools for Windows PowerShell To use the AWS Tools for Windows PowerShell to list problems with your application detected between 1,000 and 10,000 milliseconds since Unix Epoch for an application created on a resource group called my-resource-group, use the following command. Set up application for monitoring 1066 Amazon CloudWatch User Guide $startDate = "8/6/2019 3:33:00" $endDate = "8/6/2019 3:34:00" Get-CWAIProblemList -ResourceGroupName my-resource-group -StartTime $startDate - EndTime $endDate Describe an application problem Describe an application problem using the AWS CLI To use the AWS CLI to describe a problem with problem id p-1234567890, use the following command. aws application-insights describe-problem —problem-id p-1234567890 Describe an application problem using AWS Tools for Windows PowerShell To use the AWS Tools for Windows PowerShell to describe a problem with problem id p-1234567890, use the following command. Get-CWAIProblem -ProblemId p-1234567890 Describe the anomalies or errors associated with a problem Describe the anomalies or errors associated with a problem using the AWS CLI To use the AWS CLI to describe the anomalies or errors associated with a problem with problem id p-1234567890, use the following command. aws application-insights describe-problem-observations --problem-id -1234567890 Describe the anomalies or errors associated with a problem using AWS Tools for Windows PowerShell To use the AWS Tools for Windows PowerShell to describe the anomalies or errors associated with a problem with problem id p-1234567890, use the following command. Get-CWAIProblemObservation -ProblemId p-1234567890 Describe an anomaly or error with the application Describe an anomaly or error with the application using the AWS CLI Set up application for monitoring 1067 Amazon CloudWatch User Guide To use the AWS CLI to describe an anomaly or error with the application with the observation id o-1234567890, use the following command. aws application-insights describe-observation —observation-id o-1234567890 Describe an anomaly or error with the application using AWS Tools for Windows PowerShell To use the AWS Tools for Windows PowerShell to describe an anomaly or error with the application with the observation id o-1234567890, use the following command. Get-CWAIObservation -ObservationId o-1234567890 Describe the monitoring conﬁgurations of a component Describe the monitoring conﬁgurations of a component using the AWS CLI To use the AWS CLI to describe the monitoring conﬁguration of a component called my- component in an application created on the resource group my-resource-group, use the following command. aws application-insights describe-component-configuration —resource-group-name my- resource-group —component-name my-component Describe the monitoring conﬁgurations of a component using AWS Tools for Windows PowerShell To use the AWS Tools for Windows PowerShell to describe the monitoring conﬁguration of a component called my-component, in an application created on the resource group my-resource- group, use the following command. Get-CWAIComponentConfiguration -ComponentName my-component -ResourceGroupName my- resource-group For more
acw-ug-315	acw-ug.pdf	315	the monitoring conﬁgurations of a component using the AWS CLI To use the AWS CLI to describe the monitoring conﬁguration of a component called my- component in an application created on the resource group my-resource-group, use the following command. aws application-insights describe-component-configuration —resource-group-name my- resource-group —component-name my-component Describe the monitoring conﬁgurations of a component using AWS Tools for Windows PowerShell To use the AWS Tools for Windows PowerShell to describe the monitoring conﬁguration of a component called my-component, in an application created on the resource group my-resource- group, use the following command. Get-CWAIComponentConfiguration -ComponentName my-component -ResourceGroupName my- resource-group For more information about component conﬁguration and for example JSON ﬁles, see Work with component conﬁgurations. Describe the recommended monitoring conﬁguration of a component Describe the recommended monitoring conﬁguration of a component using the AWS CLI Set up application for monitoring 1068 Amazon CloudWatch User Guide When the component is part of a .NET Worker application, you can use the AWS CLI to describe the recommended monitoring conﬁguration of a component called my-component in an application created on the resource group my-resource-group, by using the following command. aws application-insights describe-component-configuration-recommendation --resource- group-name my-resource-group --component-name my-component --tier DOT_NET_WORKER Describe the recommended monitoring conﬁguration of a component using AWS Tools for Windows PowerShell When the component is part of a .NET Worker application, you can use the AWS Tools for Windows PowerShell to describe the recommended monitoring conﬁguration of a component called my- component in an application created on the resource group my-resource-group, by using the following command. Get-CWAIComponentConfigurationRecommendation -ComponentName my-component - ResourceGroupName my-resource-group -Tier DOT_NET_WORKER For more information about component conﬁguration and for example JSON ﬁles, see Work with component conﬁgurations. Update the monitoring conﬁgurations for a component Update the monitoring conﬁgurations for a component using the AWS CLI To use the AWS CLI to update the component called my-component in an application created on the resource group called my-resource-group, use the following command. The command includes these actions: 1. Enable monitoring for the component. 2. Set the tier of the component to .NET Worker. 3. Update the JSON conﬁguration of the component to read from the local ﬁle configuration.txt. aws application-insights update-component-configuration --resource-group-name my- resource-group --component-name my-component --tier DOT_NET_WORKER --monitor -- component-configuration "file://configuration.txt" Set up application for monitoring 1069 Amazon CloudWatch User Guide Update the monitoring conﬁgurations for a component using the AWS Tools for Windows PowerShell To use the AWS Tools for Windows PowerShell to update the component called my-component in an application created on the resource group called my-resource-group, use the following command. The command includes these actions: 1. Enable monitoring for the component. 2. Set the tier of the component to .NET Worker. 3. Update the JSON conﬁguration of the component to read from the local ﬁle configuration.txt. [string]$config = Get-Content -Path configuration.txt Update-CWAIComponentConfiguration -ComponentName my-component -ResourceGroupName my- resource-group -Tier DOT_NET_WORKER -Monitor 1 -ComponentConfiguration $config For more information about component conﬁguration and for example JSON ﬁles, see Work with component conﬁgurations. Remove a speciﬁed resource group from Application Insights monitoring Remove a speciﬁed resource group from Application Insights monitoring using the AWS CLI To use the AWS CLI to remove an application created on the resource group called my-resource- group from monitoring, use the following command. aws application-insights delete-application --resource-group-name my-resource-group Remove a speciﬁed resource group from Application Insights monitoring using the AWS Tools for Windows PowerShell To use the AWS Tools for Windows PowerShell to remove an application created on the resource group called my-resource-group from monitoring, use the following command. Remove-CWAIApplication -ResourceGroupName my-resource-group Conﬁgure monitoring for SQL Always On Availability Groups 1. Create an application for the resource group with the SQL HA EC2 instances. Set up application for monitoring 1070 Amazon CloudWatch User Guide aws application-insights create-application ‐-region <REGION> ‐-resource-group-name <RESOURCE_GROUP_NAME> 2. Deﬁne the EC2 instances that represent the SQL HA cluster by creating a new application component. aws application-insights create-component ‐-resource-group-name "<RESOURCE_GROUP_NAME>" ‐-component-name SQL_HA_CLUSTER ‐-resource-list "arn:aws:ec2:<REGION>:<ACCOUNT_ID>:instance/<CLUSTER_INSTANCE_1_ID>" "arn:aws:ec2:<REGION>:<ACCOUNT_ID>:instance/<CLUSTER_INSTANCE_2_ID> 3. Conﬁgure the SQL HA component. aws application-insights update-component-configuration ‐-resource-group-name "<RESOURCE_GROUP_NAME>" ‐-region <REGION> ‐-component-name "SQL_HA_CLUSTER" ‐- monitor ‐-tier SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP ‐-monitor ‐-component- configuration '{ "subComponents" : [ { "subComponentType" : "AWS::EC2::Instance", "alarmMetrics" : [ { "alarmMetricName" : "CPUUtilization", "monitor" : true }, { "alarmMetricName" : "StatusCheckFailed", "monitor" : true }, { "alarmMetricName" : "Processor % Processor Time", "monitor" : true }, { "alarmMetricName" : "Memory % Committed Bytes In Use", "monitor" : true }, { "alarmMetricName" : "Memory Available Mbytes", "monitor" : true }, { "alarmMetricName" : "Paging File % Usage", "monitor" : true }, { "alarmMetricName" : "System Processor Queue Length", "monitor" : true }, { "alarmMetricName" : "Network Interface Bytes Total/sec", Set up application for monitoring 1071 Amazon CloudWatch "monitor" : true }, { "alarmMetricName" : "PhysicalDisk % Disk Time", "monitor" : true }, { User Guide "alarmMetricName" : "SQLServer:Buffer Manager Buffer cache hit ratio", "monitor" :
acw-ug-316	acw-ug.pdf	316	}, { "alarmMetricName" : "Processor % Processor Time", "monitor" : true }, { "alarmMetricName" : "Memory % Committed Bytes In Use", "monitor" : true }, { "alarmMetricName" : "Memory Available Mbytes", "monitor" : true }, { "alarmMetricName" : "Paging File % Usage", "monitor" : true }, { "alarmMetricName" : "System Processor Queue Length", "monitor" : true }, { "alarmMetricName" : "Network Interface Bytes Total/sec", Set up application for monitoring 1071 Amazon CloudWatch "monitor" : true }, { "alarmMetricName" : "PhysicalDisk % Disk Time", "monitor" : true }, { User Guide "alarmMetricName" : "SQLServer:Buffer Manager Buffer cache hit ratio", "monitor" : true }, { "alarmMetricName" : "SQLServer:Buffer Manager Page life expectancy", "monitor" : true }, { "alarmMetricName" : "SQLServer:General Statistics Processes blocked", "monitor" : true }, { "alarmMetricName" : "SQLServer:General Statistics User Connections", "monitor" : true }, { "alarmMetricName" : "SQLServer:Locks Number of Deadlocks/sec", "monitor" : true }, { "alarmMetricName" : "SQLServer:SQL Statistics Batch Requests/sec", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica File Bytes Received/sec", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Log Bytes Received/sec", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Log remaining for undo", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Log Send Queue", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Mirrored Write Transaction/ sec", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Recovery Queue", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Redo Bytes Remaining", "monitor" : true Set up application for monitoring 1072 Amazon CloudWatch }, { User Guide "alarmMetricName" : "SQLServer:Database Replica Redone Bytes/sec", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Total Log requiring undo", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Transaction Delay", "monitor" : true } ], "windowsEvents" : [ { "logGroupName" : "WINDOWS_EVENTS-Application-<RESOURCE_GROUP_NAME>", "eventName" : "Application", "eventLevels" : [ "WARNING", "ERROR", "CRITICAL", "INFORMATION" ], "monitor" : true }, { "logGroupName" : "WINDOWS_EVENTS-System-<RESOURCE_GROUP_NAME>", "eventName" : "System", "eventLevels" : [ "WARNING", "ERROR", "CRITICAL" ], "monitor" : true }, { "logGroupName" : "WINDOWS_EVENTS-Security-<RESOURCE_GROUP_NAME>", "eventName" : "Security", "eventLevels" : [ "WARNING", "ERROR", "CRITICAL" ], "monitor" : true } ], "logs" : [ { "logGroupName" : "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP- <RESOURCE_GROUP_NAME>", "logPath" : "C:\\Program Files\\Microsoft SQL Server\\MSSQL.MSSQLSERVER\ \MSSQL\\Log\\ERRORLOG", "logType" : "SQL_SERVER", "monitor" : true, "encoding" : "utf-8" } ] }, { "subComponentType" : "AWS::EC2::Volume", "alarmMetrics" : [ { "alarmMetricName" : "VolumeReadBytes", "monitor" : true }, { "alarmMetricName" : "VolumeWriteBytes", "monitor" : true }, { Set up application for monitoring 1073 Amazon CloudWatch User Guide "alarmMetricName" : "VolumeReadOps", "monitor" : true }, { "alarmMetricName" : "VolumeWriteOps", "monitor" : true }, { "alarmMetricName" : "VolumeQueueLength", "monitor" : true }, { "alarmMetricName" : "VolumeThroughputPercentage", "monitor" : true }, { "alarmMetricName" : "BurstBalance", "monitor" : true } ] } ] }' Note Application Insights must ingest Application Event logs (information level) to detect cluster activities such as failover. Conﬁgure monitoring for MySQL RDS 1. Create an application for the resource group with the RDS MySQL database instance. aws application-insights create-application ‐-region <REGION> ‐-resource-group-name <RESOURCE_GROUP_NAME> 2. The error log is enabled by default. The slow query log can be enabled using data parameter groups. For more information, see Accessing the MySQL Slow Query and General Logs. • set slow_query_log = 1 • set log_output = FILE 3. Export the logs to be monitored to CloudWatch logs. For more information, see Publishing MySQL Logs to CloudWatch Logs. 4. Conﬁgure the MySQL RDS component. Set up application for monitoring 1074 Amazon CloudWatch User Guide aws application-insights update-component-configuration ‐-resource-group-name "<RESOURCE_GROUP_NAME>" ‐-region <REGION> ‐-component-name "<DB_COMPONENT_NAME>" ‐-monitor ‐-tier DEFAULT ‐-monitor ‐-component-configuration "{\"alarmMetrics\": [{\"alarmMetricName\":\"CPUUtilization\",\"monitor\":true}],\"logs\":[{\"logType\": \"MYSQL\",\"monitor\":true},{\"logType\": \"MYSQL_SLOW_QUERY\",\"monitor\":false}]}" Conﬁgure monitoring for MySQL EC2 1. Create an application for the resource group with the SQL HA EC2 instances. aws application-insights create-application ‐-region <REGION> ‐-resource-group-name <RESOURCE_GROUP_NAME> 2. The error log is enabled by default. The slow query log can be enabled using data parameter groups. For more information, see Accessing the MySQL Slow Query and General Logs. • set slow_query_log = 1 • set log_output = FILE 3. Conﬁgure the MySQL EC2 component. aws application-insights update-component-configuration ‐-resource-group-name "<RESOURCE_GROUP_NAME>" ‐-region <REGION> ‐-component-name "<DB_COMPONENT_NAME>" ‐-monitor ‐-tier MYSQL ‐-monitor ‐-component-configuration "{\"alarmMetrics\": [{\"alarmMetricName\":\"CPUUtilization\",\"monitor\":true}],\"logs\":[{\"logGroupName \":\"<UNIQUE_LOG_GROUP_NAME>\",\"logPath\":\"C:\\\\ProgramData\\\\MySQL\\\\MySQL Server \\\\Data\\\\<FILE_NAME>.err\",\"logType\":\"MYSQL\",\"monitor\":true, \"encoding\":\"utf-8\"}]}" Conﬁgure monitoring for PostgreSQL RDS 1. Create an application for the resource group with the PostgreSQL RDS database instance. aws application-insights create-application ‐-region <REGION> ‐-resource-group-name <RESOURCE_GROUP_NAME> 2. Publishing PostgreSQL logs to CloudWatch is not enabled by default. To enable monitoring, open the RDS console and select the database to monitor. Choose Modify in the upper right corner, and select the check box labeled PostgreSQL log. Choose Continue to save this setting. Set up application for monitoring 1075 Amazon CloudWatch User Guide 3. Your PostgreSQL logs are exported to CloudWatch. 4. Conﬁgure the PostgreSQL RDS component. aws application-insights update-component-configuration --region <REGION> --resource- group-name <RESOURCE_GROUP_NAME> --component-name <DB_COMPONENT_NAME> --monitor -- tier DEFAULT --component-configuration "{ \"alarmMetrics\":[ { \"alarmMetricName\": \"CPUUtilization\", \"monitor\": true
acw-ug-317	acw-ug.pdf	317	database instance. aws application-insights create-application ‐-region <REGION> ‐-resource-group-name <RESOURCE_GROUP_NAME> 2. Publishing PostgreSQL logs to CloudWatch is not enabled by default. To enable monitoring, open the RDS console and select the database to monitor. Choose Modify in the upper right corner, and select the check box labeled PostgreSQL log. Choose Continue to save this setting. Set up application for monitoring 1075 Amazon CloudWatch User Guide 3. Your PostgreSQL logs are exported to CloudWatch. 4. Conﬁgure the PostgreSQL RDS component. aws application-insights update-component-configuration --region <REGION> --resource- group-name <RESOURCE_GROUP_NAME> --component-name <DB_COMPONENT_NAME> --monitor -- tier DEFAULT --component-configuration "{ \"alarmMetrics\":[ { \"alarmMetricName\": \"CPUUtilization\", \"monitor\": true } ], \"logs\":[ { \"logType\": \"POSTGRESQL\", \"monitor\": true } ] }" Conﬁgure monitoring for PostgreSQL EC2 1. Create an application for the resource group with the PostgreSQL EC2 instance. aws application-insights create-application ‐-region <REGION> ‐-resource-group-name <RESOURCE_GROUP_NAME> 2. Conﬁgure the PostgreSQL EC2 component. aws application-insights update-component-configuration ‐-region <REGION> ‐-resource- group-name <RESOURCE_GROUP_NAME> ‐-component-name <DB_COMPONENT_NAME> ‐-monitor ‐- tier POSTGRESQL ‐-component-configuration "{ \"alarmMetrics\":[ { \"alarmMetricName\":\"CPUUtilization\", \"monitor\":true } ], \"logs\":[ Set up application for monitoring 1076 Amazon CloudWatch User Guide { \"logGroupName\":\"<UNIQUE_LOG_GROUP_NAME>\", \"logPath\":\"/var/lib/pgsql/data/log/\", \"logType\":\"POSTGRESQL\", \"monitor\":true, \"encoding\":\"utf-8\" } ] }" Conﬁgure monitoring for Oracle RDS 1. Create an application for the resource group with the Oracle RDS database instance. aws application-insights create-application ‐-region <REGION> ‐-resource-group-name <RESOURCE_GROUP_NAME> 2. Publishing Oracle logs to CloudWatch is not enabled by default. To enable monitoring, open the RDS console and select the database to monitor. Choose Modify in the upper right corner, and select the check boxes labeled Alert log and Listener log. Choose Continue to save this setting. 3. Your Oracle logs are exported to CloudWatch. 4. Conﬁgure the Oracle RDS component. aws application-insights update-component-configuration --region <REGION> --resource- group-name <RESOURCE_GROUP_NAME> --component-name <DB_COMPONENT_NAME> --monitor -- tier DEFAULT --component-configuration "{ \"alarmMetrics\":[ { \"alarmMetricName\": \"CPUUtilization\", \"monitor\": true } ], \"logs\":[ { \"logType\": \"ORACLE_ALERT\", \"monitor\": true }, { \"logType\": \"ORACLE_LISTENER\", \"monitor\": true Set up application for monitoring 1077 Amazon CloudWatch } ] }" User Guide Conﬁgure monitoring for Oracle EC2 1. Create an application for the resource group with the Oracle EC2 instance. aws application-insights create-application ‐-region <REGION> ‐-resource-group-name <RESOURCE_GROUP_NAME> 2. Conﬁgure the Oracle EC2 component. aws application-insights update-component-configuration ‐-region <REGION> ‐-resource- group-name <RESOURCE_GROUP_NAME> ‐-component-name <DB_COMPONENT_NAME> ‐-monitor ‐- tier ORACLE ‐-component-configuration "{ \"alarmMetrics\":[ { \"alarmMetricName\":\"CPUUtilization\", \"monitor\":true } ], \"logs\":[ { \"logGroupName\":\"<UNIQUE_LOG_GROUP_NAME>\", \"logPath\":\"/opt/oracle/diag/rdbms///trace\", \"logType\":\"ORACLE_ALERT\", \"monitor\":true, }, { \"logGroupName\":\"<UNIQUE_LOG_GROUP_NAME>\", \"logPath\":\"/opt/oracle/diag/tnslsnr/$HOSTNAME/listener/trace/\", \"logType\":\"ORACLE_ALERT\", \"monitor\":true, } ] }" Set up application for monitoring 1078 Amazon CloudWatch User Guide Application Insights CloudWatch Events for detected problems For each application that is added to CloudWatch Application Insights, a CloudWatch event is published for the following events on a best eﬀort basis: • Problem creation. Emitted when CloudWatch Application Insights detects a new problem. • Detail Type: "Application Insights Problem Detected" • Detail: • problemId: The detected problem ID. • region: The AWS Region where the problem was created. • resourceGroupName: The Resource Group for the registered application for which the problem was detected. • status: The status of the problem. Possible status and deﬁnitions are as follows: • In progress: A new problem has been identiﬁed. The problem is still receiving observations. • Recovering: The problem is stabilizing. You can manually resolve the problem when it is in this state. • Resolved: The problem is resolved. There are no new observations about this problem. • Recurring: The problem was resolved within the past 24 hours. It has reopened as a result of additional observations. • severity: The severity of the problem. • problemUrl: The console URL for the problem. • Problem update. Emitted when the problem is updated with a new observation or when an existing observation is updated and the problem is subsequently updated; updates include a resolution or closure of the problem. • Detail Type: "Application Insights Problem Updated" • Detail: • problemId: The created problem ID. • region: The AWS Region where the problem was created. • resourceGroupName: The Resource Group for the registered application for which the problem was detected. Set up application for monitoring • status: The status of the problem. 1079 Amazon CloudWatch User Guide • severity: The severity of the problem. • problemUrl: The console URL for the problem. Receive notiﬁcations for detected problems You can use Amazon SNS notiﬁcations, Systems Manager OpsCenter, or CloudWatch Events to receive notiﬁcations about problems that are detected in your applications. CloudWatch Application Insights Amazon SNS notiﬁcations for detected problems You can conﬁgure Amazon SNS notiﬁcations using the AWS Management Console or the AWS CLI. To set up notiﬁcations using the AWS Management Console, you must have the necessary Amazon SNS permissions as shown in the following example. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "sns:ListTopics", "sns:Subscribe", "sns:CreateTopic" ], "Resource": [ "*" ] } ] } After you set up Amazon SNS notiﬁcations, you receive email notiﬁcations when a problem is created or resolved. You
acw-ug-318	acw-ug.pdf	318	CloudWatch Events to receive notiﬁcations about problems that are detected in your applications. CloudWatch Application Insights Amazon SNS notiﬁcations for detected problems You can conﬁgure Amazon SNS notiﬁcations using the AWS Management Console or the AWS CLI. To set up notiﬁcations using the AWS Management Console, you must have the necessary Amazon SNS permissions as shown in the following example. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "sns:ListTopics", "sns:Subscribe", "sns:CreateTopic" ], "Resource": [ "*" ] } ] } After you set up Amazon SNS notiﬁcations, you receive email notiﬁcations when a problem is created or resolved. You also receive notiﬁcations when a new observation is added to an existing problem. The following example shows the content of an email notiﬁcation. You are receiving this email because Problem "p-1234567" has been CREATED by Amazon CloudWatch Application Insights Set up application for monitoring 1080 Amazon CloudWatch User Guide Problem Details: Problem URL: https:////console.aws.amazon.com/cloudwatch/home?region=us- east-1#settings:AppInsightsSettings/problemDetails?problemId=p-1234567 Problem Summary: Title of the problem Severity: HIGH Insights: Something specific is broken Status : RESOLVED AffectedResource: arn:aws:ec2:us-east-1:555555555555:host/testResource Region: us-east-1 RecurringCount: 0 StartTime: 2019-03-23T10:42:57.777Z LastUpdatedTime: 2019-03-23T21:49:37.777Z LastRecurrenceTime: StopTime: 2019-03-23T21:49:37.777Z Recent Issues - TelemetryArn:alarm1 StartTime: 2024-08-15T22:12:46.007Z StopTime: - TelemetryArn:log-group1 StartTime: 2024-08-15T22:12:46.007Z StopTime: 2024-08-15T22:12:46.007Z How to receive problem notiﬁcations using Systems Manager Actions through AWS Systems Manager. CloudWatch Application Insights provides built-in integration with Systems Manager OpsCenter. If you choose to use this integration for your application, an OpsItem is created on the OpsCenter console for every problem detected with the application. From the OpsCenter console, you can view summarized information about the problem detected by CloudWatch Application Insights and pick a Systems Manager Automation runbook to take remedial actions or further identify Windows processes that are causing resource issues in your application. How to receive problem notiﬁcations using CloudWatch Events From the CloudWatch console, select Rules under Events in the left navigation pane. From the Rules page, select Create rule. Choose Amazon CloudWatch Application Insights from the Service Name dropdown list and choose the Event Type. Then, choose Add target and select the target and parameters, for example, an SNS topic or Lambda function. Set up application for monitoring 1081 Amazon CloudWatch User Guide Application Insights cross-account observability With CloudWatch Application Insights cross-account observability, you can monitor and troubleshoot your applications that span multiple AWS accounts within a single Region. You can use Amazon CloudWatch Observability Access Manager to set up one or more of your AWS accounts as a monitoring account. You’ll provide the monitoring account with the ability to view data in your source account by creating a sink in your monitoring account. You use the sink to create a link from your source account to your monitoring account. For more information, see CloudWatch cross-account observability. Required resources For proper functionality of CloudWatch Application Insights cross-account observability, ensure that the following telemetry types are shared through the CloudWatch Observability Access Manager. • Applications in CloudWatch Application Insights • Metrics in Amazon CloudWatch • Log groups in Amazon CloudWatch Logs • Traces in AWS X-Ray Work with component conﬁgurations A component conﬁguration is a text ﬁle in JSON format that describes the conﬁguration settings of the component. This section provides an example template fragment, descriptions of component conﬁguration sections, and example component conﬁgurations. Topics • Component conﬁguration template fragment • Component conﬁguration sections • Component conﬁguration examples Component conﬁguration template fragment The following example shows a template fragment in JSON format. Application Insights cross-account observability 1082 Amazon CloudWatch User Guide { "alarmMetrics" : [ list of alarm metrics ], "logs" : [ list of logs ], "processes" : [ list of processes ], "windowsEvents" : [ list of windows events channels configurations ], "alarms" : [ list of CloudWatch alarms ], "jmxPrometheusExporter": { JMX Prometheus Exporter configuration }, "hanaPrometheusExporter": { SAP HANA Prometheus Exporter configuration }, "haClusterPrometheusExporter": { HA Cluster Prometheus Exporter configuration }, "netWeaverPrometheusExporter": { SAP NetWeaver Prometheus Exporter configuration }, "subComponents" : [ { "subComponentType" : "AWS::EC2::Instance" ... component nested instances configuration }, { "subComponentType" : "AWS::EC2::Volume" ... component nested volumes configuration } ] } Work with component conﬁgurations 1083 Amazon CloudWatch User Guide Component conﬁguration sections A component conﬁguration includes several major sections. Sections in a component conﬁguration can be listed in any order. • alarmMetrics (optional) A list of metrics to monitor for the component. All component types can have an alarmMetrics section. • logs (optional) A list of logs to monitor for the component. Only EC2 instances can have a logs section. • processes (optional) A list of processes to monitor for the component. Only EC2 instances can have a processes section. • subComponents (optional) Nested instance and volume subComponent conﬁguration for the component. The following types of components can have nested instances and a subComponents section: ELB, ASG, custom-grouped EC2 instances , and EC2 instances. • alarms (optional) A
acw-ug-319	acw-ug.pdf	319	any order. • alarmMetrics (optional) A list of metrics to monitor for the component. All component types can have an alarmMetrics section. • logs (optional) A list of logs to monitor for the component. Only EC2 instances can have a logs section. • processes (optional) A list of processes to monitor for the component. Only EC2 instances can have a processes section. • subComponents (optional) Nested instance and volume subComponent conﬁguration for the component. The following types of components can have nested instances and a subComponents section: ELB, ASG, custom-grouped EC2 instances , and EC2 instances. • alarms (optional) A list of alarms to monitor for the component. All component types can have an alarm section. • windowsEvents (optional) A list of windows events to monitor for the component. Only Windows on EC2 instances have a windowsEvents section. • JMXPrometheusExporter (optional) JMXPrometheus Exporter conﬁguration. • hanaPrometheusExporter (optional) SAP HANA Prometheus Exporter conﬁguration. • haClusterPrometheusExporter (optional) HA Cluster Prometheus Exporter conﬁguration. • netWeaverPrometheusExporter (optional) Work with component conﬁgurations 1084 Amazon CloudWatch User Guide SAP NetWeaver Prometheus Exporter conﬁguration. • sapAsePrometheusExporter (optional) SAP ASE Prometheus Exporter conﬁguration. The following example shows the syntax for the subComponents section fragment in JSON format. [ { "subComponentType" : "AWS::EC2::Instance", "alarmMetrics" : [ list of alarm metrics ], "logs" : [ list of logs ], "processes": [ list of processes ], "windowsEvents" : [ list of windows events channels configurations ] }, { "subComponentType" : "AWS::EC2::Volume", "alarmMetrics" : [ list of alarm metrics ] } ] Component conﬁguration section properties This section describes the properties of each component conﬁguration section. Sections • Metric • Log • Process Work with component conﬁgurations 1085 Amazon CloudWatch User Guide • JMX Prometheus Exporter • HANA Prometheus Exporter • HA Cluster Prometheus Exporter • NetWeaver Prometheus Exporter • SAP ASE Prometheus Exporter • Windows Events • Alarm Metric Deﬁnes a metric to be monitored for the component. JSON { "alarmMetricName" : "monitoredMetricName", "monitor" : true/false } Properties • alarmMetricName (required) The name of the metric to be monitored for the component. For metrics supported by Application Insights, see Logs and metrics supported by Amazon CloudWatch Application Insights. • monitor (optional) Boolean to indicate whether to monitor the metric. The default value is true. Log Deﬁnes a log to be monitored for the component. JSON { "logGroupName" : "logGroupName", "logPath" : "logPath", Work with component conﬁgurations 1086 Amazon CloudWatch User Guide "logType" : "logType", "encoding" : "encodingType", "monitor" : true/false } Properties • logGroupName (required) The CloudWatch log group name to be associated to the monitored log. For the log group name constraints, see CreateLogGroup. • logPath (required for EC2 instance components; not required for components that do not use CloudWatch Agent, such as AWS Lambda) The path of the logs to be monitored. The log path must be an absolute Windows system ﬁle path. For more information, see CloudWatch Agent Conﬁguration File: Logs Section. • logType (required) The log type decides the log patterns against which Application Insights analyzes the log. The log type is selected from the following: • SQL_SERVER • MYSQL • MYSQL_SLOW_QUERY • POSTGRESQL • ORACLE_ALERT • ORACLE_LISTENER • IIS • APPLICATION • WINDOWS_EVENTS • WINDOWS_EVENTS_ACTIVE_DIRECTORY • WINDOWS_EVENTS_DNS • WINDOWS_EVENTS_IIS • WINDOWS_EVENTS_SHAREPOINT • SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP • SQL_SERVER_FAILOVER_CLUSTER_INSTANCE Work with component conﬁgurations 1087 User Guide Amazon CloudWatch • DEFAULT • CUSTOM • STEP_FUNCTION • API_GATEWAY_ACCESS • API_GATEWAY_EXECUTION • SAP_HANA_LOGS • SAP_HANA_TRACE • SAP_HANA_HIGH_AVAILABILITY • SAP_NETWEAVER_DEV_TRACE_LOGS • PACEMAKER_HIGH_AVAILABILITY • encoding (optional) The type of encoding of the logs to be monitored. The speciﬁed encoding should be included in the list of CloudWatch agent supported encodings. If not provided, CloudWatch Application Insights uses the default encoding of type utf-8, except for: • SQL_SERVER: utf-16 encoding • IIS: ascii encoding • monitor (optional) Boolean that indicates whether to monitor the logs. The default value is true. Process Deﬁnes a process to be monitored for the component. JSON { "processName" : "monitoredProcessName", "alarmMetrics" : [ list of alarm metrics ] } Properties Work with component conﬁgurations 1088 Amazon CloudWatch • processName (required) User Guide The name of the process to be monitored for the component. The process name must not contain a process stem, such as sqlservr or sqlservr.exe. • alarmMetrics (required) A list of metrics to monitor for this process. To view process metrics supported by CloudWatch Application Insights, see Amazon Elastic Compute Cloud (EC2) . JMX Prometheus Exporter Deﬁnes the JMX Prometheus Exporter settings. JSON "JMXPrometheusExporter": { "jmxURL" : "JMX URL", "hostPort" : "The host and port", "prometheusPort" : "Target port to emit Prometheus metrics" } Properties • jmxURL (optional) A complete JMX URL to connect to. • hostPort (optional) The host and port to connect to through remote JMX. Only one of jmxURL and hostPort can be speciﬁed. • prometheusPort (optional) The target port to send Prometheus metrics to. If
acw-ug-320	acw-ug.pdf	320	list of metrics to monitor for this process. To view process metrics supported by CloudWatch Application Insights, see Amazon Elastic Compute Cloud (EC2) . JMX Prometheus Exporter Deﬁnes the JMX Prometheus Exporter settings. JSON "JMXPrometheusExporter": { "jmxURL" : "JMX URL", "hostPort" : "The host and port", "prometheusPort" : "Target port to emit Prometheus metrics" } Properties • jmxURL (optional) A complete JMX URL to connect to. • hostPort (optional) The host and port to connect to through remote JMX. Only one of jmxURL and hostPort can be speciﬁed. • prometheusPort (optional) The target port to send Prometheus metrics to. If not speciﬁed, the default port 9404 is used. HANA Prometheus Exporter Deﬁnes the HANA Prometheus Exporter settings. JSON Work with component conﬁgurations 1089 Amazon CloudWatch User Guide "hanaPrometheusExporter": { "hanaSid": "SAP HANA SID", "hanaPort": "HANA database port", "hanaSecretName": "HANA secret name", "prometheusPort": "Target port to emit Prometheus metrics" } Properties • hanaSid The three-character SAP system ID (SID) of the SAP HANA system. • hanaPort The HANA database port by which the exporter will query HANA metrics. • hanaSecretName The AWS Secrets Manager secret that stores HANA monitoring user credentials. The HANA Prometheus exporter uses these credentials to connect to the database and query HANA metrics. • prometheusPort (optional) The target port to which Prometheus sends metrics. If not speciﬁed, the default port 9668 is used. HA Cluster Prometheus Exporter Deﬁnes the HA Cluster Prometheus Exporter settings. JSON "haClusterPrometheusExporter": { "prometheusPort": "Target port to emit Prometheus metrics" } Properties • prometheusPort (optional) The target port to which Prometheus sends metrics. If not speciﬁed, the default port 9664 is used. Work with component conﬁgurations 1090 Amazon CloudWatch NetWeaver Prometheus Exporter Deﬁnes the NetWeaver Prometheus Exporter settings. JSON User Guide "netWeaverPrometheusExporter": { "sapSid": "SAP NetWeaver SID", "instanceNumbers": [ "Array of instance Numbers of SAP NetWeaver system "], "prometheusPort": "Target port to emit Prometheus metrics" } Properties • sapSid The 3 character SAP system ID (SID) of the SAP NetWeaver system. • instanceNumbers Array of the instance Numbers of SAP NetWeaver system. Example: "instanceNumbers": [ "00", "01"] • prometheusPort (optional) The target port to which to send Prometheus metrics. If not speciﬁed, the default port 9680 is used. SAP ASE Prometheus Exporter Deﬁnes the SAP ASE Prometheus Exporter settings. JSON "sapASEPrometheusExporter": { "sapAseSid": "SAP ASE SID", "sapAsePort": "SAP ASE database port", "sapAseSecretName": "SAP ASE secret name", "prometheusPort": "Target port to emit Prometheus metrics", "agreeToEnableASEMonitoring": true } Work with component conﬁgurations 1091 Amazon CloudWatch Properties • sapAseSid User Guide The three-character SAP system ID (SID) of the SAP ASE system. • sapAsePort The SAP ASE database port by which the exporter will query ASE metrics. • sapAseSecretName The AWS Secrets Manager secret that stores ASE monitoring user credentials. The SAP ASE Prometheus exporter uses these credentials to connect to the database and query ASE metrics. • prometheusPort (optional) The target port to which Prometheus sends metrics. If not speciﬁed, the default port 9399 is used. If there is another ASE DB that is using the default port, then we use 9499. Windows Events Deﬁnes Windows Events to log. JSON { "logGroupName" : "logGroupName", "eventName" : "eventName", "eventLevels" : ["ERROR","WARNING","CRITICAL","INFORMATION","VERBOSE"], "monitor" : true/false } Properties • logGroupName (required) The CloudWatch log group name to be associated to the monitored log. For the log group name constraints, see CreateLogGroup. • eventName (required) Work with component conﬁgurations 1092 Amazon CloudWatch User Guide The type of Windows Events to log. It is equivalent to the Windows Event log channel name. For example, System, Security, CustomEventName, etc. This ﬁeld is required for each type of Windows event to log. • eventLevels (required) The levels of event to log. You must specify each level to log. Possible values include INFORMATION, WARNING, ERROR, CRITICAL, and VERBOSE. This ﬁeld is required for each type of Windows Event to log. • monitor (optional) Boolean that indicates whether to monitor the logs. The default value is true. Alarm Deﬁnes a CloudWatch alarm to be monitored for the component. JSON { "alarmName" : "monitoredAlarmName", "severity" : HIGH/MEDIUM/LOW } Properties • alarmName (required) The name of the CloudWatch alarm to be monitored for the component. • severity (optional) Indicates the degree of outage when the alarm goes oﬀ. Component conﬁguration examples The following examples show component conﬁgurations in JSON format for relevant services. Example component conﬁgurations • Amazon DynamoDB table Work with component conﬁgurations 1093 User Guide Amazon CloudWatch • Amazon EC2 Auto Scaling (ASG) • Amazon EKS cluster • Amazon Elastic Compute Cloud (EC2) instance • Amazon Elastic Container Service (Amazon ECS) • Amazon ECS services • Amazon ECS tasks • Amazon Elastic File System (Amazon EFS) • Amazon FSx • Amazon Relational Database Service (RDS) Aurora MySQL • Amazon Relational Database Service (RDS) instance • Amazon Route 53 health check • Amazon Route 53
acw-ug-321	acw-ug.pdf	321	goes oﬀ. Component conﬁguration examples The following examples show component conﬁgurations in JSON format for relevant services. Example component conﬁgurations • Amazon DynamoDB table Work with component conﬁgurations 1093 User Guide Amazon CloudWatch • Amazon EC2 Auto Scaling (ASG) • Amazon EKS cluster • Amazon Elastic Compute Cloud (EC2) instance • Amazon Elastic Container Service (Amazon ECS) • Amazon ECS services • Amazon ECS tasks • Amazon Elastic File System (Amazon EFS) • Amazon FSx • Amazon Relational Database Service (RDS) Aurora MySQL • Amazon Relational Database Service (RDS) instance • Amazon Route 53 health check • Amazon Route 53 hosted zone • Amazon Route 53 Resolver endpoint • Amazon Route 53 Resolver query logging conﬁguration • Amazon S3 bucket • Amazon Simple Queue Service (SQS) • Amazon SNS topic • Amazon Virtual Private Cloud (Amazon VPC) • Amazon VPC Network Address Translation (NAT) gateways • API Gateway REST API stages • Application Elastic Load Balancing • AWS Lambda Function • AWS Network Firewall rule group • AWS Network Firewall rule group association • AWS Step Functions • Customer-grouped Amazon EC2 instances • Elastic Load Balancing • Java • Kubernetes on Amazon EC2 • RDS MariaDB and RDS MySQL Work with component conﬁgurations 1094 User Guide Amazon CloudWatch • RDS Oracle • RDS PostgreSQL • SAP ASE on Amazon EC2 • SAP ASE High Availability on Amazon EC2 • SAP HANA on Amazon EC2 • SAP HANA High Availability on Amazon EC2 • SAP NetWeaver on Amazon EC2 • SAP NetWeaver High Availability on Amazon EC2 • SQL Always On Availability Group • SQL failover cluster instance Amazon DynamoDB table The following example shows a component conﬁguration in JSON format for Amazon DynamoDB table. { "alarmMetrics": [ { "alarmMetricName": "SystemErrors", "monitor": false }, { "alarmMetricName": "UserErrors", "monitor": false }, { "alarmMetricName": "ConsumedReadCapacityUnits", "monitor": false }, { "alarmMetricName": "ConsumedWriteCapacityUnits", "monitor": false }, { "alarmMetricName": "ReadThrottleEvents", "monitor": false }, { Work with component conﬁgurations 1095 Amazon CloudWatch User Guide "alarmMetricName": "WriteThrottleEvents", "monitor": false }, { "alarmMetricName": "ConditionalCheckFailedRequests", "monitor": false }, { "alarmMetricName": "TransactionConflict", "monitor": false } ], "logs": [] } Amazon EC2 Auto Scaling (ASG) The following example shows a component conﬁguration in JSON format for Amazon EC2 Auto Scaling (ASG). { "alarmMetrics" : [ { "alarmMetricName" : "CPUCreditBalance" }, { "alarmMetricName" : "EBSIOBalance%" } ], "subComponents" : [ { "subComponentType" : "AWS::EC2::Instance", "alarmMetrics" : [ { "alarmMetricName" : "CPUUtilization" }, { "alarmMetricName" : "StatusCheckFailed" } ], "logs" : [ { "logGroupName" : "my_log_group", "logPath" : "C:\\LogFolder\\*", "logType" : "APPLICATION" Work with component conﬁgurations 1096 User Guide Amazon CloudWatch } ], "processes" : [ { "processName" : "my_process", "alarmMetrics" : [ { "alarmMetricName" : "procstat cpu_usage", "monitor" : true }, { "alarmMetricName" : "procstat memory_rss", "monitor" : true } ] } ], "windowsEvents" : [ { "logGroupName" : "my_log_group_2", "eventName" : "Application", "eventLevels" : [ "ERROR", "WARNING", "CRITICAL" ] } ] }, { "subComponentType" : "AWS::EC2::Volume", "alarmMetrics" : [ { "alarmMetricName" : "VolumeQueueLength" }, { "alarmMetricName" : "BurstBalance" } ] } ], "alarms" : [ { "alarmName" : "my_asg_alarm", "severity" : "LOW" } ] } Work with component conﬁgurations 1097 Amazon CloudWatch Amazon EKS cluster User Guide The following example shows a component conﬁguration in JSON format for Amazon EKS cluster. { "alarmMetrics":[ { "alarmMetricName": "cluster_failed_node_count", "monitor":true }, { "alarmMetricName": "node_cpu_reserved_capacity", "monitor":true }, { "alarmMetricName": "node_cpu_utilization", "monitor":true }, { "alarmMetricName": "node_filesystem_utilization", "monitor":true }, { "alarmMetricName": "node_memory_reserved_capacity", "monitor":true }, { "alarmMetricName": "node_memory_utilization", "monitor":true }, { "alarmMetricName": "node_network_total_bytes", "monitor":true }, { "alarmMetricName": "pod_cpu_reserved_capacity", "monitor":true }, { "alarmMetricName": "pod_cpu_utilization", "monitor":true }, { "alarmMetricName": "pod_cpu_utilization_over_pod_limit", Work with component conﬁgurations 1098 User Guide Amazon CloudWatch "monitor":true }, { "alarmMetricName": "pod_memory_reserved_capacity", "monitor":true }, { "alarmMetricName": "pod_memory_utilization", "monitor":true }, { "alarmMetricName": "pod_memory_utilization_over_pod_limit", "monitor":true }, { "alarmMetricName": "pod_network_rx_bytes", "monitor":true }, { "alarmMetricName": "pod_network_tx_bytes", "monitor":true } ], "logs":[ { "logGroupName": "/aws/containerinsights/kubernetes/application", "logType":"APPLICATION", "monitor":true, "encoding":"utf-8" } ], "subComponents":[ { "subComponentType":"AWS::EC2::Instance", "alarmMetrics":[ { "alarmMetricName":"CPUUtilization", "monitor":true }, { "alarmMetricName":"StatusCheckFailed", "monitor":true }, { Work with component conﬁgurations 1099 Amazon CloudWatch User Guide "alarmMetricName":"disk_used_percent", "monitor":true }, { "alarmMetricName":"mem_used_percent", "monitor":true } ], "logs":[ { "logGroupName":"APPLICATION-KubernetesClusterOnEC2-IAD", "logPath":"", "logType":"APPLICATION", "monitor":true, "encoding":"utf-8" } ], "processes" : [ { "processName" : "my_process", "alarmMetrics" : [ { "alarmMetricName" : "procstat cpu_usage", "monitor" : true }, { "alarmMetricName" : "procstat memory_rss", "monitor" : true } ] } ], "windowsEvents":[ { "logGroupName":"my_log_group_2", "eventName":"Application", "eventLevels":[ "ERROR", "WARNING", "CRITICAL" ], "monitor":true } ] }, Work with component conﬁgurations 1100 Amazon CloudWatch { "subComponentType":"AWS::AutoScaling::AutoScalingGroup", "alarmMetrics":[ { "alarmMetricName":"CPUCreditBalance", "monitor":true }, { "alarmMetricName":"EBSIOBalance%", "monitor":true User Guide } ] }, { "subComponentType":"AWS::EC2::Volume", "alarmMetrics":[ { "alarmMetricName":"VolumeReadBytes", "monitor":true }, { "alarmMetricName":"VolumeWriteBytes", "monitor":true }, { "alarmMetricName":"VolumeReadOps", "monitor":true }, { "alarmMetricName":"VolumeWriteOps", "monitor":true }, { "alarmMetricName":"VolumeQueueLength", "monitor":true }, { "alarmMetricName":"BurstBalance", "monitor":true } ] } ] Work with component conﬁgurations 1101 Amazon CloudWatch } Note User Guide • The subComponents section of AWS::EC2::Instance, AWS::EC2::Volume, and AWS::AutoScaling::AutoScalingGroup applies only to Amazon EKS cluster running on the EC2
acw-ug-322	acw-ug.pdf	322	true } ] } ], "windowsEvents":[ { "logGroupName":"my_log_group_2", "eventName":"Application", "eventLevels":[ "ERROR", "WARNING", "CRITICAL" ], "monitor":true } ] }, Work with component conﬁgurations 1100 Amazon CloudWatch { "subComponentType":"AWS::AutoScaling::AutoScalingGroup", "alarmMetrics":[ { "alarmMetricName":"CPUCreditBalance", "monitor":true }, { "alarmMetricName":"EBSIOBalance%", "monitor":true User Guide } ] }, { "subComponentType":"AWS::EC2::Volume", "alarmMetrics":[ { "alarmMetricName":"VolumeReadBytes", "monitor":true }, { "alarmMetricName":"VolumeWriteBytes", "monitor":true }, { "alarmMetricName":"VolumeReadOps", "monitor":true }, { "alarmMetricName":"VolumeWriteOps", "monitor":true }, { "alarmMetricName":"VolumeQueueLength", "monitor":true }, { "alarmMetricName":"BurstBalance", "monitor":true } ] } ] Work with component conﬁgurations 1101 Amazon CloudWatch } Note User Guide • The subComponents section of AWS::EC2::Instance, AWS::EC2::Volume, and AWS::AutoScaling::AutoScalingGroup applies only to Amazon EKS cluster running on the EC2 launch type. • The windowsEvents section of AWS::EC2::Instance in subComponents applies only to Windows running on Amazon EC2 instances. Amazon Elastic Compute Cloud (EC2) instance The following example shows a component conﬁguration in JSON format for an Amazon EC2 instance. Important When an Amazon EC2 instance enters a stopped state, it is removed from monitoring. When it returns to a running state, it is added to the list of Unmonitored components on the Application details page of the CloudWatch Application Insights console. If automatic monitoring of new resources is enabled for the application, the instance is added to the list of Monitored components. However, the logs and metrics are set to the default for the workload. The previous log and metrics conﬁguration is not saved. { "alarmMetrics" : [ { "alarmMetricName" : "CPUUtilization", "monitor" : true }, { "alarmMetricName" : "StatusCheckFailed" } ], "logs" : [ { "logGroupName" : "my_log_group", "logPath" : "C:\\LogFolder\\", Work with component conﬁgurations 1102 Amazon CloudWatch User Guide "logType" : "APPLICATION", "monitor" : true }, { "logGroupName" : "my_log_group_2", "logPath" : "C:\\LogFolder2\\", "logType" : "IIS", "encoding" : "utf-8" } ], "processes" : [ { "processName" : "my_process", "alarmMetrics" : [ { "alarmMetricName" : "procstat cpu_usage", "monitor" : true }, { "alarmMetricName" : "procstat memory_rss", "monitor" : true } ] } ], "windowsEvents" : [ { "logGroupName" : "my_log_group_3", "eventName" : "Application", "eventLevels" : [ "ERROR", "WARNING", "CRITICAL" ], "monitor" : true }, { "logGroupName" : "my_log_group_4", "eventName" : "System", "eventLevels" : [ "ERROR", "WARNING", "CRITICAL" ], "monitor" : true }], "alarms" : [ { "alarmName" : "my_instance_alarm_1", "severity" : "HIGH" }, { "alarmName" : "my_instance_alarm_2", "severity" : "LOW" Work with component conﬁgurations 1103 User Guide Amazon CloudWatch } ], "subComponents" : [ { "subComponentType" : "AWS::EC2::Volume", "alarmMetrics" : [ { "alarmMetricName" : "VolumeQueueLength", "monitor" : "true" }, { "alarmMetricName" : "VolumeThroughputPercentage", "monitor" : "true" }, { "alarmMetricName" : "BurstBalance", "monitor" : "true" }] }] } Amazon Elastic Container Service (Amazon ECS) The following example shows a component conﬁguration in JSON format for Amazon Elastic Container Service (Amazon ECS). { "alarmMetrics":[ { "alarmMetricName":"CpuUtilized", "monitor":true }, { "alarmMetricName":"MemoryUtilized", "monitor":true }, { "alarmMetricName":"NetworkRxBytes", "monitor":true }, { "alarmMetricName":"NetworkTxBytes", "monitor":true Work with component conﬁgurations 1104 User Guide Amazon CloudWatch }, { "alarmMetricName":"RunningTaskCount", "monitor":true }, { "alarmMetricName":"PendingTaskCount", "monitor":true }, { "alarmMetricName":"StorageReadBytes", "monitor":true }, { "alarmMetricName":"StorageWriteBytes", "monitor":true } ], "logs":[ { "logGroupName":"/ecs/my-task-definition", "logType":"APPLICATION", "monitor":true } ], "subComponents":[ { "subComponentType":"AWS::ElasticLoadBalancing::LoadBalancer", "alarmMetrics":[ { "alarmMetricName":"HTTPCode_Backend_4XX", "monitor":true }, { "alarmMetricName":"HTTPCode_Backend_5XX", "monitor":true }, { "alarmMetricName":"Latency", "monitor":true }, { "alarmMetricName":"SurgeQueueLength", "monitor":true Work with component conﬁgurations 1105 Amazon CloudWatch }, { "alarmMetricName":"UnHealthyHostCount", "monitor":true User Guide } ] }, { "subComponentType":"AWS::ElasticLoadBalancingV2::LoadBalancer", "alarmMetrics":[ { "alarmMetricName":"HTTPCode_Target_4XX_Count", "monitor":true }, { "alarmMetricName":"HTTPCode_Target_5XX_Count", "monitor":true }, { "alarmMetricName":"TargetResponseTime", "monitor":true }, { "alarmMetricName":"UnHealthyHostCount", "monitor":true } ] }, { "subComponentType":"AWS::EC2::Instance", "alarmMetrics":[ { "alarmMetricName":"CPUUtilization", "monitor":true }, { "alarmMetricName":"StatusCheckFailed", "monitor":true }, { "alarmMetricName":"disk_used_percent", "monitor":true }, { Work with component conﬁgurations 1106 Amazon CloudWatch User Guide "alarmMetricName":"mem_used_percent", "monitor":true } ], "logs":[ { "logGroupName":"my_log_group", "logPath":"/mylog/path", "logType":"APPLICATION", "monitor":true } ], "processes" : [ { "processName" : "my_process", "alarmMetrics" : [ { "alarmMetricName" : "procstat cpu_usage", "monitor" : true }, { "alarmMetricName" : "procstat memory_rss", "monitor" : true } ] } ], "windowsEvents":[ { "logGroupName":"my_log_group_2", "eventName":"Application", "eventLevels":[ "ERROR", "WARNING", "CRITICAL" ], "monitor":true } ] }, { "subComponentType":"AWS::EC2::Volume", "alarmMetrics":[ { "alarmMetricName":"VolumeQueueLength", Work with component conﬁgurations 1107 Amazon CloudWatch User Guide "monitor":"true" }, { "alarmMetricName":"VolumeThroughputPercentage", "monitor":"true" }, { "alarmMetricName":"BurstBalance", "monitor":"true" } ] } ] } Note • The subComponents section of AWS::EC2::Instance and AWS::EC2::Volume applies only to Amazon ECS clusters with ECS service or ECS task running on the EC2 launch type. • The windowsEvents section of AWS::EC2::Instance in subComponents applies only to Windows running on Amazon EC2 instances. Amazon ECS services The following example shows a component conﬁguration in JSON format for an Amazon ECS service. { "alarmMetrics":[ { "alarmMetricName":"CPUUtilization", "monitor":true }, { "alarmMetricName":"MemoryUtilization", "monitor":true }, { "alarmMetricName":"CpuUtilized", Work with component conﬁgurations 1108 User Guide Amazon CloudWatch "monitor":true }, { "alarmMetricName":"MemoryUtilized", "monitor":true }, { "alarmMetricName":"NetworkRxBytes", "monitor":true }, { "alarmMetricName":"NetworkTxBytes", "monitor":true }, { "alarmMetricName":"RunningTaskCount", "monitor":true }, { "alarmMetricName":"PendingTaskCount", "monitor":true }, { "alarmMetricName":"StorageReadBytes", "monitor":true }, { "alarmMetricName":"StorageWriteBytes", "monitor":true } ], "logs":[ { "logGroupName":"/ecs/my-task-definition", "logType":"APPLICATION", "monitor":true } ], "subComponents":[ { "subComponentType":"AWS::ElasticLoadBalancing::LoadBalancer", "alarmMetrics":[ { "alarmMetricName":"HTTPCode_Backend_4XX", Work with component conﬁgurations 1109 Amazon CloudWatch User Guide "monitor":true }, { "alarmMetricName":"HTTPCode_Backend_5XX", "monitor":true },
acw-ug-323	acw-ug.pdf	323	EC2 instances. Amazon ECS services The following example shows a component conﬁguration in JSON format for an Amazon ECS service. { "alarmMetrics":[ { "alarmMetricName":"CPUUtilization", "monitor":true }, { "alarmMetricName":"MemoryUtilization", "monitor":true }, { "alarmMetricName":"CpuUtilized", Work with component conﬁgurations 1108 User Guide Amazon CloudWatch "monitor":true }, { "alarmMetricName":"MemoryUtilized", "monitor":true }, { "alarmMetricName":"NetworkRxBytes", "monitor":true }, { "alarmMetricName":"NetworkTxBytes", "monitor":true }, { "alarmMetricName":"RunningTaskCount", "monitor":true }, { "alarmMetricName":"PendingTaskCount", "monitor":true }, { "alarmMetricName":"StorageReadBytes", "monitor":true }, { "alarmMetricName":"StorageWriteBytes", "monitor":true } ], "logs":[ { "logGroupName":"/ecs/my-task-definition", "logType":"APPLICATION", "monitor":true } ], "subComponents":[ { "subComponentType":"AWS::ElasticLoadBalancing::LoadBalancer", "alarmMetrics":[ { "alarmMetricName":"HTTPCode_Backend_4XX", Work with component conﬁgurations 1109 Amazon CloudWatch User Guide "monitor":true }, { "alarmMetricName":"HTTPCode_Backend_5XX", "monitor":true }, { "alarmMetricName":"Latency", "monitor":true }, { "alarmMetricName":"SurgeQueueLength", "monitor":true }, { "alarmMetricName":"UnHealthyHostCount", "monitor":true } ] }, { "subComponentType":"AWS::ElasticLoadBalancingV2::LoadBalancer", "alarmMetrics":[ { "alarmMetricName":"HTTPCode_Target_4XX_Count", "monitor":true }, { "alarmMetricName":"HTTPCode_Target_5XX_Count", "monitor":true }, { "alarmMetricName":"TargetResponseTime", "monitor":true }, { "alarmMetricName":"UnHealthyHostCount", "monitor":true } ] }, { "subComponentType":"AWS::EC2::Instance", "alarmMetrics":[ Work with component conﬁgurations 1110 User Guide Amazon CloudWatch { "alarmMetricName":"CPUUtilization", "monitor":true }, { "alarmMetricName":"StatusCheckFailed", "monitor":true }, { "alarmMetricName":"disk_used_percent", "monitor":true }, { "alarmMetricName":"mem_used_percent", "monitor":true } ], "logs":[ { "logGroupName":"my_log_group", "logPath":"/mylog/path", "logType":"APPLICATION", "monitor":true } ], "processes" : [ { "processName" : "my_process", "alarmMetrics" : [ { "alarmMetricName" : "procstat cpu_usage", "monitor" : true }, { "alarmMetricName" : "procstat memory_rss", "monitor" : true } ] } ], "windowsEvents":[ { "logGroupName":"my_log_group_2", "eventName":"Application", "eventLevels":[ Work with component conﬁgurations 1111 Amazon CloudWatch User Guide "ERROR", "WARNING", "CRITICAL" ], "monitor":true } ] }, { "subComponentType":"AWS::EC2::Volume", "alarmMetrics":[ { "alarmMetricName":"VolumeQueueLength", "monitor":"true" }, { "alarmMetricName":"VolumeThroughputPercentage", "monitor":"true" }, { "alarmMetricName":"BurstBalance", "monitor":"true" } ] } ] } Note • The subComponents section of AWS::EC2::Instance and AWS::EC2::Volume applies only to Amazon ECS running on the EC2 launch type. • The windowsEvents section of AWS::EC2::Instance in subComponents applies only to Windows running on Amazon EC2 instances. Amazon ECS tasks The following example shows a component conﬁguration in JSON format for an Amazon ECS task. { Work with component conﬁgurations 1112 User Guide Amazon CloudWatch "logs":[ { "logGroupName":"/ecs/my-task-definition", "logType":"APPLICATION", "monitor":true } ], "processes" : [ { "processName" : "my_process", "alarmMetrics" : [ { "alarmMetricName" : "procstat cpu_usage", "monitor" : true }, { "alarmMetricName" : "procstat memory_rss", "monitor" : true } ] } ] } Amazon Elastic File System (Amazon EFS) The following example shows a component conﬁguration in JSON format for Amazon EFS. { "alarmMetrics": [ { "alarmMetricName": "BurstCreditBalance", "monitor": true }, { "alarmMetricName": "PercentIOLimit", "monitor": true }, { "alarmMetricName": "PermittedThroughput", "monitor": true }, { "alarmMetricName": "MeteredIOBytes", "monitor": true Work with component conﬁgurations 1113 User Guide Amazon CloudWatch }, { "alarmMetricName": "TotalIOBytes", "monitor": true }, { "alarmMetricName": "DataWriteIOBytes", "monitor": true }, { "alarmMetricName": "DataReadIOBytes", "monitor": true }, { "alarmMetricName": "MetadataIOBytes", "monitor": true }, { "alarmMetricName": "ClientConnections", "monitor": true }, { "alarmMetricName": "TimeSinceLastSync", "monitor": true }, { "alarmMetricName": "Throughput", "monitor": true }, { "alarmMetricName": "PercentageOfPermittedThroughputUtilization", "monitor": true }, { "alarmMetricName": "ThroughputIOPS", "monitor": true }, { "alarmMetricName": "PercentThroughputDataReadIOBytes", "monitor": true }, { "alarmMetricName": "PercentThroughputDataWriteIOBytes", "monitor": true Work with component conﬁgurations 1114 User Guide Amazon CloudWatch }, { "alarmMetricName": "PercentageOfIOPSDataReadIOBytes", "monitor": true }, { "alarmMetricName": "PercentageOfIOPSDataWriteIOBytes", "monitor": true }, { "alarmMetricName": "AverageDataReadIOBytesSize", "monitor": true }, { "alarmMetricName": "AverageDataWriteIOBytesSize", "monitor": true } ], "logs": [ { "logGroupName": "/aws/efs/utils", "logType": "EFS_MOUNT_STATUS", "monitor": true, } ] } Amazon FSx The following example shows a component conﬁguration in JSON format for Amazon FSx. { "alarmMetrics": [ { "alarmMetricName": "DataReadBytes", "monitor": true }, { "alarmMetricName": "DataWriteBytes", "monitor": true }, { "alarmMetricName": "DataReadOperations", "monitor": true Work with component conﬁgurations 1115 User Guide Amazon CloudWatch }, { "alarmMetricName": "DataWriteOperations", "monitor": true }, { "alarmMetricName": "MetadataOperations", "monitor": true }, { "alarmMetricName": "FreeStorageCapacity", "monitor": true } ] } Amazon Relational Database Service (RDS) Aurora MySQL The following example shows a component conﬁguration in JSON format for Amazon RDS Aurora MySQL. { "alarmMetrics": [ { "alarmMetricName": "CPUUtilization", "monitor": true }, { "alarmMetricName": "CommitLatency", "monitor": true } ], "logs": [ { "logType": "MYSQL", "monitor": true, }, { "logType": "MYSQL_SLOW_QUERY", "monitor": false } ] } Work with component conﬁgurations 1116 Amazon CloudWatch User Guide Amazon Relational Database Service (RDS) instance The following example shows a component conﬁguration in JSON format for an Amazon RDS instance. { "alarmMetrics" : [ { "alarmMetricName" : "BurstBalance", "monitor" : true }, { "alarmMetricName" : "WriteThroughput", "monitor" : false } ], "alarms" : [ { "alarmName" : "my_rds_instance_alarm", "severity" : "MEDIUM" } ] } Amazon Route 53 health check The following example shows a component conﬁguration in JSON format for Amazon Route 53 health check. { "alarmMetrics": [ { "alarmMetricName": "ChildHealthCheckHealthyCount", "monitor": true }, { "alarmMetricName": "ConnectionTime", "monitor": true }, { "alarmMetricName": "HealthCheckPercentageHealthy", "monitor": true }, Work with component conﬁgurations 1117 User Guide Amazon CloudWatch { "alarmMetricName": "HealthCheckStatus", "monitor": true }, { "alarmMetricName": "SSLHandshakeTime", "monitor": true }, { "alarmMetricName": "TimeToFirstByte", "monitor": true } ] } Amazon Route 53 hosted zone The following example shows a component conﬁguration in JSON format for Amazon Route 53 hosted zone. { "alarmMetrics": [ { "alarmMetricName": "DNSQueries", "monitor": true }, {
acw-ug-324	acw-ug.pdf	324	53 health check The following example shows a component conﬁguration in JSON format for Amazon Route 53 health check. { "alarmMetrics": [ { "alarmMetricName": "ChildHealthCheckHealthyCount", "monitor": true }, { "alarmMetricName": "ConnectionTime", "monitor": true }, { "alarmMetricName": "HealthCheckPercentageHealthy", "monitor": true }, Work with component conﬁgurations 1117 User Guide Amazon CloudWatch { "alarmMetricName": "HealthCheckStatus", "monitor": true }, { "alarmMetricName": "SSLHandshakeTime", "monitor": true }, { "alarmMetricName": "TimeToFirstByte", "monitor": true } ] } Amazon Route 53 hosted zone The following example shows a component conﬁguration in JSON format for Amazon Route 53 hosted zone. { "alarmMetrics": [ { "alarmMetricName": "DNSQueries", "monitor": true }, { "alarmMetricName": "DNSSECInternalFailure", "monitor": true }, { "alarmMetricName": "DNSSECKeySigningKeysNeedingAction", "monitor": true }, { "alarmMetricName": "DNSSECKeySigningKeyMaxNeedingActionAge", "monitor": true }, { "alarmMetricName": "DNSSECKeySigningKeyAge", "monitor": true } ], Work with component conﬁgurations 1118 Amazon CloudWatch "logs": [ { "logGroupName":"/hosted-zone/logs", "logType": "ROUTE53_DNS_PUBLIC_QUERY_LOGS", "monitor": true } ] } Amazon Route 53 Resolver endpoint User Guide The following example shows a component conﬁguration in JSON format for Amazon Route 53 Resolver endpoint. { "alarmMetrics": [ { "alarmMetricName": "EndpointHealthyENICount", "monitor": true }, { "alarmMetricName": "EndpointUnHealthyENICount", "monitor": true }, { "alarmMetricName": "InboundQueryVolume", "monitor": true }, { "alarmMetricName": "OutboundQueryVolume", "monitor": true }, { "alarmMetricName": "OutboundQueryAggregateVolume", "monitor": true } ] } Amazon Route 53 Resolver query logging conﬁguration The following example shows a component conﬁguration in JSON format for Amazon Route 53 Resolver query logging conﬁguration. Work with component conﬁgurations 1119 User Guide Amazon CloudWatch { "logs": [ { "logGroupName": "/resolver-query-log-config/logs", "logType": "ROUTE53_RESOLVER_QUERY_LOGS", "monitor": true } ] } Amazon S3 bucket The following example shows a component conﬁgurations in JSON format for Amazon S3 bucket. { "alarmMetrics" : [ { "alarmMetricName" : "ReplicationLatency", "monitor" : true }, { "alarmMetricName" : "5xxErrors", "monitor" : true }, { "alarmMetricName" : "BytesDownloaded" "monitor" : true } ] } Amazon Simple Queue Service (SQS) The following example shows a component conﬁguration in JSON format for Amazon Simple Queue Service. { "alarmMetrics" : [ { "alarmMetricName" : "ApproximateAgeOfOldestMessage" }, { "alarmMetricName" : "NumberOfEmptyReceives" } ], Work with component conﬁgurations 1120 Amazon CloudWatch "alarms" : [ { "alarmName" : "my_sqs_alarm", "severity" : "MEDIUM" } ] } Amazon SNS topic User Guide The following example shows a component conﬁguration in JSON format for Amazon SNS topic. { "alarmMetrics": [ { "alarmMetricName": "NumberOfNotificationsFailed", "monitor": true }, { "alarmMetricName": "NumberOfNotificationsFilteredOut-InvalidAttributes", "monitor": true }, { "alarmMetricName": "NumberOfNotificationsFilteredOut-NoMessageAttributes", "monitor": true }, { "alarmMetricName": "NumberOfNotificationsFailedToRedriveToDlq", "monitor": true } ] } Amazon Virtual Private Cloud (Amazon VPC) The following example shows a component conﬁguration in JSON format for Amazon VPC. { "alarmMetrics": [ { "alarmMetricName": "NetworkAddressUsage", "monitor": true }, Work with component conﬁgurations 1121 Amazon CloudWatch { "alarmMetricName": "NetworkAddressUsagePeered", "monitor": true }, { "alarmMetricName": "VPCFirewallQueryVolume", "monitor": true } ] } User Guide Amazon VPC Network Address Translation (NAT) gateways The following example shows a component conﬁguration in JSON format for NAT gateways. { "alarmMetrics": [ { "alarmMetricName": "ErrorPortAllocation", "monitor": true }, { "alarmMetricName": "IdleTimeoutCount", "monitor": true } ] } API Gateway REST API stages The following example shows a component conﬁguration in JSON format for API Gateway REST API stages. { "alarmMetrics" : [ { "alarmMetricName" : "4XXError", "monitor" : true }, { "alarmMetricName" : "5XXError", "monitor" : true } Work with component conﬁgurations 1122 User Guide Amazon CloudWatch ], "logs" : [ { "logType" : "API_GATEWAY_EXECUTION", "monitor" : true }, { "logType" : "API_GATEWAY_ACCESS", "monitor" : true } ] } Application Elastic Load Balancing The following example shows a component conﬁguration in JSON format for Application Elastic Load Balancing. { "alarmMetrics": [ { "alarmMetricName": "ActiveConnectionCount", }, { "alarmMetricName": "TargetResponseTime" } ], "subComponents": [ { "subComponentType": "AWS::EC2::Instance", "alarmMetrics": [ { "alarmMetricName": "CPUUtilization", }, { "alarmMetricName": "StatusCheckFailed" } ], "logs": [ { "logGroupName": "my_log_group", "logPath": "C:\\LogFolder\\*", "logType": "APPLICATION", } ], Work with component conﬁgurations 1123 Amazon CloudWatch User Guide "windowsEvents": [ { "logGroupName": "my_log_group_2", "eventName": "Application", "eventLevels": [ "ERROR", "WARNING", "CRITICAL" ] } ] }, { "subComponentType": "AWS::EC2::Volume", "alarmMetrics": [ { "alarmMetricName": "VolumeQueueLength", }, { "alarmMetricName": "BurstBalance" } ] } ], "alarms": [ { "alarmName": "my_alb_alarm", "severity": "LOW" } ] } AWS Lambda Function The following example shows a component conﬁguration in JSON format for AWS Lambda Function. { "alarmMetrics": [ { "alarmMetricName": "Errors", "monitor": true }, { "alarmMetricName": "Throttles", "monitor": true }, { Work with component conﬁgurations 1124 Amazon CloudWatch User Guide "alarmMetricName": "IteratorAge", "monitor": true }, { "alarmMetricName": "Duration", "monitor": true } ], "logs": [ { "logType": "DEFAULT", "monitor": true } ] } AWS Network Firewall rule group The following example shows a component conﬁguration in JSON format for AWS Network Firewall rule group. { "alarmMetrics": [ { "alarmMetricName": "FirewallRuleGroupQueryVolume", "monitor": true } ] } AWS Network Firewall rule group association The following example shows a component conﬁguration in JSON format for AWS Network Firewall rule group association. { "alarmMetrics": [ { "alarmMetricName": "FirewallRuleGroupQueryVolume", "monitor": true } ] Work with component conﬁgurations 1125
acw-ug-325	acw-ug.pdf	325	with component conﬁgurations 1124 Amazon CloudWatch User Guide "alarmMetricName": "IteratorAge", "monitor": true }, { "alarmMetricName": "Duration", "monitor": true } ], "logs": [ { "logType": "DEFAULT", "monitor": true } ] } AWS Network Firewall rule group The following example shows a component conﬁguration in JSON format for AWS Network Firewall rule group. { "alarmMetrics": [ { "alarmMetricName": "FirewallRuleGroupQueryVolume", "monitor": true } ] } AWS Network Firewall rule group association The following example shows a component conﬁguration in JSON format for AWS Network Firewall rule group association. { "alarmMetrics": [ { "alarmMetricName": "FirewallRuleGroupQueryVolume", "monitor": true } ] Work with component conﬁgurations 1125 Amazon CloudWatch } AWS Step Functions User Guide The following example shows a component conﬁgurations in JSON format for AWS Step Functions. { "alarmMetrics": [ { "alarmMetricName": "ExecutionsFailed", "monitor": true }, { "alarmMetricName": "LambdaFunctionsFailed", "monitor": true }, { "alarmMetricName": "ProvisionedRefillRate", "monitor": true } ], "logs": [ { "logGroupName": "/aws/states/HelloWorld-Logs", "logType": "STEP_FUNCTION", "monitor": true, } ] } Customer-grouped Amazon EC2 instances The following example shows a component conﬁguration in JSON format for customer-grouped Amazon EC2 instances. { "subComponents": [ { "subComponentType": "AWS::EC2::Instance", "alarmMetrics": [ { "alarmMetricName": "CPUUtilization", }, Work with component conﬁgurations 1126 User Guide Amazon CloudWatch { "alarmMetricName": "StatusCheckFailed" } ], "logs": [ { "logGroupName": "my_log_group", "logPath": "C:\\LogFolder\\", "logType": "APPLICATION", } ], "processes": [ { "processName": "my_process", "alarmMetrics": [ { "alarmMetricName": "procstat cpu_usage", "monitor": true }, { "alarmMetricName": "procstat memory_rss", "monitor": true } ] } ], "windowsEvents": [ { "logGroupName": "my_log_group_2", "eventName": "Application", "eventLevels": [ "ERROR", "WARNING", "CRITICAL" ] } ] }, { "subComponentType": "AWS::EC2::Volume", "alarmMetrics": [ { "alarmMetricName": "VolumeQueueLength", }, { "alarmMetricName": "BurstBalance" } ] } ], "alarms": [ Work with component conﬁgurations 1127 Amazon CloudWatch { "alarmName": "my_alarm", "severity": "MEDIUM" } ] } Elastic Load Balancing User Guide The following example shows a component conﬁguration in JSON format for Elastic Load Balancing. { "alarmMetrics": [ { "alarmMetricName": "EstimatedALBActiveConnectionCount" }, { "alarmMetricName": "HTTPCode_Backend_5XX" } ], "subComponents": [ { "subComponentType": "AWS::EC2::Instance", "alarmMetrics": [ { "alarmMetricName": "CPUUtilization" }, { "alarmMetricName": "StatusCheckFailed" } ], "logs": [ { "logGroupName": "my_log_group", "logPath": "C:\\LogFolder\\", "logType": "APPLICATION" } ], "processes": [ { "processName": "my_process", "alarmMetrics": [ { "alarmMetricName": "procstat cpu_usage", Work with component conﬁgurations 1128 Amazon CloudWatch User Guide "monitor": true }, { "alarmMetricName": "procstat memory_rss", "monitor": true } ] } ], "windowsEvents": [ { "logGroupName": "my_log_group_2", "eventName": "Application", "eventLevels": [ "ERROR", "WARNING", "CRITICAL" ], "monitor": true } ] }, { "subComponentType": "AWS::EC2::Volume", "alarmMetrics": [ { "alarmMetricName": "VolumeQueueLength" }, { "alarmMetricName": "BurstBalance" } ] } ], "alarms": [ { "alarmName": "my_elb_alarm", "severity": "HIGH" } ] } Java The following example shows a component conﬁguration in JSON format for Java. { "alarmMetrics": [ { "alarmMetricName": "java_lang_threading_threadcount", "monitor": true Work with component conﬁgurations 1129 Amazon CloudWatch }, { "alarmMetricName": "java_lang_memory_heapmemoryusage_used", User Guide "monitor": true }, { "alarmMetricName": "java_lang_memory_heapmemoryusage_committed", "monitor": true }], "logs": [ ], "JMXPrometheusExporter": { "hostPort": "8686", "prometheusPort": "9404" } } Note Application Insights does not support conﬁguring authentication for Prometheus JMX exporter. For information about how to set up authentication, see the Prometheus JMX exporter example conﬁguration. Kubernetes on Amazon EC2 The following example shows a component conﬁguration in JSON format for Kubernetes on Amazon EC2. { "alarmMetrics":[ { "alarmMetricName":"cluster_failed_node_count", "monitor":true }, { "alarmMetricName":"node_cpu_reserved_capacity", "monitor":true }, { "alarmMetricName":"node_cpu_utilization", "monitor":true }, Work with component conﬁgurations 1130 User Guide Amazon CloudWatch { "alarmMetricName":"node_filesystem_utilization", "monitor":true }, { "alarmMetricName":"node_memory_reserved_capacity", "monitor":true }, { "alarmMetricName":"node_memory_utilization", "monitor":true }, { "alarmMetricName":"node_network_total_bytes", "monitor":true }, { "alarmMetricName":"pod_cpu_reserved_capacity", "monitor":true }, { "alarmMetricName":"pod_cpu_utilization", "monitor":true }, { "alarmMetricName":"pod_cpu_utilization_over_pod_limit", "monitor":true }, { "alarmMetricName":"pod_memory_reserved_capacity", "monitor":true }, { "alarmMetricName":"pod_memory_utilization", "monitor":true }, { "alarmMetricName":"pod_memory_utilization_over_pod_limit", "monitor":true }, { "alarmMetricName":"pod_network_rx_bytes", "monitor":true }, Work with component conﬁgurations 1131 Amazon CloudWatch { "alarmMetricName":"pod_network_tx_bytes", "monitor":true User Guide } ], "logs":[ { "logGroupName":"/aws/containerinsights/kubernetes/application", "logType":"APPLICATION", "monitor":true, "encoding":"utf-8" } ], "subComponents":[ { "subComponentType":"AWS::EC2::Instance", "alarmMetrics":[ { "alarmMetricName":"CPUUtilization", "monitor":true }, { "alarmMetricName":"StatusCheckFailed", "monitor":true }, { "alarmMetricName":"disk_used_percent", "monitor":true }, { "alarmMetricName":"mem_used_percent", "monitor":true } ], "logs":[ { "logGroupName":"APPLICATION-KubernetesClusterOnEC2-IAD", "logPath":"", "logType":"APPLICATION", "monitor":true, "encoding":"utf-8" } ], "processes" : [ Work with component conﬁgurations 1132 Amazon CloudWatch { "processName" : "my_process", "alarmMetrics" : [ { "alarmMetricName" : "procstat cpu_usage", "monitor" : true }, { "alarmMetricName" : "procstat memory_rss", "monitor" : true User Guide } ] } ] }, { "subComponentType":"AWS::EC2::Volume", "alarmMetrics":[ { "alarmMetricName":"VolumeReadBytes", "monitor":true }, { "alarmMetricName":"VolumeWriteBytes", "monitor":true }, { "alarmMetricName":"VolumeReadOps", "monitor":true }, { "alarmMetricName":"VolumeWriteOps", "monitor":true }, { "alarmMetricName":"VolumeQueueLength", "monitor":true }, { "alarmMetricName":"BurstBalance", "monitor":true } ] } ] Work with component conﬁgurations 1133 Amazon CloudWatch } RDS MariaDB and RDS MySQL User Guide The following example shows a component conﬁguration in JSON format for RDS MariaDB and RDS MySQL. { "alarmMetrics": [ { "alarmMetricName": "CPUUtilization", "monitor": true } ], "logs": [ { "logType": "MYSQL", "monitor": true, }, { "logType": "MYSQL_SLOW_QUERY", "monitor": false } ] } RDS Oracle The following example shows a component conﬁguration in JSON format for RDS Oracle. { "alarmMetrics": [ { "alarmMetricName": "CPUUtilization", "monitor": true } ], "logs": [ { "logType": "ORACLE_ALERT", "monitor": true, },
acw-ug-326	acw-ug.pdf	326	"alarmMetricName":"VolumeQueueLength", "monitor":true }, { "alarmMetricName":"BurstBalance", "monitor":true } ] } ] Work with component conﬁgurations 1133 Amazon CloudWatch } RDS MariaDB and RDS MySQL User Guide The following example shows a component conﬁguration in JSON format for RDS MariaDB and RDS MySQL. { "alarmMetrics": [ { "alarmMetricName": "CPUUtilization", "monitor": true } ], "logs": [ { "logType": "MYSQL", "monitor": true, }, { "logType": "MYSQL_SLOW_QUERY", "monitor": false } ] } RDS Oracle The following example shows a component conﬁguration in JSON format for RDS Oracle. { "alarmMetrics": [ { "alarmMetricName": "CPUUtilization", "monitor": true } ], "logs": [ { "logType": "ORACLE_ALERT", "monitor": true, }, { Work with component conﬁgurations 1134 Amazon CloudWatch User Guide "logType": "ORACLE_LISTENER", "monitor": false } ] } RDS PostgreSQL The following example shows a component conﬁgurations in JSON format for RDS PostgreSQL. { "alarmMetrics": [ { "alarmMetricName": "CPUUtilization", "monitor": true } ], "logs": [ { "logType": "POSTGRESQL", "monitor": true } ] } SAP ASE on Amazon EC2 The following example shows a component conﬁguration in JSON format for SAP ASE on Amazon EC2. { "subComponents": [ { "subComponentType": "AWS::EC2::Instance", "alarmMetrics": [ { "alarmMetricName": "asedb_database_availability", "monitor": true }, { "alarmMetricName": "asedb_trunc_log_on_chkpt_enabled", "monitor": true }, Work with component conﬁgurations 1135 Amazon CloudWatch { User Guide "alarmMetricName": "asedb_last_db_backup_age_in_days", "monitor": true }, { "alarmMetricName": "asedb_last_transaction_log_backup_age_in_hours", "monitor": true }, { "alarmMetricName": "asedb_suspected_database", "monitor": true }, { "alarmMetricName": "asedb_db_space_usage_percent", "monitor": true }, { "alarmMetricName": "asedb_db_log_space_usage_percent", "monitor": true }, { "alarmMetricName": "asedb_locked_login", "monitor": true }, { "alarmMetricName": "asedb_data_cache_hit_ratio", "monitor": true } ], "logs": [ { "logGroupName": "SAP_ASE_SERVER_LOGS-my-resource-group", "logPath": "/sybase/SY2/ASE-/install/SY2.log", "logType": "SAP_ASE_SERVER_LOGS", "monitor": true, "encoding": "utf-8" }, { "logGroupName": "SAP_ASE_BACKUP_SERVER_LOGS-my-resource-group", "logPath": "/sybase/SY2/ASE-/install/SY2_BS.log", "logType": "SAP_ASE_BACKUP_SERVER_LOGS", "monitor": true, "encoding": "utf-8" } Work with component conﬁgurations 1136 User Guide Amazon CloudWatch ], "sapAsePrometheusExporter": { "sapAseSid": "ASE", "sapAsePort": "4901", "sapAseSecretName": "ASE_DB_CREDS", "prometheusPort": "9399", "agreeToEnableASEMonitoring": true } SAP ASE High Availability on Amazon EC2 The following example shows a component conﬁguration in JSON format for SAP ASE High Availability on Amazon EC2. { "subComponents": [ { "subComponentType": "AWS::EC2::Instance", "alarmMetrics": [ { "alarmMetricName": "asedb_database_availability", "monitor": true }, { "alarmMetricName": "asedb_trunc_log_on_chkpt_enabled", "monitor": true }, { "alarmMetricName": "asedb_last_db_backup_age_in_days", "monitor": true }, { "alarmMetricName": "asedb_last_transaction_log_backup_age_in_hours", "monitor": true }, { "alarmMetricName": "asedb_suspected_database", "monitor": true }, { "alarmMetricName": "asedb_db_space_usage_percent", "monitor": true }, Work with component conﬁgurations 1137 Amazon CloudWatch { User Guide "alarmMetricName": "asedb_ha_replication_state", "monitor": true }, { "alarmMetricName": "asedb_ha_replication_mode", "monitor": true }, { "alarmMetricName": "asedb_ha_replication_latency_in_minutes", "monitor": true } ], "logs": [ { "logGroupName": "SAP_ASE_SERVER_LOGS-my-resource-group", "logPath": "/sybase/SY2/ASE-/install/SY2.log", "logType": "SAP_ASE_SERVER_LOGS", "monitor": true, "encoding": "utf-8" }, { "logGroupName": "SAP_ASE_BACKUP_SERVER_LOGS-my-resource-group", "logPath": "/sybase/SY2/ASE-/install/SY2_BS.log", "logType": "SAP_ASE_BACKUP_SERVER_LOGS", "monitor": true, "encoding": "utf-8" }, { "logGroupName": "SAP_ASE_REP_SERVER_LOGS-my-resource-group", "logPath": "/sybase/SY2/DM/repservername/repservername.log", "logType": "SAP_ASE_REP_SERVER_LOGS", "monitor": true, "encoding": "utf-8" }, { "logGroupName": "SAP_ASE_RMA_AGENT_LOGS-my-resource-group", "logPath": "/sybase/SY2/DM/RMA-/instances/AgentContainer/logs/", "logType": "SAP_ASE_RMA_AGENT_LOGS", "monitor": true, "encoding": "utf-8" }, { "logGroupName": "SAP_ASE_FAULT_MANAGER_LOGS-my-resource-group", Work with component conﬁgurations 1138 Amazon CloudWatch User Guide "logPath": "/opt/sap/FaultManager/dev_sybdbfm", "logType": "SAP_ASE_FAULT_MANAGER_LOGS", "monitor": true, "encoding": "utf-8" } ], "sapAsePrometheusExporter": { "sapAseSid": "ASE", "sapAsePort": "4901", "sapAseSecretName": "ASE_DB_CREDS", "prometheusPort": "9399", "agreeToEnableASEMonitoring": true } SAP HANA on Amazon EC2 The following example shows a component conﬁguration in JSON format for SAP HANA on Amazon EC2. { "subComponents": [ { "subComponentType": "AWS::EC2::Instance", "alarmMetrics": [ { "alarmMetricName": "hanadb_server_startup_time_variations_seconds", "monitor": true }, { "alarmMetricName": "hanadb_level_5_alerts_count", "monitor": true }, { "alarmMetricName": "hanadb_level_4_alerts_count", "monitor": true }, { "alarmMetricName": "hanadb_out_of_memory_events_count", "monitor": true }, { "alarmMetricName": "hanadb_max_trigger_read_ratio_percent", "monitor": true Work with component conﬁgurations 1139 Amazon CloudWatch }, User Guide { "alarmMetricName": "hanadb_table_allocation_limit_used_percent", "monitor": true }, { "alarmMetricName": "hanadb_cpu_usage_percent", "monitor": true }, { "alarmMetricName": "hanadb_plan_cache_hit_ratio_percent", "monitor": true }, { "alarmMetricName": "hanadb_last_data_backup_age_days", "monitor": true } ], "logs": [ { "logGroupName": "SAP_HANA_TRACE-my-resourge-group", "logPath": "/usr/sap/HDB/HDB00//trace/.trc", "logType": "SAP_HANA_TRACE", "monitor": true, "encoding": "utf-8" }, { "logGroupName": "SAP_HANA_LOGS-my-resource-group", "logPath": "/usr/sap/HDB/HDB00//trace/.log", "logType": "SAP_HANA_LOGS", "monitor": true, "encoding": "utf-8" } ] } ], "hanaPrometheusExporter": { "hanaSid": "HDB", "hanaPort": "30013", "hanaSecretName": "HANA_DB_CREDS", "prometheusPort": "9668" } } Work with component conﬁgurations 1140 Amazon CloudWatch User Guide SAP HANA High Availability on Amazon EC2 The following example shows a component conﬁguration in JSON format for SAP HANA High Availability on Amazon EC2. { "subComponents": [ { "subComponentType": "AWS::EC2::Instance", "alarmMetrics": [ { "alarmMetricName": "hanadb_server_startup_time_variations_seconds", "monitor": true }, { "alarmMetricName": "hanadb_level_5_alerts_count", "monitor": true }, { "alarmMetricName": "hanadb_level_4_alerts_count", "monitor": true }, { "alarmMetricName": "hanadb_out_of_memory_events_count", "monitor": true }, { "alarmMetricName": "ha_cluster_pacemaker_stonith_enabled", "monitor": true } ], "logs": [ { "logGroupName": "SAP_HANA_TRACE-my-resourge-group", "logPath": "/usr/sap/HDB/HDB00//trace/*.trc", "logType": "SAP_HANA_TRACE", "monitor": true, "encoding": "utf-8" }, { "logGroupName": "SAP_HANA_HIGH_AVAILABILITY-my-resource-group", "logPath": "/var/log/pacemaker/pacemaker.log", "logType": "SAP_HANA_HIGH_AVAILABILITY", "monitor": true, Work with component conﬁgurations 1141 Amazon CloudWatch User Guide "encoding": "utf-8" } ] } ], "hanaPrometheusExporter": { "hanaSid": "HDB", "hanaPort": "30013", "hanaSecretName": "HANA_DB_CREDS", "prometheusPort": "9668" }, "haClusterPrometheusExporter": { "prometheusPort": "9664" } } SAP NetWeaver on Amazon EC2 The following example shows a component conﬁguration in JSON format for SAP NetWeaver on Amazon EC2. { "subComponents": [ { "subComponentType": "AWS::EC2::Instance", "alarmMetrics": [ { "alarmMetricName": "CPUUtilization", "monitor": true }, { "alarmMetricName": "StatusCheckFailed", "monitor": true }, { "alarmMetricName": "disk_used_percent", "monitor": true }, { "alarmMetricName": "mem_used_percent", "monitor": true }, { Work with component conﬁgurations 1142 Amazon CloudWatch User
acw-ug-327	acw-ug.pdf	327	"logPath": "/var/log/pacemaker/pacemaker.log", "logType": "SAP_HANA_HIGH_AVAILABILITY", "monitor": true, Work with component conﬁgurations 1141 Amazon CloudWatch User Guide "encoding": "utf-8" } ] } ], "hanaPrometheusExporter": { "hanaSid": "HDB", "hanaPort": "30013", "hanaSecretName": "HANA_DB_CREDS", "prometheusPort": "9668" }, "haClusterPrometheusExporter": { "prometheusPort": "9664" } } SAP NetWeaver on Amazon EC2 The following example shows a component conﬁguration in JSON format for SAP NetWeaver on Amazon EC2. { "subComponents": [ { "subComponentType": "AWS::EC2::Instance", "alarmMetrics": [ { "alarmMetricName": "CPUUtilization", "monitor": true }, { "alarmMetricName": "StatusCheckFailed", "monitor": true }, { "alarmMetricName": "disk_used_percent", "monitor": true }, { "alarmMetricName": "mem_used_percent", "monitor": true }, { Work with component conﬁgurations 1142 Amazon CloudWatch User Guide "alarmMetricName": "sap_alerts_ResponseTime", "monitor": true }, { "alarmMetricName": "sap_alerts_ResponseTimeDialog", "monitor": true }, { "alarmMetricName": "sap_alerts_ResponseTimeDialogRFC", "monitor": true }, { "alarmMetricName": "sap_alerts_DBRequestTime", "monitor": true }, { "alarmMetricName": "sap_alerts_LongRunners", "monitor": true }, { "alarmMetricName": "sap_alerts_AbortedJobs", "monitor": true }, { "alarmMetricName": "sap_alerts_BasisSystem", "monitor": true }, { "alarmMetricName": "sap_alerts_Database", "monitor": true }, { "alarmMetricName": "sap_alerts_Security", "monitor": true }, { "alarmMetricName": "sap_alerts_System", "monitor": true }, { "alarmMetricName": "sap_alerts_QueueTime", "monitor": true }, { Work with component conﬁgurations 1143 Amazon CloudWatch User Guide "alarmMetricName": "sap_alerts_Availability", "monitor": true }, { "alarmMetricName": "sap_start_service_processes", "monitor": true }, { "alarmMetricName": "sap_dispatcher_queue_now", "monitor": true }, { "alarmMetricName": "sap_dispatcher_queue_max", "monitor": true }, { "alarmMetricName": "sap_enqueue_server_locks_max", "monitor": true }, { "alarmMetricName": "sap_enqueue_server_locks_now", "monitor": true }, { "alarmMetricName": "sap_enqueue_server_locks_state", "monitor": true }, { "alarmMetricName": "sap_enqueue_server_replication_state", "monitor": true } ], "logs": [ { "logGroupName": "SAP_NETWEAVER_DEV_TRACE_LOGS-NetWeaver-ML4", "logPath": "/usr/sap/ML4//work/dev_w", "logType": "SAP_NETWEAVER_DEV_TRACE_LOGS", "monitor": true, "encoding": "utf-8" } ] } ], "netWeaverPrometheusExporter": { Work with component conﬁgurations 1144 Amazon CloudWatch User Guide "sapSid": "ML4", "instanceNumbers": [ "00", "11" ], "prometheusPort": "9680" } } SAP NetWeaver High Availability on Amazon EC2 The following example shows a component conﬁguration in JSON format for SAP NetWeaver High Availability on Amazon EC2. { "subComponents": [ { "subComponentType": "AWS::EC2::Instance", "alarmMetrics": [ { "alarmMetricName": "ha_cluster_corosync_ring_errors", "monitor": true }, { "alarmMetricName": "ha_cluster_pacemaker_fail_count", "monitor": true }, { "alarmMetricName": "sap_HA_check_failover_config_state", "monitor": true }, { "alarmMetricName": "sap_HA_get_failover_config_HAActive", "monitor": true }, { "alarmMetricName": "sap_alerts_AbortedJobs", "monitor": true }, { "alarmMetricName": "sap_alerts_Availability", "monitor": true }, Work with component conﬁgurations 1145 Amazon CloudWatch { User Guide "alarmMetricName": "sap_alerts_BasisSystem", "monitor": true }, { "alarmMetricName": "sap_alerts_DBRequestTime", "monitor": true }, { "alarmMetricName": "sap_alerts_Database", "monitor": true }, { "alarmMetricName": "sap_alerts_FrontendResponseTime", "monitor": true }, { "alarmMetricName": "sap_alerts_LongRunners", "monitor": true }, { "alarmMetricName": "sap_alerts_QueueTime", "monitor": true }, { "alarmMetricName": "sap_alerts_ResponseTime", "monitor": true }, { "alarmMetricName": "sap_alerts_ResponseTimeDialog", "monitor": true }, { "alarmMetricName": "sap_alerts_ResponseTimeDialogRFC", "monitor": true }, { "alarmMetricName": "sap_alerts_Security", "monitor": true }, { "alarmMetricName": "sap_alerts_Shortdumps", "monitor": true }, Work with component conﬁgurations 1146 User Guide Amazon CloudWatch { "alarmMetricName": "sap_alerts_SqlError", "monitor": true }, { "alarmMetricName": "sap_alerts_System", "monitor": true }, { "alarmMetricName": "sap_enqueue_server_replication_state", "monitor": true }, { "alarmMetricName": "sap_start_service_processes", "monitor": true } ], "logs": [ { "logGroupName": "SAP_NETWEAVER_DEV_TRACE_LOGS-NetWeaver-PR1", "logPath": "/usr/sap/<SID>/D/work/dev_w", "logType": "SAP_NETWEAVER_DEV_TRACE_LOGS", "monitor": true, "encoding": "utf-8" } ] } ], "haClusterPrometheusExporter": { "prometheusPort": "9664" }, "netWeaverPrometheusExporter": { "sapSid": "PR1", "instanceNumbers": [ "11", "12" ], "prometheusPort": "9680" } } Work with component conﬁgurations 1147 Amazon CloudWatch User Guide SQL Always On Availability Group The following example shows a component conﬁguration in JSON format for SQL Always On Availability Group. { "subComponents" : [ { "subComponentType" : "AWS::EC2::Instance", "alarmMetrics" : [ { "alarmMetricName" : "CPUUtilization", "monitor" : true }, { "alarmMetricName" : "StatusCheckFailed", "monitor" : true }, { "alarmMetricName" : "Processor % Processor Time", "monitor" : true }, { "alarmMetricName" : "Memory % Committed Bytes In Use", "monitor" : true }, { "alarmMetricName" : "Memory Available Mbytes", "monitor" : true }, { "alarmMetricName" : "Paging File % Usage", "monitor" : true }, { "alarmMetricName" : "System Processor Queue Length", "monitor" : true }, { "alarmMetricName" : "Network Interface Bytes Total/sec", "monitor" : true }, { "alarmMetricName" : "PhysicalDisk % Disk Time", "monitor" : true }, { "alarmMetricName" : "SQLServer:Buffer Manager Buffer cache hit ratio", "monitor" : true }, { "alarmMetricName" : "SQLServer:Buffer Manager Page life expectancy", "monitor" : true }, { "alarmMetricName" : "SQLServer:General Statistics Processes blocked", "monitor" : true Work with component conﬁgurations 1148 Amazon CloudWatch }, { User Guide "alarmMetricName" : "SQLServer:General Statistics User Connections", "monitor" : true }, { "alarmMetricName" : "SQLServer:Locks Number of Deadlocks/sec", "monitor" : true }, { "alarmMetricName" : "SQLServer:SQL Statistics Batch Requests/sec", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica File Bytes Received/sec", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Log Bytes Received/sec", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Log remaining for undo", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Log Send Queue", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Mirrored Write Transaction/sec", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Recovery Queue", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Redo Bytes Remaining", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Redone Bytes/sec", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Total Log requiring undo", "monitor" : true }, { "alarmMetricName" :
acw-ug-328	acw-ug.pdf	328	}, { "alarmMetricName" : "SQLServer:Database Replica Log Bytes Received/sec", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Log remaining for undo", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Log Send Queue", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Mirrored Write Transaction/sec", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Recovery Queue", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Redo Bytes Remaining", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Redone Bytes/sec", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Total Log requiring undo", "monitor" : true }, { "alarmMetricName" : "SQLServer:Database Replica Transaction Delay", "monitor" : true } ], "windowsEvents" : [ { "logGroupName" : "WINDOWS_EVENTS-Application-<RESOURCE_GROUP_NAME>", "eventName" : "Application", "eventLevels" : [ "WARNING", "ERROR", "CRITICAL", "INFORMATION" ], Work with component conﬁgurations 1149 Amazon CloudWatch "monitor" : true User Guide }, { "logGroupName" : "WINDOWS_EVENTS-System-<RESOURCE_GROUP_NAME>", "eventName" : "System", "eventLevels" : [ "WARNING", "ERROR", "CRITICAL" ], "monitor" : true }, { "logGroupName" : "WINDOWS_EVENTS-Security-<RESOURCE_GROUP_NAME>", "eventName" : "Security", "eventLevels" : [ "WARNING", "ERROR", "CRITICAL" ], "monitor" : true } ], "logs" : [ { "logGroupName" : "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP-<RESOURCE_GROUP_NAME>", "logPath" : "C:\\Program Files\\Microsoft SQL Server\\MSSQL.MSSQLSERVER\\MSSQL\ \Log\\ERRORLOG", "logType" : "SQL_SERVER", "monitor" : true, "encoding" : "utf-8" } ] }, { "subComponentType" : "AWS::EC2::Volume", "alarmMetrics" : [ { "alarmMetricName" : "VolumeReadBytes", "monitor" : true }, { "alarmMetricName" : "VolumeWriteBytes", "monitor" : true }, { "alarmMetricName" : "VolumeReadOps", "monitor" : true }, { "alarmMetricName" : "VolumeWriteOps", "monitor" : true }, { "alarmMetricName" : "VolumeQueueLength", "monitor" : true }, { "alarmMetricName" : "VolumeThroughputPercentage", "monitor" : true }, { "alarmMetricName" : "BurstBalance", "monitor" : true } ] Work with component conﬁgurations 1150 Amazon CloudWatch } ] } SQL failover cluster instance User Guide The following example shows a component conﬁguration in JSON format for SQL failover cluster instance. { "subComponents" : [ { "subComponentType" : "AWS::EC2::Instance", "alarmMetrics" : [ { "alarmMetricName" : "CPUUtilization", "monitor" : true }, { "alarmMetricName" : "StatusCheckFailed", "monitor" : true }, { "alarmMetricName" : "Processor % Processor Time", "monitor" : true }, { "alarmMetricName" : "Memory % Committed Bytes In Use", "monitor" : true }, { "alarmMetricName" : "Memory Available Mbytes", "monitor" : true }, { "alarmMetricName" : "Paging File % Usage", "monitor" : true }, { "alarmMetricName" : "System Processor Queue Length", "monitor" : true }, { "alarmMetricName" : "Network Interface Bytes Total/sec", "monitor" : true }, { "alarmMetricName" : "PhysicalDisk % Disk Time", "monitor" : true }, { "alarmMetricName" : "Bytes Received/sec", "monitor" : true }, { "alarmMetricName" : "Normal Messages Queue Length/sec", Work with component conﬁgurations 1151 Amazon CloudWatch "monitor" : true }, { "alarmMetricName" : "Urgent Message Queue Length/se", "monitor" : true }, { "alarmMetricName" : "Reconnect Count", "monitor" : true }, { "alarmMetricName" : "Unacknowledged Message Queue Length/sec", User Guide "monitor" : true }, { "alarmMetricName" : "Messages Outstanding", "monitor" : true }, { "alarmMetricName" : "Messages Sent/sec", "monitor" : true }, { "alarmMetricName" : "Database Update Messages/sec", "monitor" : true }, { "alarmMetricName" : "Update Messages/sec", "monitor" : true }, { "alarmMetricName" : "Flushes/sec", "monitor" : true }, { "alarmMetricName" : "Crypto Checkpoints Saved/sec", "monitor" : true }, { "alarmMetricName" : "Crypto Checkpoints Restored/sec", "monitor" : true }, { "alarmMetricName" : "Registry Checkpoints Restored/sec", "monitor" : true }, { "alarmMetricName" : "Registry Checkpoints Saved/sec", "monitor" : true }, { "alarmMetricName" : "Cluster API Calls/sec", "monitor" : true }, { "alarmMetricName" : "Resource API Calls/sec", "monitor" : true }, { Work with component conﬁgurations 1152 Amazon CloudWatch User Guide "alarmMetricName" : "Cluster Handles/sec", "monitor" : true }, { "alarmMetricName" : "Resource Handles/sec", "monitor" : true } ], "windowsEvents" : [ { "logGroupName" : "WINDOWS_EVENTS-Application-<RESOURCE_GROUP_NAME>", "eventName" : "Application", "eventLevels" : [ "WARNING", "ERROR", "CRITICAL"], "monitor" : true }, { "logGroupName" : "WINDOWS_EVENTS-System-<RESOURCE_GROUP_NAME>", "eventName" : "System", "eventLevels" : [ "WARNING", "ERROR", "CRITICAL", "INFORMATION" ], "monitor" : true }, { "logGroupName" : "WINDOWS_EVENTS-Security-<RESOURCE_GROUP_NAME>", "eventName" : "Security", "eventLevels" : [ "WARNING", "ERROR", "CRITICAL" ], "monitor" : true } ], "logs" : [ { "logGroupName" : "SQL_SERVER_FAILOVER_CLUSTER_INSTANCE-<RESOURCE_GROUP_NAME>", "logPath" : "\\\\amznfsxjmzbykwn.mydomain.aws\\SQLDB\\MSSQL.MSSQLSERVER\\MSSQL\ \Log\\ERRORLOG", "logType" : "SQL_SERVER", "monitor" : true, "encoding" : "utf-8" } ] }, { "subComponentType" : "AWS::EC2::Volume", "alarmMetrics" : [ { "alarmMetricName" : "VolumeReadBytes", "monitor" : true }, { "alarmMetricName" : "VolumeWriteBytes", "monitor" : true }, { "alarmMetricName" : "VolumeReadOps", "monitor" : true }, { "alarmMetricName" : "VolumeWriteOps", "monitor" : true Work with component conﬁgurations 1153 User Guide Amazon CloudWatch }, { "alarmMetricName" : "VolumeQueueLength", "monitor" : true }, { "alarmMetricName" : "VolumeThroughputPercentage", "monitor" : true }, { "alarmMetricName" : "BurstBalance", "monitor" : true } ] } ] } Create and conﬁgure CloudWatch Application Insights monitoring using CloudFormation templates You can add Application Insights monitoring, including key metrics and telemetry, to your application, database, and web server, directly from AWS CloudFormation templates. This section provides sample AWS CloudFormation templates in both JSON and YAML formats to
acw-ug-329	acw-ug.pdf	329	{ "alarmMetricName" : "VolumeReadOps", "monitor" : true }, { "alarmMetricName" : "VolumeWriteOps", "monitor" : true Work with component conﬁgurations 1153 User Guide Amazon CloudWatch }, { "alarmMetricName" : "VolumeQueueLength", "monitor" : true }, { "alarmMetricName" : "VolumeThroughputPercentage", "monitor" : true }, { "alarmMetricName" : "BurstBalance", "monitor" : true } ] } ] } Create and conﬁgure CloudWatch Application Insights monitoring using CloudFormation templates You can add Application Insights monitoring, including key metrics and telemetry, to your application, database, and web server, directly from AWS CloudFormation templates. This section provides sample AWS CloudFormation templates in both JSON and YAML formats to help you create and conﬁgure Application Insights monitoring. To view the Application Insights resource and property reference in the AWS CloudFormation User Guide, see ApplicationInsights resource type reference. Sample templates • Create an Application Insights application for the entire AWS CloudFormation stack • Create an Application Insights application with detailed settings • Create an Application Insights application with CUSTOM mode component conﬁguration • Create an Application Insights application with DEFAULT mode component conﬁguration • Create an Application Insights application with DEFAULT_WITH_OVERWRITE mode component conﬁguration Use CloudFormation templates 1154 Amazon CloudWatch User Guide Create an Application Insights application for the entire AWS CloudFormation stack To apply the following template, you must create AWS resources and one or more resource groups from which to create Application Insights applications to monitor those resources. For more information, see Getting started with AWS Resource Groups. The ﬁrst two parts of the following template specify a resource and a resource group. The last part of the template creates an Application Insights application for the resource group, but does not conﬁgure the application or apply monitoring. For more information, see the CreateApplication command details in the Amazon CloudWatch Application Insights API Reference. Template in JSON format { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Test Resource Group stack", "Resources": { "EC2Instance": { "Type": "AWS::EC2::Instance", "Properties": { "ImageId" : "ami-abcd1234efgh5678i", "SecurityGroupIds" : ["sg-abcd1234"] } }, ... "ResourceGroup": { "Type": "AWS::ResourceGroups::Group", "Properties": { "Name": "my_resource_group" } }, "AppInsightsApp": { "Type": "AWS::ApplicationInsights::Application", "Properties": { "ResourceGroupName": "my_resource_group" }, "DependsOn" : "ResourceGroup" } } } Use CloudFormation templates 1155 User Guide Amazon CloudWatch Template in YAML format --- AWSTemplateFormatVersion: '2010-09-09' Description: Test Resource Group stack Resources: EC2Instance: Type: AWS::EC2::Instance Properties: ImageId: ami-abcd1234efgh5678i SecurityGroupIds: - sg-abcd1234 ... ResourceGroup: Type: AWS::ResourceGroups::Group Properties: Name: my_resource_group AppInsightsApp: Type: AWS::ApplicationInsights::Application Properties: ResourceGroupName: my_resource_group DependsOn: ResourceGroup The following template section applies the default monitoring conﬁguration to the Application Insights application. For more information, see the CreateApplication command details in the Amazon CloudWatch Application Insights API Reference. When AutoConfigurationEnabled is set to true, all components of the application are conﬁgured with the recommended monitoring settings for the DEFAULT application tier. For more information about these settings and tiers, see DescribeComponentConﬁgurationRecommendation and UpdateComponentConﬁguration in the Amazon CloudWatch Application Insights API Reference. Template in JSON format { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Test Application Insights Application stack", "Resources": { "AppInsightsApp": { "Type": "AWS::ApplicationInsights::Application", "Properties": { "ResourceGroupName": "my_resource_group", Use CloudFormation templates 1156 Amazon CloudWatch User Guide "AutoConfigurationEnabled": true } } } } Template in YAML format --- AWSTemplateFormatVersion: '2010-09-09' Description: Test Application Insights Application stack Resources: AppInsightsApp: Type: AWS::ApplicationInsights::Application Properties: ResourceGroupName: my_resource_group AutoConfigurationEnabled: true Create an Application Insights application with detailed settings The following template performs these actions: • Creates an Application Insights application with CloudWatch Events notiﬁcation and OpsCenter enabled. For more information, see the CreateApplication command details in the Amazon CloudWatch Application Insights API Reference. • Tags the application with two tags, one of which has no tag values. For more information, see TagResource in the Amazon CloudWatch Application Insights API Reference. • Creates two custom instance group components. For more information, see CreateComponent in the Amazon CloudWatch Application Insights API Reference. • Creates two log pattern sets. For more information, see CreateLogPattern in the Amazon CloudWatch Application Insights API Reference. • Sets AutoConfigurationEnabled to true, which conﬁgures all components of the application with the recommended monitoring settings for the DEFAULT tier. For more information, see DescribeComponentConﬁgurationRecommendation in the Amazon CloudWatch Application Insights API Reference. Template in JSON format { Use CloudFormation templates 1157 Amazon CloudWatch User Guide "Type": "AWS::ApplicationInsights::Application", "Properties": { "ResourceGroupName": "my_resource_group", "CWEMonitorEnabled": true, "OpsCenterEnabled": true, "OpsItemSNSTopicArn": "arn:aws:sns:us-east-1:123456789012:my_topic", "AutoConfigurationEnabled": true, "Tags": [ { "Key": "key1", "Value": "value1" }, { "Key": "key2", "Value": "" } ], "CustomComponents": [ { "ComponentName": "test_component_1", "ResourceList": [ "arn:aws:ec2:us-east-1:123456789012:instance/i-abcd1234efgh5678i" ] }, { "ComponentName": "test_component_2", "ResourceList": [ "arn:aws:ec2:us-east-1:123456789012:instance/i-abcd1234efgh5678i", "arn:aws:ec2:us-east-1:123456789012:instance/i-abcd1234efgh5678i" ] } ], "LogPatternSets": [ { "PatternSetName": "pattern_set_1", "LogPatterns": [ { "PatternName": "deadlock_pattern", "Pattern": ".\\sDeadlocked\\sSchedulers(([^\\w].)\|($))", "Rank": 1 } ] }, { Use CloudFormation templates 1158 Amazon CloudWatch User Guide "PatternSetName": "pattern_set_2", "LogPatterns": [ { "PatternName": "error_pattern", "Pattern": ".[\\s\\[]ERROR[\\s\\]].", "Rank": 1 }, { "PatternName": "warning_pattern", "Pattern": ".[\\s\\[]WARN(ING)?[\\s\\]].", "Rank": 10 } ] } ] } } Template in YAML format --- Type: AWS::ApplicationInsights::Application Properties: ResourceGroupName: my_resource_group CWEMonitorEnabled: true OpsCenterEnabled: true OpsItemSNSTopicArn: arn:aws:sns:us-east-1:123456789012:my_topic AutoConfigurationEnabled: true
acw-ug-330	acw-ug.pdf	330	"key1", "Value": "value1" }, { "Key": "key2", "Value": "" } ], "CustomComponents": [ { "ComponentName": "test_component_1", "ResourceList": [ "arn:aws:ec2:us-east-1:123456789012:instance/i-abcd1234efgh5678i" ] }, { "ComponentName": "test_component_2", "ResourceList": [ "arn:aws:ec2:us-east-1:123456789012:instance/i-abcd1234efgh5678i", "arn:aws:ec2:us-east-1:123456789012:instance/i-abcd1234efgh5678i" ] } ], "LogPatternSets": [ { "PatternSetName": "pattern_set_1", "LogPatterns": [ { "PatternName": "deadlock_pattern", "Pattern": ".\\sDeadlocked\\sSchedulers(([^\\w].)\|($))", "Rank": 1 } ] }, { Use CloudFormation templates 1158 Amazon CloudWatch User Guide "PatternSetName": "pattern_set_2", "LogPatterns": [ { "PatternName": "error_pattern", "Pattern": ".[\\s\\[]ERROR[\\s\\]].", "Rank": 1 }, { "PatternName": "warning_pattern", "Pattern": ".[\\s\\[]WARN(ING)?[\\s\\]].", "Rank": 10 } ] } ] } } Template in YAML format --- Type: AWS::ApplicationInsights::Application Properties: ResourceGroupName: my_resource_group CWEMonitorEnabled: true OpsCenterEnabled: true OpsItemSNSTopicArn: arn:aws:sns:us-east-1:123456789012:my_topic AutoConfigurationEnabled: true Tags: - Key: key1 Value: value1 - Key: key2 Value: '' CustomComponents: - ComponentName: test_component_1 ResourceList: - arn:aws:ec2:us-east-1:123456789012:instance/i-abcd1234efgh5678i - ComponentName: test_component_2 ResourceList: - arn:aws:ec2:us-east-1:123456789012:instance/i-abcd1234efgh5678i - arn:aws:ec2:us-east-1:123456789012:instance/i-abcd1234efgh5678i LogPatternSets: - PatternSetName: pattern_set_1 Use CloudFormation templates 1159 Amazon CloudWatch LogPatterns: - PatternName: deadlock_pattern Pattern: ".\\sDeadlocked\\sSchedulers(([^\\w].)\|($))" User Guide Rank: 1 - PatternSetName: pattern_set_2 LogPatterns: - PatternName: error_pattern Pattern: ".[\\s\\[]ERROR[\\s\\]]." Rank: 1 - PatternName: warning_pattern Pattern: ".[\\s\\[]WARN(ING)?[\\s\\]]." Rank: 10 Create an Application Insights application with CUSTOM mode component conﬁguration The following template performs these actions: • Creates an Application Insights application. For more information, see CreateApplication in the Amazon CloudWatch Application Insights API Reference. • Component my_component sets ComponentConfigurationMode to CUSTOM, which causes this component to be conﬁgured with the conﬁguration speciﬁed in CustomComponentConfiguration. For more information, see UpdateComponentConﬁguration in the Amazon CloudWatch Application Insights API Reference. Template in JSON format { "Type": "AWS::ApplicationInsights::Application", "Properties": { "ResourceGroupName": "my_resource_group, "ComponentMonitoringSettings": [ { "ComponentARN": "my_component", "Tier": "SQL_SERVER", "ComponentConfigurationMode": "CUSTOM", "CustomComponentConfiguration": { "ConfigurationDetails": { "AlarmMetrics": [ { "AlarmMetricName": "StatusCheckFailed" Use CloudFormation templates 1160 Amazon CloudWatch User Guide }, ... ], "Logs": [ { "LogGroupName": "my_log_group_1", "LogPath": "C:\\LogFolder_1\\", "LogType": "DOT_NET_CORE", "Encoding": "utf-8", "PatternSet": "my_pattern_set_1" }, ... ], "WindowsEvents": [ { "LogGroupName": "my_windows_event_log_group_1", "EventName": "Application", "EventLevels": [ "ERROR", "WARNING", ... ], "Encoding": "utf-8", "PatternSet": "my_pattern_set_2" }, ... ], "Alarms": [ { "AlarmName": "my_alarm_name", "Severity": "HIGH" }, ... ] }, "SubComponentTypeConfigurations": [ { "SubComponentType": "EC2_INSTANCE", "SubComponentConfigurationDetails": { "AlarmMetrics": [ { "AlarmMetricName": "DiskReadOps" }, ... Use CloudFormation templates 1161 Amazon CloudWatch User Guide ], "Logs": [ { "LogGroupName": "my_log_group_2", "LogPath": "C:\\LogFolder_2\\", "LogType": "IIS", "Encoding": "utf-8", "PatternSet": "my_pattern_set_3" }, ... ], "processes" : [ { "processName" : "my_process", "alarmMetrics" : [ { "alarmMetricName" : "procstat cpu_usage", "monitor" : true }, { "alarmMetricName" : "procstat memory_rss", "monitor" : true } ] } ], "WindowsEvents": [ { "LogGroupName": "my_windows_event_log_group_2", "EventName": "Application", "EventLevels": [ "ERROR", "WARNING", ... ], "Encoding": "utf-8", "PatternSet": "my_pattern_set_4" }, ... ] } } ] } } Use CloudFormation templates 1162 User Guide Amazon CloudWatch ] } } Template in YAML format --- Type: AWS::ApplicationInsights::Application Properties: ResourceGroupName: my_resource_group ComponentMonitoringSettings: - ComponentARN: my_component Tier: SQL_SERVER ComponentConfigurationMode: CUSTOM CustomComponentConfiguration: ConfigurationDetails: AlarmMetrics: - AlarmMetricName: StatusCheckFailed ... Logs: - LogGroupName: my_log_group_1 LogPath: C:\LogFolder_1\* LogType: DOT_NET_CORE Encoding: utf-8 PatternSet: my_pattern_set_1 ... WindowsEvents: - LogGroupName: my_windows_event_log_group_1 EventName: Application EventLevels: - ERROR - WARNING ... Encoding: utf-8 PatternSet: my_pattern_set_2 ... Alarms: - AlarmName: my_alarm_name Severity: HIGH ... SubComponentTypeConfigurations: - SubComponentType: EC2_INSTANCE SubComponentConfigurationDetails: Use CloudFormation templates 1163 Amazon CloudWatch User Guide AlarmMetrics: - AlarmMetricName: DiskReadOps ... Logs: - LogGroupName: my_log_group_2 LogPath: C:\LogFolder_2\* LogType: IIS Encoding: utf-8 PatternSet: my_pattern_set_3 ... Processes: - ProcessName: my_process AlarmMetrics: - AlarmMetricName: procstat cpu_usage ... ... WindowsEvents: - LogGroupName: my_windows_event_log_group_2 EventName: Application EventLevels: - ERROR - WARNING ... Encoding: utf-8 PatternSet: my_pattern_set_4 ... Create an Application Insights application with DEFAULT mode component conﬁguration The following template performs these actions: • Creates an Application Insights application. For more information, see CreateApplication in the Amazon CloudWatch Application Insights API Reference. • Component my_component sets ComponentConfigurationMode to DEFAULT and Tier to SQL_SERVER, which causes this component to be conﬁgured with the conﬁguration settings that Application Insights recommends for the SQL_Server tier. For more information, see DescribeComponentConﬁguration and UpdateComponentConﬁguration in the Amazon CloudWatch Application Insights API Reference. Template in JSON format Use CloudFormation templates 1164 Amazon CloudWatch User Guide { "Type": "AWS::ApplicationInsights::Application", "Properties": { "ResourceGroupName": "my_resource_group", "ComponentMonitoringSettings": [ { "ComponentARN": "my_component", "Tier": "SQL_SERVER", "ComponentConfigurationMode": "DEFAULT" } ] } } Template in YAML format --- Type: AWS::ApplicationInsights::Application Properties: ResourceGroupName: my_resource_group ComponentMonitoringSettings: - ComponentARN: my_component Tier: SQL_SERVER ComponentConfigurationMode: DEFAULT Create an Application Insights application with DEFAULT_WITH_OVERWRITE mode component conﬁguration The following template performs these actions: • Creates an Application Insights application. For more information, see CreateApplication in the Amazon CloudWatch Application Insights API Reference. • Component my_component sets ComponentConfigurationMode to DEFAULT_WITH_OVERWRITE and tier to DOT_NET_CORE, which causes this component to be conﬁgured with the conﬁguration settings that Application Insights recommends for the DOT_NET_CORE tier. Overwritten conﬁguration settings are speciﬁed in the DefaultOverwriteComponentConfiguration: • At the component level AlarmMetrics settings are overwritten. Use CloudFormation templates 1165 Amazon CloudWatch User Guide • At the sub-component level, for the EC2_Instance type sub-components, Logs settings are overwritten. For more information, see UpdateComponentConﬁguration in the Amazon CloudWatch Application Insights API Reference. Template in JSON format { "Type": "AWS::ApplicationInsights::Application",
acw-ug-331	acw-ug.pdf	331	information, see CreateApplication in the Amazon CloudWatch Application Insights API Reference. • Component my_component sets ComponentConfigurationMode to DEFAULT_WITH_OVERWRITE and tier to DOT_NET_CORE, which causes this component to be conﬁgured with the conﬁguration settings that Application Insights recommends for the DOT_NET_CORE tier. Overwritten conﬁguration settings are speciﬁed in the DefaultOverwriteComponentConfiguration: • At the component level AlarmMetrics settings are overwritten. Use CloudFormation templates 1165 Amazon CloudWatch User Guide • At the sub-component level, for the EC2_Instance type sub-components, Logs settings are overwritten. For more information, see UpdateComponentConﬁguration in the Amazon CloudWatch Application Insights API Reference. Template in JSON format { "Type": "AWS::ApplicationInsights::Application", "Properties": { "ResourceGroupName": "my_resource_group", "ComponentMonitoringSettings": [ { "ComponentName": "my_component", "Tier": "DOT_NET_CORE", "ComponentConfigurationMode": "DEFAULT_WITH_OVERWRITE", "DefaultOverwriteComponentConfiguration": { "ConfigurationDetails": { "AlarmMetrics": [ { "AlarmMetricName": "StatusCheckFailed" } ] }, "SubComponentTypeConfigurations": [ { "SubComponentType": "EC2_INSTANCE", "SubComponentConfigurationDetails": { "Logs": [ { "LogGroupName": "my_log_group", "LogPath": "C:\\LogFolder\\", "LogType": "IIS", "Encoding": "utf-8", "PatternSet": "my_pattern_set" } ] } } ] } Use CloudFormation templates 1166 User Guide Amazon CloudWatch } ] } } Template in YAML format --- Type: AWS::ApplicationInsights::Application Properties: ResourceGroupName: my_resource_group ComponentMonitoringSettings: - ComponentName: my_component Tier: DOT_NET_CORE ComponentConfigurationMode: DEFAULT_WITH_OVERWRITE DefaultOverwriteComponentConfiguration: ConfigurationDetails: AlarmMetrics: - AlarmMetricName: StatusCheckFailed SubComponentTypeConfigurations: - SubComponentType: EC2_INSTANCE SubComponentConfigurationDetails: Logs: - LogGroupName: my_log_group LogPath: C:\LogFolder\ LogType: IIS Encoding: utf-8 PatternSet: my_pattern_set Tutorial: Set up monitoring for SAP ASE This tutorial demonstrates how to conﬁgure CloudWatch Application Insights to set up monitoring for your SAP ASE databases. You can use CloudWatch Application Insights automatic dashboards to visualize problem details, accelerate troubleshooting, and facilitate mean time to resolution (MTTR) for your SAP ASE databases. Application Insights for SAP ASE topics • Supported environments • Supported operating systems • Features Tutorial: Set up monitoring for SAP ASE 1167 Amazon CloudWatch • Prerequisites • Set up monitoring on your SAP ASE database • Manage monitoring of your SAP ASE database • Conﬁgure the alarm threshold User Guide • View and troubleshoot SAP ASE problems detected by Application Insights • Troubleshooting Application Insights for SAP ASE Supported environments CloudWatch Application Insights supports the deployment of AWS resources for the following systems and patterns. You provide and install SAP ASE database software and supported SAP application software. • One or more SAP ASE databases on a single Amazon EC2 instance – SAP ASE in a single-node, scale-up architecture. • Cross-AZ SAP ASE database high availability setup – SAP ASE with high availability conﬁgured across two Availability Zones using SUSE/RHEL clustering. Note CloudWatch Application Insights supports only single SAP system ID (SID) ASE HA environments. If multiple ASE HA SIDs are attached, monitoring will be set up for only the ﬁrst detected SID. Supported operating systems CloudWatch Application Insights for SAP ASE supports x86-64 architecture on the following operating systems: • SuSE Linux 12 SP4 • SuSE Linux 12 SP5 • SuSE Linux 15 • SuSE Linux 15 SP1 Tutorial: Set up monitoring for SAP ASE 1168 User Guide Amazon CloudWatch • SuSE Linux 15 SP2 • SuSE Linux 15 SP3 • SuSE Linux 15 SP4 • SuSE Linux 15 SP1 For SAP • SuSE Linux 15 SP2 For SAP • SuSE Linux 15 SP3 For SAP • SuSE Linux 15 SP4 For SAP • SuSE Linux 12 SP4 For SAP • SuSE Linux 12 SP5 For SAP • RedHat Linux 7.6 • RedHat Linux 7.7 • RedHat Linux 7.9 • RedHat Linux 8.1 • RedHat Linux 8.4 • RedHat Linux 8.6 Features CloudWatch Application Insights for SAP ASE provides the following features: • Automatic SAP ASE workload detection • Automatic SAP ASE alarm creation based on static threshold • Automatic SAP ASE alarm creation based on anomaly detection • Automatic SAP ASE log pattern recognition • Health dashboard for SAP ASE • Problem dashboard for SAP ASE Prerequisites You must perform the following prerequisites to conﬁgure an SAP ASE database with CloudWatch Application Insights: Tutorial: Set up monitoring for SAP ASE 1169 Amazon CloudWatch User Guide • SAP ASE conﬁguration parameters – The following conﬁguration parameters must be enabled on your ASE DB: "enable monitoring", "sql text pipe max messages", "sql text pipe active". This allows CloudWatch Application Insights to provide full monitoring capabilities for your DB. If these settings aren't enabled on your ASE database, Application Insights will automatically enable them to collect the necessary metrics to allow monitoring. • SAP ASE database user – The database user provided during Application Insights onboarding must have permission to access the following: • System tables in the master database and user (tenant) databases • Monitoring tables • SAPHostCtrl – Install and set up SAPHostCtrl on your Amazon EC2 instance. • Amazon CloudWatch agent – Make sure that you are not running a preexisting CloudWatch agent on your Amazon EC2 instance. If you have CloudWatch agent installed, make sure to remove the conﬁguration of the resources you are using in CloudWatch Application Insights from the
acw-ug-332	acw-ug.pdf	332	collect the necessary metrics to allow monitoring. • SAP ASE database user – The database user provided during Application Insights onboarding must have permission to access the following: • System tables in the master database and user (tenant) databases • Monitoring tables • SAPHostCtrl – Install and set up SAPHostCtrl on your Amazon EC2 instance. • Amazon CloudWatch agent – Make sure that you are not running a preexisting CloudWatch agent on your Amazon EC2 instance. If you have CloudWatch agent installed, make sure to remove the conﬁguration of the resources you are using in CloudWatch Application Insights from the existing CloudWatch agent conﬁguration ﬁle to avoid a merge conﬂict. For more information, see Manually create or edit the CloudWatch agent conﬁguration ﬁle. • AWS Systems Manager enablement – Install SSM Agent on your instances, and enable the instances enabled for SSM. For information about how to install the SSM agent, see Working with SSM Agent in the AWS Systems Manager User Guide. • Amazon EC2 instance roles – You must attach the following Amazon EC2 instance roles to conﬁgure your database. • You must attach the AmazonSSMManagedInstanceCore role to enable Systems Manager. For more information, see AWS Systems Manager identity-based policy examples. • You must attach the CloudWatchAgentServerPolicy to enable instance metrics and logs to be emitted through CloudWatch. For more information, see Create IAM roles and users for use with Amazon CloudWatch agent. • You must attach the following IAM inline policy to the Amazon EC2 instance role to read the password stored in AWS Secrets Manager. For more information about inline policies, see Inline policies in the AWS Identity and Access Management User Guide. { "Version": "2012-10-17", "Statement": [ { "Sid": "VisualEditor0", "Effect": "Allow", "Action": [ Tutorial: Set up monitoring for SAP ASE 1170 Amazon CloudWatch User Guide "secretsmanager:GetSecretValue" ], "Resource": "arn:aws:secretsmanager:::secret:ApplicationInsights-" } ] } • AWS Resource Groups – You must create a resource group that includes all of the associated AWS resources used by your application stack to onboard your applications to CloudWatch Application Insights. This includes Amazon EC2 instances and Amazon EBS volumes running your SAP ASE database. If there are multiple databases per account, we recommend that you create one resource group that includes the AWS resources for each SAP ASE database system. • IAM permissions – For non-admin users: • You must create an AWS Identity and Access Management (IAM) policy that allows Application Insights to create a service-linked role, and attach it to your user identity. For steps to attach the policy, see IAM policy for CloudWatch Application Insights. • The user must have permission to create a secret in AWS Secrets Manager to store the database user credentials. For more information, see Example: Permission to create secrets. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "secretsmanager:CreateSecret" ], "Resource": "arn:aws:secretsmanager:::secret:ApplicationInsights-" } ] } • Service-linked role – Application Insights uses AWS Identity and Access Management (IAM) service-linked roles. A service-linked role is created for you when you create your ﬁrst Application Insights application in the Application Insights console. For more information, see Using service- linked roles for CloudWatch Application Insights. Set up monitoring on your SAP ASE database Use the following steps to set up monitoring for your SAP ASE database Tutorial: Set up monitoring for SAP ASE 1171 Amazon CloudWatch User Guide 1. Open the CloudWatch console. 2. 3. From the left navigation pane, under Insights, choose Application Insights. The Application Insights page displays the list of applications that are monitored with Application Insights, and the monitoring status for each application. In the upper right-hand corner, choose Add an application. 4. On the Specify application details page, from the dropdown list under Resource group, select the AWS resource group that contains your SAP ASE database resources. If you haven't created a resource group for your application, you can create one by choosing Create new resource group under the Resource group dropdown. For more information about creating resource groups, see the AWS Resource Groups User Guide. 5. Under Monitor CloudWatch Events, select the check box to integrate Application Insights monitoring with CloudWatch Events to get insights from Amazon EBS, Amazon EC2, AWS CodeDeploy, Amazon ECS, AWS Health APIs and notiﬁcations, Amazon RDS, Amazon S3, and AWS Step Functions. 6. Under Integrate with AWS Systems Manager OpsCenter, select the check box next to Generate AWS Systems Manager OpsCenter OpsItems for remedial actions to view and get notiﬁcations when problems are detected for the selected applications. To track the operations that are performed to resolve operational work items, called OpsItems, that are related to your AWS resources, provide an SNS topic ARN. 7. You can optionally enter tags to help you identify and organize your resources. CloudWatch Application Insights supports both tag-based and AWS CloudFormation stack-based resource groups, with the exception
acw-ug-333	acw-ug.pdf	333	notiﬁcations, Amazon RDS, Amazon S3, and AWS Step Functions. 6. Under Integrate with AWS Systems Manager OpsCenter, select the check box next to Generate AWS Systems Manager OpsCenter OpsItems for remedial actions to view and get notiﬁcations when problems are detected for the selected applications. To track the operations that are performed to resolve operational work items, called OpsItems, that are related to your AWS resources, provide an SNS topic ARN. 7. You can optionally enter tags to help you identify and organize your resources. CloudWatch Application Insights supports both tag-based and AWS CloudFormation stack-based resource groups, with the exception of Application Auto Scaling groups. For more information, see Tag Editor in the AWS Resource Groups and Tags User Guide. 8. Choose Next to continue to set up monitoring. 9. On the Review detected components page, the monitored components and their workloads automatically detected by CloudWatch Application Insights are listed. Note Components that contain a detected SAP ASE High Availability workload support only one workload on a component. Components that contain a detected SAP ASE single node workload support multiple workloads, but you can't add or remove workloads. All automatically detected workloads will be monitored. 10. Choose Next. Tutorial: Set up monitoring for SAP ASE 1172 Amazon CloudWatch User Guide 11. On the Specify component details page, enter the username and password of your SAP ASE databases. 12. Review your application monitoring conﬁguration, and choose Submit. 13. The application details page opens, where you can view the Application summary, the list of Monitored components and workloads, and Unmonitored components and workloads. If you select the radio button next to a component or workload, you can also view the Conﬁguration history, Log patterns, and any Tags that you have created. When you submit your conﬁguration, your account deploys all of the metrics and alarms for your SAP ASE system, which can take up to 2 hours. Manage monitoring of your SAP ASE database You can manage user credentials, metrics, and log paths for your SAP ASE database by performing the following steps: 1. Open the CloudWatch console. 2. 3. From the left navigation pane, under Insights, choose Application Insights. The Application Insights page displays the list of applications that are monitored with Application Insights, and the monitoring status for each application. 4. Under Monitored components, select the radio button next to the component name. Then, choose Manage monitoring. 5. Under EC2 instance group logs, you can update the existing log path, log pattern set, and log group name. In addition, you can add up to three additional Application logs. 6. Under Metrics, you can choose the SAP ASE metrics according to your requirements. SAP ASE metric names are preﬁxed with asedb. You can add up to 60 metrics per component. 7. Under ASE conﬁguration, enter the username and password for the SAP ASE database. This is the username and password that Amazon CloudWatch agent uses to connect to the SAP ASE database. 8. Under Custom alarms, you can add additional alarms to be monitored by CloudWatch Application Insights. 9. Review your application monitoring conﬁguration and choose Submit. When you submit your conﬁguration, your account updates all of the metrics and alarms for your SAP HANA system, which can take up to 2 hours. Tutorial: Set up monitoring for SAP ASE 1173 Amazon CloudWatch User Guide Conﬁgure the alarm threshold CloudWatch Application Insights automatically creates a Amazon CloudWatch metric for the alarm to watch, along with the threshold for that metric. The alarm changes to the ALARM state when the metric surpasses the threshold for a speciﬁed number of evaluation periods. Note that these settings are not retained by Application Insights. To edit an alarm for a single metric, perform the following steps: 1. Open the CloudWatch console. 2. 3. In the left navigation pane, choose Alarms>All alarms. Select the radio button next to the alarm that was automatically created by CloudWatch Application Insights. Then choose Actions, and select Edit from the dropdown menu. 4. Edit the following parameters under Metric. a. Under Statistic, choose one of the statistics or predeﬁned percentiles, or specify a custom percentile. For example, p95.45. b. Under Period, choose the evaluations period for the alarm. When you evaluate the alarm, each period is aggregated into one data point. 5. Edit the following parameters under Conditions. a. b. Choose whether the metric must be greater than, less than, or equal to the threshold. Specify the threshold value. 6. Under Additional conﬁguration edit the following parameters. a. Under Datapoints to alarm, specify the number of data points, or evaluation periods, that must be in the ALARM state to initiate the alarm. When the two values match, an alarm is created that enters ALARM state if the designated number of consecutive periods are exceeded. To create an m out of
acw-ug-334	acw-ug.pdf	334	evaluate the alarm, each period is aggregated into one data point. 5. Edit the following parameters under Conditions. a. b. Choose whether the metric must be greater than, less than, or equal to the threshold. Specify the threshold value. 6. Under Additional conﬁguration edit the following parameters. a. Under Datapoints to alarm, specify the number of data points, or evaluation periods, that must be in the ALARM state to initiate the alarm. When the two values match, an alarm is created that enters ALARM state if the designated number of consecutive periods are exceeded. To create an m out of n alarm, specify a lower value for the ﬁrst data point than for the second. For more information about evaluating alarms, see Evaluating an alarm. b. Under Missing data treatment, choose the behavior of the alarm when some data points are missing. For more information about missing data treatment, see Conﬁguring how CloudWatch alarms treat missing data. c. If the alarm uses a percentile as the monitored statistic, a Percentiles with low samples box appears. Choose whether to evaluate or ignore cases with low sample rates. If you choose ignore (maintain alarm state), the current alarm state is always maintained when Tutorial: Set up monitoring for SAP ASE 1174 Amazon CloudWatch User Guide the sample size is too low. For more information about percentiles with low samples, see Percentile-based CloudWatch alarms and low data samples. 7. Choose Next. 8. Under Notiﬁcation, select an SNS topic to notify when the alarm is in ALARM state, OK state, or INSUFFICIENT_DATA state. 9. Choose Update alarm. View and troubleshoot SAP ASE problems detected by Application Insights This section helps you resolve common troubleshooting problems that occur when you conﬁgure monitoring for SAP ASE on Application Insights. SAP ASE Backup Server errors You can identify the error message by checking the dynamically created dashboard. The dashboard shows the error message reported in the SAP ASE Backup Server. For more details about SAP ASE Backup Server logs, see SAP Documentation Backup Server Error Logging. SAP ASE long running transactions Identify the long running transaction and conﬁrm whether it can be stopped or if the running time is intentional. For more details, see 2180410 — How to display transaction log records for long running transactions? — SAP ASE. SAP ASE User connections Review whether your SAP ASE database is sized accordingly for the workload you intend to run on the database. For more details, see Conﬁguring User Connections in the SAP documentation. SAP ASE disk space You can identify the database layer that is causing the problem by checking the dynamically created dashboard. The dashboard shows the related metrics and log ﬁle snippets. It is important to understand the cause of the disk growth and when applicable, increase the physical disk size, the allocated disk space, or both. For more details, see SAP Documentation disk resize in the SAP documentation. Tutorial: Set up monitoring for SAP ASE 1175 Amazon CloudWatch User Guide Troubleshooting Application Insights for SAP ASE This section provides steps to help you resolve common errors returned by the Application Insights dashboard. Error Error returned Root cause Resolution Unable to add more than 60 monitor Component cannot have more than The current metric limit is 60 Remove unnecessary metrics to adhere to metrics. 60 monitored monitored metrics the limit. metric per component. No SAP metrics or alarms appear after The run command on the AWS-Confi The username and password might be Verify that the username and incorrect. password are valid, then rerun the onboarding process. the onboarding process gureAWSPackage failed in AWS Systems Manager. The output shows the error: CT-LIBRARY error:ct_connec t(): protocol specific layer: external error: The attempt to connect to the server failed Tutorial: Set up monitoring for SAP HANA This tutorial demonstrates how to conﬁgure CloudWatch Application Insights to set up monitoring for your SAP HANA databases. You can use CloudWatch Application Insights automatic dashboards to visualize problem details, accelerate troubleshooting, and facilitate mean time to resolution (MTTR) for your SAP HANA databases. Application Insights for SAP HANA topics • Supported environments Tutorial: Set up monitoring for SAP HANA 1176 Amazon CloudWatch • Supported operating systems • Features • Prerequisites • Set up your SAP HANA database for monitoring • Manage monitoring of your SAP HANA database User Guide • View and troubleshoot SAP HANA problems detected by CloudWatch Application Insights • Anomaly detection for SAP HANA • Troubleshooting Application Insights for SAP HANA Supported environments CloudWatch Application Insights supports the deployment of AWS resources for the following systems and patterns. You provide and install SAP HANA database software and supported SAP application software. • SAP HANA database on a single Amazon EC2 instance — SAP HANA in a single-node, scale-up architecture, with up to 24TB of memory. • SAP HANA
acw-ug-335	acw-ug.pdf	335	Set up your SAP HANA database for monitoring • Manage monitoring of your SAP HANA database User Guide • View and troubleshoot SAP HANA problems detected by CloudWatch Application Insights • Anomaly detection for SAP HANA • Troubleshooting Application Insights for SAP HANA Supported environments CloudWatch Application Insights supports the deployment of AWS resources for the following systems and patterns. You provide and install SAP HANA database software and supported SAP application software. • SAP HANA database on a single Amazon EC2 instance — SAP HANA in a single-node, scale-up architecture, with up to 24TB of memory. • SAP HANA database on multiple Amazon EC2 instances — SAP HANA in a multi-node, scale- out architecture. • Cross-AZ SAP HANA database high availability setup — SAP HANA with high availability conﬁgured across two Availability Zones using SUSE/RHEL clustering. Note CloudWatch Application Insights supports only single SID HANA environments. If multiple HANA SIDs are attached, monitoring will be set up for only the ﬁrst detected SID. Supported operating systems CloudWatch Application Insights for SAP HANA supports x86-64 architecture on the following operating systems: • SuSE Linux 12 SP4 For SAP • SuSE Linux 12 SP5 For SAP Tutorial: Set up monitoring for SAP HANA 1177 User Guide Amazon CloudWatch • SuSE Linux 15 • SuSE Linux 15 SP1 • SuSE Linux 15 SP2 • SuSE Linux 15 For SAP • SuSE Linux 15 SP1 For SAP • SuSE Linux 15 SP2 For SAP • SuSE Linux 15 SP3 For SAP • SuSE Linux 15 SP4 For SAP • SuSE Linux 15 SP5 For SAP • RedHat Linux 8.6 For SAP With High Availability and Update Services • RedHat Linux 8.5 For SAP With High Availability and Update Services • RedHat Linux 8.4 For SAP With High Availability and Update Services • RedHat Linux 8.3 For SAP With High Availability and Update Services • RedHat Linux 8.2 For SAP With High Availability and Update Services • RedHat Linux 8.1 For SAP With High Availability and Update Services • RedHat Linux 7.9 For SAP With High Availability and Update Services Features CloudWatch Application Insights for SAP HANA provides the following features: • Automatic SAP HANA workload detection • Automatic SAP HANA alarm creation based on static threshold • Automatic SAP HANA alarm creation based on anomaly detection • Automatic SAP HANA log pattern recognition • Health dashboard for SAP HANA • Problem dashboard for SAP HANA Prerequisites You must perform the following prerequisites to conﬁgure an SAP HANA database with CloudWatch Application Insights: Tutorial: Set up monitoring for SAP HANA 1178 Amazon CloudWatch User Guide • SAP HANA – Install a running and reachable SAP HANA database 2.0 SPS05 on an Amazon EC2 instance. • SAP HANA database user – A database user with monitoring roles must be created in the SYSTEM database and all tenants. Example The following SQL commands create a user with monitoring roles. su - <sid>adm hdbsql -u SYSTEM -p <SYSTEMDB password> -d SYSTEMDB CREATE USER CW_HANADB_EXPORTER_USER PASSWORD <Monitoring user password> NO FORCE_FIRST_PASSWORD_CHANGE; CREATE ROLE CW_HANADB_EXPORTER_ROLE; GRANT MONITORING TO CW_HANADB_EXPORTER_ROLE; GRANT CW_HANADB_EXPORTER_ROLE TO CW_HANADB_EXPORTER_USER; • Python 3.8 – Install Python 3.8 or later versions on your operating system. Use the latest release of Python. If Python3 is not detected on your operating system, Python 3.6 will be installed. For more information, see the installation example. Note Manual installation of Python 3.8 or higher is required for SuSE Linux 15 SP4, RedHat Linux 8.6, and later operating systems. • Pip3 – Install the installer program, pip3, on your operating system. If pip3 is not detected on your operating system, it will be installed. • hdbclient – CloudWatch Application Insights uses the python driver to connect to the SAP HANA database. If the client is not installed under python3, ensure that you have hdbclient tar ﬁle version 2.10 or later under /hana/shared/SID/hdbclient/. • Amazon CloudWatch agent – Make sure that you are not running a preexisting CloudWatch agent on your Amazon EC2 instance. If you have CloudWatch agent installed, make sure to remove the conﬁguration of the resources you are using in CloudWatch Application Insights from the existing CloudWatch agent conﬁguration ﬁle to avoid a merge conﬂict. For more information, see Manually create or edit the CloudWatch agent conﬁguration ﬁle. Tutorial: Set up monitoring for SAP HANA 1179 Amazon CloudWatch User Guide • AWS Systems Manager enablement – Install SSM Agent on your instances, and the instances must be enabled for SSM. For information about how to install the SSM Agent, see Working with SSM Agent in the AWS Systems Manager User Guide. • Amazon EC2 instance roles – You must attach the following Amazon EC2 instance roles to conﬁgure your database. • You must attach the AmazonSSMManagedInstanceCore role to enable Systems Manager. For more information, see AWS Systems Manager identity-based policy
acw-ug-336	acw-ug.pdf	336	create or edit the CloudWatch agent conﬁguration ﬁle. Tutorial: Set up monitoring for SAP HANA 1179 Amazon CloudWatch User Guide • AWS Systems Manager enablement – Install SSM Agent on your instances, and the instances must be enabled for SSM. For information about how to install the SSM Agent, see Working with SSM Agent in the AWS Systems Manager User Guide. • Amazon EC2 instance roles – You must attach the following Amazon EC2 instance roles to conﬁgure your database. • You must attach the AmazonSSMManagedInstanceCore role to enable Systems Manager. For more information, see AWS Systems Manager identity-based policy examples. • You must attach the CloudWatchAgentServerPolicy to enable instance metrics and logs to be emitted through CloudWatch. For more information, see Create IAM roles and users for use with CloudWatch agent. • You must attach the following IAM inline policy to the Amazon EC2 instance role to read the password stored in AWS Secrets Manager. For more information about inline policies, see Inline policies in the AWS Identity and Access Management User Guide. { "Version": "2012-10-17", "Statement": [ { "Sid": "VisualEditor0", "Effect": "Allow", "Action": [ "secretsmanager:GetSecretValue" ], "Resource": "arn:aws:secretsmanager:::secret:ApplicationInsights-" } ] } • AWS resource groups – You must create a resource group that includes all of the associated AWS resources used by your application stack to onboard your applications to CloudWatch Application Insights. This includes Amazon EC2 instances and Amazon EBS volumes running your SAP HANA database. If there are multiple databases per account, we recommend that you create one resource group that includes the AWS resources for each SAP HANA database system. • IAM permissions – For non-admin users: • You must create an AWS Identity and Access Management (IAM) policy that allows Application Insights to create a service-linked role, and attach it to your user identity. For steps to attach the policy, see IAM policy for CloudWatch Application Insights. Tutorial: Set up monitoring for SAP HANA 1180 Amazon CloudWatch User Guide • The user must have permission to create a secret in AWS Secrets Manager to store the database user credentials. For more information, see Example: Permission to create secrets. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "secretsmanager:CreateSecret" ], "Resource": "arn:aws:secretsmanager:::secret:ApplicationInsights-" } ] } • Service-linked role – Application Insights uses AWS Identity and Access Management (IAM) service-linked roles. A service-linked role is created for you when you create your ﬁrst Application Insights application in the Application Insights console. For more information, see Using service- linked roles for CloudWatch Application Insights. Set up your SAP HANA database for monitoring Use the following steps to set up monitoring for your SAP HANA database 1. Open the CloudWatch console. 2. 3. From the left navigation pane, under Insights, choose Application Insights. The Application Insights page displays the list of applications that are monitored with Application Insights, and the monitoring status for each application. In the upper right-hand corner, choose Add an application. 4. On the Specify application details page, from the dropdown list under Resource group, select the AWS resource group that contains your SAP HANA database resources. If you haven't created a resource group for your application, you can create one by choosing Create new resource group under the Resource group dropdown. For more information about creating resource groups, see the AWS Resource Groups User Guide. 5. Under Monitor CloudWatch Events, select the check box to integrate Application Insights monitoring with CloudWatch Events to get insights from Amazon EBS, Amazon EC2, AWS Tutorial: Set up monitoring for SAP HANA 1181 Amazon CloudWatch User Guide CodeDeploy, Amazon ECS, AWS Health APIs and notiﬁcations, Amazon RDS, Amazon S3, and AWS Step Functions. 6. Under Integrate with AWS Systems Manager OpsCenter, select the check box next to Generate AWS Systems Manager OpsCenter OpsItems for remedial actions to view and get notiﬁcations when problems are detected for the selected applications. To track the operations that are performed to resolve operational work items, called OpsItems, that are related to your AWS resources, provide an SNS topic ARN. 7. You can optionally enter tags to help you identify and organize your resources. CloudWatch Application Insights supports both tag-based and AWS CloudFormation stack-based resource groups, with the exception of Application Auto Scaling groups. For more information, see Tag Editor in the AWS Resource Groups and Tags User Guide. 8. Choose Next to continue to set up monitoring. 9. On the Review detected components page, the monitored components and their workloads automatically detected by CloudWatch Application Insights are listed. a. To add workloads to a component that contains a detected SAP HANA single node workload, select the component, then choose Edit component. Note Components that contain a detected SAP HANA multi node or HANA High Availability workload support only one workload on a component. Tutorial: Set up monitoring for SAP HANA 1182
acw-ug-337	acw-ug.pdf	337	Scaling groups. For more information, see Tag Editor in the AWS Resource Groups and Tags User Guide. 8. Choose Next to continue to set up monitoring. 9. On the Review detected components page, the monitored components and their workloads automatically detected by CloudWatch Application Insights are listed. a. To add workloads to a component that contains a detected SAP HANA single node workload, select the component, then choose Edit component. Note Components that contain a detected SAP HANA multi node or HANA High Availability workload support only one workload on a component. Tutorial: Set up monitoring for SAP HANA 1182 Amazon CloudWatch User Guide b. To add a new workload, choose Add new workload. Tutorial: Set up monitoring for SAP HANA 1183 Amazon CloudWatch User Guide c. When you are ﬁnished editing workloads, choose Save changes. 10. Choose Next. 11. On the Specify component details page, enter the username and password. 12. Review your application monitoring conﬁguration, and choose Submit. 13. The application details page opens, where you can view the Application summary, the list of Monitored components and workloads, and Unmonitored components and workloads. If you select the radio button next to a component or workload, you can also view the Conﬁguration history, Log patterns, and any Tags that you have created. When you submit your conﬁguration, your account deploys all of the metrics and alarms for your SAP HANA system, which can take up to 2 hours. Manage monitoring of your SAP HANA database You can manage user credentials, metrics, and log paths for your SAP HANA database by performing the following steps: 1. Open the CloudWatch console. 2. 3. From the left navigation pane, under Insights, choose Application Insights. The Application Insights page displays the list of applications that are monitored with Application Insights, and the monitoring status for each application. 4. Under Monitored components, select the radio button next to the component name. Then, choose Manage monitoring. 5. Under EC2 instance group logs, you can update the existing log path, log pattern set, and log group name. In addition, you can add up to three additional Application logs. 6. Under Metrics, you can choose the SAP HANA metrics according to your requirements. SAP HANA metric names are preﬁxed with hanadb. You can add up to 40 metrics per component. 7. Under HANA conﬁguration, enter the password and user name for the SAP HANA database. This is the username and password that Amazon CloudWatch agent uses to connect to the SAP HANA database. 8. Under Custom alarms, you can add additional alarms to be monitored by CloudWatch Application Insights. 9. Review your application monitoring conﬁguration and choose Submit. When you submit your conﬁguration, your account updates all of the metrics and alarms for your SAP HANA system, which can take up to 2 hours. Tutorial: Set up monitoring for SAP HANA 1184 Amazon CloudWatch User Guide View and troubleshoot SAP HANA problems detected by CloudWatch Application Insights The following sections provide steps to help you resolve common troubleshooting scenarios that occur when you conﬁgure monitoring for SAP HANA on Application Insights. Troubleshooting topics • SAP HANA database reaches memory allocation limit • Disk full event • SAP HANA backup stopped running SAP HANA database reaches memory allocation limit Description Your SAP application that is backed by an SAP HANA database malfunctions because of high memory pressure, leading to application performance degradation. Resolution You can identify the application layer that is causing the problem by checking the dynamically created dashboard, which shows the related metrics and log ﬁle snippets. In the following example, the problem may be because of a large data load in the SAP HANA system. The used memory allocation exceeds the threshold of 80 percent of the total memory allocation limit. Tutorial: Set up monitoring for SAP HANA 1185 Amazon CloudWatch User Guide The log group shows the scheme BNR-DATA and table IMDBMASTER_30003 ran out of memory. In addition, the log group shows the exact time of the issue, current global location limit, shared memory, code size, and OOM reservation allocation size. Disk full event Description Your SAP application that is backed by an SAP HANA database stops responding, which leads to an inability to access the database. Resolution You can identify the database layer that is causing the problem by checking the dynamically created dashboard, which shows the related metrics and log ﬁle snippets. In the following example, the problem may be that the administrator failed to enable automatic log backup, which caused the sap/hana/log directory to ﬁll up. Tutorial: Set up monitoring for SAP HANA 1186 Amazon CloudWatch User Guide The log group widget in the problem dashboard shows the DISKFULL event. SAP HANA backup stopped running Description Your SAP application that is backed by an SAP HANA database has stopped working. Resolution
acw-ug-338	acw-ug.pdf	338	access the database. Resolution You can identify the database layer that is causing the problem by checking the dynamically created dashboard, which shows the related metrics and log ﬁle snippets. In the following example, the problem may be that the administrator failed to enable automatic log backup, which caused the sap/hana/log directory to ﬁll up. Tutorial: Set up monitoring for SAP HANA 1186 Amazon CloudWatch User Guide The log group widget in the problem dashboard shows the DISKFULL event. SAP HANA backup stopped running Description Your SAP application that is backed by an SAP HANA database has stopped working. Resolution You can identify the database layer that is causing the problem by checking the dynamically created dashboard, which shows the related metrics and log ﬁle snippets. The log group widget in the problem dashboard shows the ACCESS DENIED event. This includes additional information, such as the S3 bucket, the S3 bucket folder, and the S3 bucket Region. Tutorial: Set up monitoring for SAP HANA 1187 Amazon CloudWatch User Guide Anomaly detection for SAP HANA For speciﬁc SAP HANA metrics, such as the number of thread count, CloudWatch applies statistical and machine learning algorithms to deﬁne the threshold. These algorithms continuously analyze the metrics of the SAP HANA database, determine normal baselines, and surface anomalies with minimal user intervention. The algorithms generate an anomaly detection model, which generates a range of expected values that represent normal metric behavior. Anomaly detection algorithms account for the seasonality and trend changes of metrics. The seasonality changes can be hourly, daily, or weekly, as shown in the following examples of the SAP HANA CPU usage. After you create a model, CloudWatch anomaly detection continuously evaluates the model and makes adjustments to it to ensure that is it as accurate as possible. This includes retraining the model to adjust if the metric values evolve over time or experience sudden changes. It also includes predictors to improve the models for metrics that are seasonal, spiky, or sparse. Troubleshooting Application Insights for SAP HANA This section provides steps to help you resolve common errors returned by the Application Insights dashboard. Tutorial: Set up monitoring for SAP HANA 1188 Amazon CloudWatch User Guide Unable to add more than 60 monitored metrics The output shows the following error. Component cannot have more than 60 monitored metrics Root cause – The current metric limit is 60 monitored metrics per component. Resolution – To stay under the limit, remove metrics that are not necessary. No SAP metrics appear after the onboarding process Use the following information to ﬁnd out why SAP metrics don't appear on the dashboard after the onboarding process. The ﬁrst step is to troubleshoot why the SAP metrics don't appear using the AWS Management Console or Exporter logs from an Amazon EC2 instance. Next, review the error output to ﬁnd a resolution. Troubleshoot why SAP metrics don't appear after onboarding You can use the AWS Management Console or exporter logs from an Amazon EC2 instance for troubleshooting. AWS Management Console Troubleshoot no SAP metrics appear after onboarding using the console 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. In the left navigation pane, choose State Manager. 3. Under Associations, check the status of the document AWSEC2- ApplicationInsightsCloudwatchAgentInstallAndConfigure. If the status is Failed, under Execution id, select the failed id and view the output. 4. Under Associations, check the status of the document AWS-ConfigureAWSPackage. If the status is Failed, under Execution id, select the failed id and view the output. Exporter logs from Amazon EC2 instance Troubleshoot no SAP metrics appear after onboarding using exporter logs 1. Connect to the Amazon EC2 instance where your SAP HANA database is running. Tutorial: Set up monitoring for SAP HANA 1189 Amazon CloudWatch User Guide 2. Find the correct naming convention for WORKLOAD_SHORT_NAME using the following command. You will use this short name in the following two steps. sudo systemctl \| grep exporter Note Application Insights adds a suﬃx, WORKLOAD_SHORT_NAME to the service name depending on the workload that is running. The short names for SAP HANA single node, multiple nodes, and high availability deployments are HANA_SN, HANA_MN, and HANA_HA. 3. To check for errors in the exporter manager service logs, run the following command replacing WORKLOAD_SHORT_NAME with the short name you found in Step 2. sudo journalctl -e --unit=prometheus- hanadb_exporter_manager_WORKLOAD_SHORT_NAME.service 4. If the exporter manager service logs do not show an error, check for errors in the exporter service logs by running the following command. sudo journalctl -e --unit=prometheus-hanadb_exporter_WORKLOAD_SHORT_NAME.service Resolving the common root causes for SAP metrics not appearing after onboarding The following examples describe how to resolve the common root causes of SAP metrics not appearing after onboarding. • The output shows the following error. Reading json config file path: /opt/aws/amazon-cloudwatch-agent/etc/amazon- cloudwatch-agent.d/default ... Reading json config file path:
acw-ug-339	acw-ug.pdf	339	logs, run the following command replacing WORKLOAD_SHORT_NAME with the short name you found in Step 2. sudo journalctl -e --unit=prometheus- hanadb_exporter_manager_WORKLOAD_SHORT_NAME.service 4. If the exporter manager service logs do not show an error, check for errors in the exporter service logs by running the following command. sudo journalctl -e --unit=prometheus-hanadb_exporter_WORKLOAD_SHORT_NAME.service Resolving the common root causes for SAP metrics not appearing after onboarding The following examples describe how to resolve the common root causes of SAP metrics not appearing after onboarding. • The output shows the following error. Reading json config file path: /opt/aws/amazon-cloudwatch-agent/etc/amazon- cloudwatch-agent.d/default ... Reading json config file path: /opt/aws/amazon-cloudwatch-agent/etc/ amazon-cloudwatch-agent.d/ssm_AmazonCloudWatch-ApplicationInsights- SSMParameterForTESTCWEC2INSTANCEi0d88867f1f3e36285.tmp ... 2023/11/30 22:25:17 Failed to merge multiple json config files. 2023/11/30 22:25:17 Failed to merge multiple json config files. 2023/11/30 22:25:17 Under path : /metrics/append_dimensions \| Error : Different values are specified for append_dimensions Tutorial: Set up monitoring for SAP HANA 1190 Amazon CloudWatch User Guide 2023/11/30 22:25:17 Under path : /metrics/metrics_collected/disk \| Error : Different values are specified for disk 2023/11/30 22:25:17 Under path : /metrics/metrics_collected/mem \| Error : Different values are specified for mem 2023/11/30 22:25:17 Configuration validation first phase failed. Agent version: 1.0. Verify the JSON input is only using features supported by this version. Resolution – Application Insights is trying to conﬁgure the same metrics that are pre-conﬁgured as part of the existing CloudWatch agent conﬁguration ﬁle. Remove the existing ﬁles under / opt/aws/amazon-cloudwatch-agent/etc/amazon-cloudwatch-agent.d/ or remove the metrics that are causing the conﬂict from the existing CloudWatch agent conﬁguration ﬁle. • The output shows the following error. Unable to find a host with system database, for more info rerun using -v Resolution – The username, password, or database port may be incorrect. Verify that the username, password, and port are valid, then re-run the onboarding process. • The output shows the following error. This hdbcli installer is not compatible with your Python interpreter Resolution – Upgrade pip3 and wheel as shown in the following example for Python 3.6. python3.6 -m pip install --upgrade pip setuptools wheel • The output shows the following error. Unable to install hdbcli using pip3. Please try to install it Resolution – Ensure that you have followed the hdbclient prerequisites or install hdbclient manually under pip3. • The output shows the following error. Package 'boto3' requires a different Python: 3.6.15 not in '>= 3.7' Resolution – Python 3.8 or higher is required for this operating system version. Check the Python 3.8 prerequisites and install it. Tutorial: Set up monitoring for SAP HANA 1191 Amazon CloudWatch User Guide • The output shows one of the following installation errors. Can not execute `setup.py` since setuptools is not available in the build environment or [SSL: CERTIFICATE_VERIFY_FAILED] Resolution – Install Python using SUSE Linux commands as shown in the following example. The following example installs the latest version of Python 3.8. wget https://www.python.org/ftp/python/3.8.<LATEST_RELEASE>/ Python-3.8.<LATEST_RELEASE>.tgz tar xf Python-3.* cd Python-3.*/ sudo zypper install make gcc-c++ gcc automake autoconf libtool sudo zypper install zlib-devel sudo zypper install libopenssl-devel libffi-devel ./configure --with-ensurepip=install sudo make sudo make install sudo su python3.8 -m pip install --upgrade pip setuptools wheel Tutorial: Set up monitoring for SAP NetWeaver This tutorial demonstrates how to conﬁgure Amazon CloudWatch Application Insights to set up monitoring for SAP NetWeaver. You can use CloudWatch Application Insights automatic dashboards to visualize problem details, accelerate troubleshooting, and reduce mean time to resolution (MTTR) for your SAP NetWeaver application servers. CloudWatch Application Insights for SAP NetWeaver topics • Supported environments • Supported operating systems • Features • Prerequisites Tutorial: Set up monitoring for SAP NetWeaver 1192 Amazon CloudWatch User Guide • Set up your SAP NetWeaver application servers for monitoring • Manage monitoring of your SAP NetWeaver application servers • View and troubleshoot SAP NetWeaver problems detected by CloudWatch Application Insights • Troubleshooting Application Insights for SAP NetWeaver Supported environments CloudWatch Application Insights supports the deployment of AWS resources for the following systems and patterns. • SAP NetWeaver Standard System Deployment. • SAP NetWeaver Distributed deployments on multiple Amazon EC2 instances. • Cross-AZ SAP NetWeaver high availability setup – SAP NetWeaver with high availability conﬁgured across two Availability Zones using SUSE/RHEL clustering. Supported operating systems CloudWatch Application Insights for SAP NetWeaver is supported on the following operating systems: • Oracle Linux 8 • Red Hat Enterprise Linux 7.6 • Red Hat Enterprise Linux 7.7 • Red Hat Enterprise Linux 7.9 • Red Hat Enterprise Linux 8.1 • Red Hat Enterprise Linux 8.2 • Red Hat Enterprise Linux 8.4 • Red Hat Enterprise Linux 8.6 • SUSE Linux Enterprise Server 15 for SAP • SUSE Linux Enterprise Server 15 SP1 for SAP • SUSE Linux Enterprise Server 15 SP2 for SAP • SUSE Linux Enterprise Server 15 SP3 for SAP • SUSE Linux Enterprise Server 15 SP4 for SAP Tutorial: Set up monitoring for SAP NetWeaver 1193 Amazon CloudWatch
acw-ug-340	acw-ug.pdf	340	• Oracle Linux 8 • Red Hat Enterprise Linux 7.6 • Red Hat Enterprise Linux 7.7 • Red Hat Enterprise Linux 7.9 • Red Hat Enterprise Linux 8.1 • Red Hat Enterprise Linux 8.2 • Red Hat Enterprise Linux 8.4 • Red Hat Enterprise Linux 8.6 • SUSE Linux Enterprise Server 15 for SAP • SUSE Linux Enterprise Server 15 SP1 for SAP • SUSE Linux Enterprise Server 15 SP2 for SAP • SUSE Linux Enterprise Server 15 SP3 for SAP • SUSE Linux Enterprise Server 15 SP4 for SAP Tutorial: Set up monitoring for SAP NetWeaver 1193 Amazon CloudWatch User Guide • SUSE Linux Enterprise Server 12 SP4 for SAP • SUSE Linux Enterprise Server 12 SP5 for SAP • SUSE Linux Enterprise Server 15 except High Availability patterns • SUSE Linux Enterprise Server 15 SP1 except High Availability patterns • SUSE Linux Enterprise Server 15 SP2 except High Availability patterns • SUSE Linux Enterprise Server 15 SP3 except High Availability patterns • SUSE Linux Enterprise Server 15 SP4 except High Availability patterns • SUSE Linux Enterprise Server 12 SP4 except High Availability patterns • SUSE Linux Enterprise Server 12 SP5 except High Availability patterns Features CloudWatch Application Insights for SAP NetWeaver 7.0x–7.5x (including ABAP Platform) provides the following features: • Automatic SAP NetWeaver workload detection • Automatic SAP NetWeaver alarm creation based on static thresholds • Automatic SAP NetWeaver log pattern recognition • Health dashboard for SAP NetWeaver • Problem dashboard for SAP NetWeaver Prerequisites You must perform the following prerequisites to conﬁgure SAP NetWeaver with CloudWatch Application Insights: • AWS Systems Manager enablement – Install SSM Agent on your Amazon EC2 instances, and enable the instances for SSM. For information about how to install the SSM Agent, see Setting up AWS Systems Manager in the AWS Systems Manager User Guide. • Amazon EC2 instance roles – You must attach the following Amazon EC2 instance roles to conﬁgure your SAP NetWeaver monitoring. • You must attach the AmazonSSMManagedInstanceCore role to enable Systems Manager. For more information, see AWS Systems Manager identity-based policy examples. Tutorial: Set up monitoring for SAP NetWeaver 1194 Amazon CloudWatch User Guide • You must attach the CloudWatchAgentServerPolicy policy to enable instance metrics and logs to be emitted through CloudWatch. For more information, see Create IAM roles and users for use with CloudWatch agent. • AWS resource groups – You must create a resource group that includes all of the associated AWS resources used by your application stack to onboard your applications to CloudWatch Application Insights. This includes Amazon EC2 instances, Amazon EFS, and Amazon EBS volumes running your SAP NetWeaver application servers. If there are multiple SAP NetWeaver systems per account, we recommend that you create one resource group that includes the AWS resources for each SAP NetWeaver system. For more information about creating resource groups, see the AWS Resource Groups and Tags User Guide. • IAM permissions – For users who don't have administrative access, you must create an AWS Identity and Access Management (IAM) policy that allows Application Insights to create a service- linked role and attach it to the user's identity. For more information about how to create the IAM policy, see IAM policy. • Service-linked role – Application Insights uses AWS Identity and Access Management (IAM) service-linked roles. A service-linked role is created for you when you create your ﬁrst Application Insights application in the Application Insights console. For more information, see Using service- linked roles for CloudWatch Application Insights. • Amazon CloudWatch agent – Application Insights installs and conﬁgures the CloudWatch agent. If you have CloudWatch agent installed, Application Insights retains your conﬁguration. To avoid a merge conﬂict, remove the conﬁguration of resources that you want to use in Application Insights from the existing CloudWatch agent conﬁguration ﬁle. For more information, see Manually create or edit the CloudWatch agent conﬁguration ﬁle. Set up your SAP NetWeaver application servers for monitoring Use the following steps to set up monitoring for your SAP NetWeaver application servers. To set up monitoring 1. Open the CloudWatch console. 2. 3. From the left navigation pane, under Insights, select Application Insights. The Application Insights page displays the list of applications that are monitored with Application Insights, and the monitoring status for each application. In the upper right-hand corner, select Add an application. Tutorial: Set up monitoring for SAP NetWeaver 1195 Amazon CloudWatch User Guide 4. On the Specify application details page, from the dropdown list under Resource group, select the AWS resource group you created that contains your SAP NetWeaver resources. If you haven't created a resource group for your application, you can create one by choosing Create new resource group under the Resource group dropdown list. 5. Under Automatic monitoring of new resources, select the check box to allow Application Insights to automatically monitor
acw-ug-341	acw-ug.pdf	341	Insights, and the monitoring status for each application. In the upper right-hand corner, select Add an application. Tutorial: Set up monitoring for SAP NetWeaver 1195 Amazon CloudWatch User Guide 4. On the Specify application details page, from the dropdown list under Resource group, select the AWS resource group you created that contains your SAP NetWeaver resources. If you haven't created a resource group for your application, you can create one by choosing Create new resource group under the Resource group dropdown list. 5. Under Automatic monitoring of new resources, select the check box to allow Application Insights to automatically monitor the resources that are added to the application's resource group after onboarding. 6. Under Monitor EventBridge events, select the check box to integrate Application Insights monitoring with CloudWatch Events to get insights from Amazon EBS, Amazon EC2, AWS CodeDeploy, Amazon ECS, AWS Health APIs and notiﬁcations, Amazon RDS, Amazon S3, and AWS Step Functions. 7. Under Integrate with AWS Systems Manager OpsCenter, select the check box next to Generate AWS Systems Manager OpsCenter OpsItems for remedial actions to view and get notiﬁcations when problems are detected for the selected applications. To track the operations that are performed to resolve operational work items, called OpsItems, that are related to your AWS resources, provide an SNS topic ARN. 8. You can optionally enter tags to help you identify and organize your resources. CloudWatch Application Insights supports both tag-based and AWS CloudFormation stack-based resource groups, with the exception of Application Auto Scaling groups. For more information, see Tag Editor in the AWS Resource Groups and Tags User Guide. 9. To review detected components, choose Next. 10. On the Review detected components page, the monitored components and their workloads automatically detected by CloudWatch Application Insights are listed. • To edit the workload type and name, choose Edit component. Note Components that contain a detected NetWeaver Distributed or NetWeaver High Availability workload support only one workload on a component. Tutorial: Set up monitoring for SAP NetWeaver 1196 Amazon CloudWatch User Guide 11. Choose Next. 12. On the Specify component details page, choose Next. 13. Review your application monitoring conﬁguration, then choose Submit. 14. The application details page opens, where you can view the Application summary, Dashboard, Components, and Workloads. You can also view the Conﬁguration history, Log patterns, and any Tags that you have created. After you submit your application, CloudWatch Application Insights deploys all of the metrics and alarms for your SAP NetWeaver system, which can take up to an hour. Manage monitoring of your SAP NetWeaver application servers Use the following steps to manage monitoring of your SAP NetWeaver application servers. To manage monitoring 1. Open the CloudWatch console. 2. From the left navigation pane, under Insights, select Application Insights. 3. Choose the List view tab. 4. The Application Insights page displays the list of applications that are monitored with Application Insights, and the monitoring status for each application. 5. Select your application. Tutorial: Set up monitoring for SAP NetWeaver 1197 Amazon CloudWatch 6. Choose the Components tab. User Guide 7. Under Monitored components, select the radio button next to the component name. Then, select Manage monitoring. 8. Under Instance logs, you can update the existing log path, log pattern set, and log group name. In addition, you can add up to three additional Application logs. 9. Under Metrics, you can select the SAP NetWeaver metrics according to your requirements. SAP NetWeaver metric names are preﬁxed with sap. You can add up to 40 metrics per component. 10. Under Custom alarms, you can add additional alarms to be monitored by CloudWatch Application Insights. 11. Review your application monitoring conﬁguration and choose Save. When you submit your conﬁguration, your account updates all of the metrics and alarms for your SAP NetWeaver systems. View and troubleshoot SAP NetWeaver problems detected by CloudWatch Application Insights The following sections provide steps to help you resolve common troubleshooting scenarios that occur when you conﬁgure monitoring for SAP NetWeaver on Application Insights. Troubleshooting topics • SAP NetWeaver database connectivity issues • SAP NetWeaver application availability issues SAP NetWeaver database connectivity issues Description Your SAP NetWeaver application experiences database connectivity issues. Cause You can identify the connectivity issue by going to the CloudWatch Application Insights console and checking the SAP NetWeaver Application Insights problem dashboard. Select the link under Problem summary to see the speciﬁc issue. Tutorial: Set up monitoring for SAP NetWeaver 1198 Amazon CloudWatch User Guide In the following example, under Problem summary, SAP: Availability is the issue. Immediately following the Problem summary, the Insight section provides more context about the error and where you can get more information about the causes of the issue. On the same problem dashboard, you can view related logs and metrics that problem detection has grouped together to help you isolate the
acw-ug-342	acw-ug.pdf	342	to the CloudWatch Application Insights console and checking the SAP NetWeaver Application Insights problem dashboard. Select the link under Problem summary to see the speciﬁc issue. Tutorial: Set up monitoring for SAP NetWeaver 1198 Amazon CloudWatch User Guide In the following example, under Problem summary, SAP: Availability is the issue. Immediately following the Problem summary, the Insight section provides more context about the error and where you can get more information about the causes of the issue. On the same problem dashboard, you can view related logs and metrics that problem detection has grouped together to help you isolate the cause of the error. The sap_alerts_Availability metric tracks the availability of the SAP NetWeaver system over time. You can use historical tracking to correlate when the metric initiated an error state or breached the alarm threshold. In the following example, there is an availability issue with the SAP NetWeaver system. The example shows two alarms because there are two SAP application server instances and an alarm was created for each instance. Tutorial: Set up monitoring for SAP NetWeaver 1199 Amazon CloudWatch User Guide For more information about each alarm, hover over the sap_alerts_Availability metric name. In the following example, the sap_alerts_Database metric shows that the database layer has an issue or a failure. This alarm indicates that SAP NetWeaver had issues connecting to or communicating with its database. Since the database is a key resource for SAP NetWeaver, you may get many related alarms when the database has an issue or failure. In the following example, the sap_alerts_FrontendResponseTime and sap_alerts_LongRunners metrics are initiated because the database is not available. Tutorial: Set up monitoring for SAP NetWeaver 1200 Amazon CloudWatch User Guide Resolution Application Insights monitors the detected problem hourly. If there are no new related log entries in your SAP NetWeaver log ﬁles, the older log entries will be treated as resolved. You must ﬁx any error conditions related to the CloudWatch alarms. After the error conditions are ﬁxed, the alarm is resolved when the alarms and logs are recovered. When all of the CloudWatch log errors and alarms are resolved, Application Insights stops detecting errors and the problem is automatically resolved within an hour. We recommend that you resolve all log error conditions and alarms so that you have the latest problems on the problem dashboard. In the following example, the SAP Availability issue is resolved. SAP NetWeaver application availability issues Description Your SAP NetWeaver High Availability Enqueue replication stopped working. Cause You can identify the connectivity issue by going to the CloudWatch Application Insights console and checking the SAP NetWeaver Application Insights problem dashboard. Select the link under Problem summary to see the speciﬁc issue. Tutorial: Set up monitoring for SAP NetWeaver 1201 Amazon CloudWatch User Guide In the following example, under Problem summary, High Availability Enqueue Replication is the issue. Immediately following the Problem summary, the Insight section provides more context about the error and where you can get more information about the causes of the issue. The following example shows the problem dashboard where you view logs and metrics which are grouped to help you isolate the causes of the error. The sap_enqueue_server_replication_state metric tracks the value over time. You can use Tutorial: Set up monitoring for SAP NetWeaver 1202 Amazon CloudWatch User Guide historical tracking to correlate when the metric initiated an error state or breached the alarm threshold. In the following example, the ha_cluster_pacemaker_fail_count metric shows that the high availability pacemaker cluster experienced a resource failure. The speciﬁc pacemaker resources that had a fail count greater than or equal to one are identiﬁed in the component dashboard. The following example shows the sap_alerts_Shortdumps metric, which indicates that the SAP application performance was reduced when the problem was detected. Tutorial: Set up monitoring for SAP NetWeaver 1203 Amazon CloudWatch User Guide Logs The log entries are helpful to get a better understanding of issues that occurred at the SAP NetWeaver layer when the problem was detected. The log group widget in the problem dashboard shows the speciﬁc time of the issue. To see detailed information about the logs, select the three vertical dots in the upper-right corner, and select View in CloudWatch Logs Insights. Tutorial: Set up monitoring for SAP NetWeaver 1204 Amazon CloudWatch User Guide Use the following steps to get more information about the metrics and alarms displayed in the problem dashboard. To get more information about metrics and alarms 1. Open the CloudWatch console. 2. 3. In the left navigation pane, under Insights, select Application Insights. Then, choose the List view tab, and select your application. Select the Components tab. Then, select the SAP NetWeaver component about which you want to get more information. The following example shows the HA Metrics section with the ha_cluster_pacemaker_fail_count metric that was displayed in the problem
acw-ug-343	acw-ug.pdf	343	Set up monitoring for SAP NetWeaver 1204 Amazon CloudWatch User Guide Use the following steps to get more information about the metrics and alarms displayed in the problem dashboard. To get more information about metrics and alarms 1. Open the CloudWatch console. 2. 3. In the left navigation pane, under Insights, select Application Insights. Then, choose the List view tab, and select your application. Select the Components tab. Then, select the SAP NetWeaver component about which you want to get more information. The following example shows the HA Metrics section with the ha_cluster_pacemaker_fail_count metric that was displayed in the problem dashboard. Tutorial: Set up monitoring for SAP NetWeaver 1205 Amazon CloudWatch User Guide Resolution Application Insights monitors the detected problem hourly. If there are no new related log entries in your SAP NetWeaver log ﬁles, the older log entries will be treated as resolved. You must ﬁx any error conditions related to this problem. For the sap_alerts_Shortdumps alarm, you must resolve the alert in the SAP NetWeaver system by using transaction code RZ20 # R3Abap # Shortdumps to navigate to the CCMS alert. For more information about CCMS alerts, see the SAP website. Resolve all of the CCMS alerts in the Shortdumps tree. After all of the alerts are resolved in the SAP NetWeaver system, CloudWatch no longer reports the metric in an alarm state. When all of the CloudWatch log errors and alarms are resolved, Application Insights stops detecting errors and the problem is automatically resolved within an hour. We recommend that you resolve all log error conditions and alarms so that you have the latest problems on the problem dashboard. In the following example, the SAP Netweaver High Availability Enqueue Replication problem is resolved. Tutorial: Set up monitoring for SAP NetWeaver 1206 Amazon CloudWatch User Guide Troubleshooting Application Insights for SAP NetWeaver This section provides steps to help you resolve common errors returned by the Application Insights dashboard. Unable to add more than 60 monitor metrics Error returned: Component cannot have more than 60 monitored metrics. Root cause: The current metric limit is 60 monitor metrics per component. Resolution: Remove metrics that are not necessary to adhere to the limit. SAP metrics do not appear on the dashboard after the onboarding process Root cause: Component Dashboard uses a ﬁve minute metric period to aggregate the data points. Resolution: All metrics should show up on the dashboard after ﬁve minutes. SAP metrics and alarms don't appear on the dashboard Use the following steps to identify why SAP metrics and alarms don't appear on the dashboard after the onboarding process. To identify the issue with metrics and alarms 1. Open the CloudWatch console. 2. In the left navigation pane, under Insights, select Application Insights. Then, choose the List view tab, and select your application. 3. Choose the Conﬁguration history tab. 4. If you see missing metrics datapoints, check for errors related to prometheus- sap_host_exporter. 5. If you don't ﬁnd an error in the previous step, Connect to your Linux instance. For High Availability deployments, connect to the primary cluster Amazon EC2 instance. 6. In your instance, verify that the exporter is running by using the following command. The default port is 9680. If you are using a diﬀerent port, replace 9680 with the port you are using. curl localhost:9680/metrics If no data is returned, then the exporter failed to start. Tutorial: Set up monitoring for SAP NetWeaver 1207 Amazon CloudWatch User Guide 7. To ﬁnd the correct naming convention to use for WORKLOAD_SHORT_NAME in the next two steps, run the following command. Note Application Insights adds a suﬃx, WORKLOAD_SHORT_NAME, to the service name depending on the workload that is running. The short names for NetWeaver Distributed, Standard, and High Availability deployments are SAP_NWD, SAP_NWS, and SAP_NWH. sudo systemctl \| grep exporter 8. To check for errors in the exporter service logs, run the following command: sudo journalctl -e --unit=prometheus-sap_host_exporter_WORKLOAD_SHORT_NAME.service 9. To check for errors in the exporter manager service logs, run the following command: sudo journalctl -e --unit=prometheus- sap_host_exporter_manager_WORKLOAD_SHORT_NAME.service Note This service should be up and running at all times. If this command does not return an error, continue to the next step. 10. To manually start the exporter, run the following command. Then, check the exporter output. sudo /opt/aws/sap_host_exporter/sap_host_exporter You can exit the exporter process after you check for errors. Root cause: There are several possible causes for this issue. A common cause is that the exporter is not able to connect to one of the application server instances. Tutorial: Set up monitoring for SAP NetWeaver 1208 Amazon CloudWatch Resolution User Guide Use the following steps to connect the exporter to the application server instances. You will verify that the SAP application instance is running and use SAPControl to connect to the instance. To connect the exporter to the
acw-ug-344	acw-ug.pdf	344	the following command. Then, check the exporter output. sudo /opt/aws/sap_host_exporter/sap_host_exporter You can exit the exporter process after you check for errors. Root cause: There are several possible causes for this issue. A common cause is that the exporter is not able to connect to one of the application server instances. Tutorial: Set up monitoring for SAP NetWeaver 1208 Amazon CloudWatch Resolution User Guide Use the following steps to connect the exporter to the application server instances. You will verify that the SAP application instance is running and use SAPControl to connect to the instance. To connect the exporter to the application server instances 1. In your Amazon EC2 instance, run the following command to verify that the SAP application is running. sapcontrol -nr <App_InstNo> -function GetProcessList 2. You must establish a working SAPControl connection. If the SAPControl connection doesn't work, ﬁnd the root cause of the issue on the relevant SAP application instance. 3. To manually start the exporter after you ﬁx the SAP Control connection issue, run the following command: sudo systemctl start prometheus-sap_host_exporter.service 4. If you can't resolve the SAPControl connection issue, use the following procedure as a temporary ﬁx. a. Open the AWS Systems Manager console. b. From the left navigation pane, choose State Manager. c. Under Associations search for the SAP NetWeaver system's association. Association Name: Equal: AWS-ApplicationInsights- SSMSAPHostExporterAssociationForCUSTOMSAPNW<SID>-1 Select the Association id. Choose the Parameters tab and remove the application server number from additionalArguments. d. e. f. Choose Apply Association Now. Note This is a temporary ﬁx. If updates are made to the component's monitoring conﬁgurations, the instance will be added back. Tutorial: Set up monitoring for SAP NetWeaver 1209 Amazon CloudWatch User Guide View and troubleshoot problems detected by Amazon CloudWatch Application Insights The topics in this section provide detailed information about the detected problems and insights displayed by Application Insights. It also provides suggested resolutions for detected issues with your account or your conﬁguration. Troubleshooting topics • CloudWatch console overview • Application Insights problem summary page • CloudWatch agent merge conﬂict failures • High CPU usage from CloudWatch agent log processing • Alarms are not created • Feedback • Conﬁguration errors CloudWatch console overview An overview of problems that impact your monitored applications can be found under the CloudWatch Application Insights pane in the overview page of the CloudWatch console. The CloudWatch Application Insights overview pane displays the following: • The severity of the problems detected: High/Medium/Low • A short summary of the problem • The problem source • The time the problem started • The resolution status of the problem • The aﬀected resource group To view the details of a speciﬁc problem, under Problem Summary, select the description of the problem. A detailed dashboard displays insights into the problem and related metric anomalies and snippets of log errors. You can provide feedback on the relevance of the insight by selecting whether it is useful. View and troubleshoot Application Insights 1210 Amazon CloudWatch User Guide If a new resource is detected that is not conﬁgured, the problem summary description takes you to the Edit conﬁguration wizard to conﬁgure your new resource. You can view or edit your resource group conﬁguration by choosing View/edit conﬁguration in the upper right‐hand corner of the detailed dashboard. To return to the overview, choose Back to overview, which is next to the CloudWatch Application Insights detailed dashboard header. Application Insights problem summary page Application Insights problem summary page CloudWatch Application Insights provides the following information about detected problems on the problem summary page: • A short summary of the problem • The start time and date of the problem • The problem severity: High/Medium/Low • The status of the detected problem: In‐progress/Resolved • Insights: Automatically generated insights on the detected problem and possible root cause • Feedback on insights: Feedback you have provided about the usefulness of the insights generated by CloudWatch Application Insights • Related observations: A detailed view of the metric anomalies and error snippets of relevant logs related to the problem across various application components CloudWatch agent merge conﬂict failures CloudWatch Application Insights installs and conﬁgures the CloudWatch agent on customer instances. This includes creation of a CloudWatch agent conﬁguration ﬁle with conﬁgurations for metrics or logs. A merge conﬂict can occur if a customer's instance already has a CloudWatch agent conﬁguration ﬁle with diﬀerent conﬁgurations deﬁned for the same metrics or logs. To resolve the merge conﬂict, use the following steps: 1. Identify the CloudWatch agent conﬁguration ﬁles on your system. For more information about the ﬁle locations, see CloudWatch agent ﬁles and locations. View and troubleshoot Application Insights 1211 Amazon CloudWatch User Guide 2. Remove the resource conﬁgurations that you want to use in Application Insights from the existing CloudWatch agent conﬁguration ﬁle. If you want to only use Application Insights conﬁgurations,
acw-ug-345	acw-ug.pdf	345	metrics or logs. A merge conﬂict can occur if a customer's instance already has a CloudWatch agent conﬁguration ﬁle with diﬀerent conﬁgurations deﬁned for the same metrics or logs. To resolve the merge conﬂict, use the following steps: 1. Identify the CloudWatch agent conﬁguration ﬁles on your system. For more information about the ﬁle locations, see CloudWatch agent ﬁles and locations. View and troubleshoot Application Insights 1211 Amazon CloudWatch User Guide 2. Remove the resource conﬁgurations that you want to use in Application Insights from the existing CloudWatch agent conﬁguration ﬁle. If you want to only use Application Insights conﬁgurations, delete the existing CloudWatch agent conﬁguration ﬁles. High CPU usage from CloudWatch agent log processing CloudWatch Application Insights installs and conﬁgures the CloudWatch agent on customer instances. If an Amazon EC2 instance is conﬁgured with log paths that have large amounts of log data, the instance might experience increases in CPU usage while the CloudWatch agent processes the logs. To reduce CPU usage, remove the log path in the Amazon EC2 instance component conﬁguration. Alarms are not created For some metrics, Application Insights predicts the alarm threshold based on previous data points for the metric. To enable this prediction, the following criteria must be met. • Recent data points – There must be a minimum of 100 data points from the last 24 hours. The data points don't need to be continuous and can be scattered throughout the 24 hour time frame. • Historical data – There must be a minimum of 100 data points spanning the time frame from 15 days before the current date to 1 day before the current date. The data points don't need to be continuous and can be scattered throughout the 15 day time frame. Note For some metrics, Application Insights delays the creation of alarms until the preceding conditions are met. In this case, you get a conﬁguration history event that the metric lacks suﬃcient data points to establish the alarm threshold. Feedback Feedback You can provide feedback on the automatically generated insights on detected problems by designating them useful or not useful. Your feedback on the insights, along with your application View and troubleshoot Application Insights 1212 Amazon CloudWatch User Guide diagnostics (metric anomalies and log exceptions), are used to improve the future detection of similar problems. Conﬁguration errors CloudWatch Application Insights uses your conﬁguration to create monitoring telemetries for the components. When Application Insights detects an issue with your account or your conﬁguration, information is provided in the Remarks ﬁeld of the Application summary about how to resolve the conﬁguration issue for your application. The following table shows suggested resolutions for speciﬁc remarks. Remarks Suggested resolution Additional notes The quota for CloudForm ation has already been Application Insights creates one CloudFormation stack for n/a reached. No SSM instance role on the following instances. each application to manage CloudWatch agent installat ion and conﬁguration for all application components. By default, each AWS account can have 2000 stacks. See AWS CloudFormation Limits. To resolve this, raise the limit for CloudFormation stacks. For Application Insights to be able to install and conﬁgure CloudWatch agent on application instances , AmazonSSMManagedIn stanceCore and CloudWatc hAgentServerPolicy policies Application Insights calls the SSM DescribeInstanceIn formation API to get the list of instances with SSM permission. After the role is attached to the instance, it takes time for SSM to must be attached to the include the instance in the instance role. DescribeInstanceInformation result. Until SSM includes the instance in the result, NO_SSM_INSTANCE_ROLE View and troubleshoot Application Insights 1213 Amazon CloudWatch User Guide Remarks Suggested resolution Additional notes error remains present for the application. New components may need conﬁguration. Application Insights detects that there are new n/a components in the applicati on Resource Group. To resolve this, conﬁgure the new components accordingly. Logs and metrics supported by Amazon CloudWatch Application Insights The following lists show the supported logs and metrics for Amazon CloudWatch Application Insights. CloudWatch Application Insights supports the following logs: • Microsoft Internet Information Services (IIS) logs • Error log for SQL Server on EC2 • Custom .NET application logs, such as Log4Net • Windows Event logs, including Windows logs (System, Application, and Security) and Applications and Services log • Amazon CloudWatch Logs for AWS Lambda • Error log and slow log for RDS MySQL, Aurora MySQL, and MySQL on EC2 • Postgresql log for PostgreSQL RDS and PostgreSQL on EC2 • Amazon CloudWatch Logs for AWS Step Functions • Execution logs and access logs (JSON, CSV, and XML, but not CLF) for API Gateway REST API stages • Prometheus JMX exporter logs (EMF) • Alert logs and listener logs for Oracle on Amazon RDS and Oracle on Amazon EC2 • Container logs routing from Amazon ECS containers to CloudWatch using awslogs log driver. Supported logs and
acw-ug-346	acw-ug.pdf	346	Services log • Amazon CloudWatch Logs for AWS Lambda • Error log and slow log for RDS MySQL, Aurora MySQL, and MySQL on EC2 • Postgresql log for PostgreSQL RDS and PostgreSQL on EC2 • Amazon CloudWatch Logs for AWS Step Functions • Execution logs and access logs (JSON, CSV, and XML, but not CLF) for API Gateway REST API stages • Prometheus JMX exporter logs (EMF) • Alert logs and listener logs for Oracle on Amazon RDS and Oracle on Amazon EC2 • Container logs routing from Amazon ECS containers to CloudWatch using awslogs log driver. Supported logs and metrics 1214 Amazon CloudWatch User Guide • Container logs routing from Amazon ECS containers to CloudWatch using FireLens container log router. • Container logs routing from Amazon EKS or Kubernetes running on Amazon EC2 to CloudWatch using Fluent Bit or Fluentd log processor with Container Insights. • SAP HANA trace and error logs • HA Pacemaker logs • SAP ASE server logs • SAP ASE backup server logs • SAP ASE Replication server logs • SAP ASE RMA agent logs • SAP ASE Fault Manager logs • SAP NetWeaver dev trace logs • Process metrics for Windows processes using proctstat plugin for CloudWatch agent • Public DNS query logs for hosted zone • Amazon Route 53 Resolver DNS query logs CloudWatch Application Insights supports the following log classes: • Standard – Amazon CloudWatch Application Insights requires that log groups are conﬁgured with the CloudWatch Logs Standard log class to enable monitoring. CloudWatch Application Insights supports metrics for the following application components: • Amazon Elastic Compute Cloud (EC2) • CloudWatch built-in metrics • CloudWatch agent metrics (Windows server) • CloudWatch agent process metrics (Windows server) • CloudWatch agent metrics (Linux server) • Elastic Block Store (EBS) • Amazon Elastic File System (Amazon EFS) • Elastic Load Balancer (ELB) • Application ELB Supported logs and metrics 1215 Amazon CloudWatch User Guide • Amazon EC2 Auto Scaling groups • Amazon Simple Queue Server (SQS) • Amazon Relational Database Service (RDS) • RDS Database instances • RDS Database clusters • AWS Lambda function • Amazon DynamoDB table • Amazon S3 bucket • AWS Step Functions • Execution-level • Activity • Lambda function • Service integration • Step Functions API • API Gateway REST API stages • SAP HANA • SAP ASE • SAP ASE High Availability on Amazon EC2 • SAP NetWeaver • HA Cluster • Java • Amazon Elastic Container Service (Amazon ECS) • CloudWatch built-in metrics • Container Insights metrics • Container Insights Prometheus metrics • Kubernetes on AWS • Container Insights metrics • Container Insights Prometheus metrics • Amazon FSx • Amazon VPC Supported logs and metrics 1216 User Guide Amazon CloudWatch • Amazon VPC NAT gateways • Amazon Route 53 health check • Amazon Route 53 hosted zone • Amazon Route 53 Resolver endpoint • AWS Network Firewall rule group • AWS Network Firewall rule group association • Metrics with data points requirements • AWS/ApplicationELB • AWS/AutoScaling • AWS/EC2 • Elastic Block Store (EBS) • AWS/ELB • AWS/RDS • AWS/Lambda • AWS/SQS • AWS/CWAgent • AWS/DynamoDB • AWS/S3 • AWS/States • AWS/ApiGateway • AWS/SNS • Recommended metrics • Performance Counter metrics Amazon Elastic Compute Cloud (EC2) CloudWatch Application Insights supports the following metrics: Metrics • CloudWatch built-in metrics • CloudWatch agent metrics (Windows server) • CloudWatch agent process metrics (Windows server) Supported logs and metrics 1217 Amazon CloudWatch User Guide • CloudWatch agent metrics (Linux server) CloudWatch built-in metrics CPUCreditBalance CPUCreditUsage CPUSurplusCreditBalance CPUSurplusCreditsCharged CPUUtilization DiskReadBytes DiskReadOps DiskWriteBytes DiskWriteOps EBSByteBalance% EBSIOBalance% EBSReadBytes EBSReadOps EBSWriteBytes EBSWriteOps NetworkIn NetworkOut NetworkPacketsIn NetworkPacketsOut Supported logs and metrics 1218 User Guide Amazon CloudWatch StatusCheckFailed StatusCheckFailed_Instance StatusCheckFailed_System CloudWatch agent metrics (Windows server) .NET CLR Exceptions # of Exceps Thrown .NET CLR Exceptions # of Exceps Thrown/Sec .NET CLR Exceptions # of Filters/sec .NET CLR Exceptions # of Finallys/sec .NET CLR Exceptions Throw to Catch Depth/sec .NET CLR Interop # of CCWs .NET CLR Interop # of Stubs .NET CLR Interop # of TLB exports/sec .NET CLR Interop # of TLB imports/sec .NET CLR Interop # of marshaling .NET CLR Jit % Time in Jit .NET CLR Jit Standard Jit Failures .NET CLR Loading % Time Loading .NET CLR Loading Rate of Load Failures .NET CLR LocksAndThreads Contention Rate/sec .NET CLR LocksAndThreads Queue Length/sec .NET CLR Memory # Total Committed Bytes Supported logs and metrics 1219 Amazon CloudWatch .NET CLR Memory % Time in GC User Guide .NET CLR Networking 4.0.0.0 HttpWebRequest Average Queue Time .NET CLR Networking 4.0.0.0 HttpWebRequests Aborted/sec .NET CLR Networking 4.0.0.0 HttpWebRequests Failed/sec .NET CLR Networking 4.0.0.0 HttpWebRequests Queued/sec APP_POOL_WAS Total Worker Process Ping Failures ASP.NET Application Restarts ASP.NET Applications % Managed Processor Time (estimated) ASP.NET Applications Errors Total/Sec ASP.NET Applications Errors Unhandled During Execution/sec ASP.NET Applications Requests in Application Queue ASP.NET Applications Requests/Sec
acw-ug-347	acw-ug.pdf	347	CLR Loading Rate of Load Failures .NET CLR LocksAndThreads Contention Rate/sec .NET CLR LocksAndThreads Queue Length/sec .NET CLR Memory # Total Committed Bytes Supported logs and metrics 1219 Amazon CloudWatch .NET CLR Memory % Time in GC User Guide .NET CLR Networking 4.0.0.0 HttpWebRequest Average Queue Time .NET CLR Networking 4.0.0.0 HttpWebRequests Aborted/sec .NET CLR Networking 4.0.0.0 HttpWebRequests Failed/sec .NET CLR Networking 4.0.0.0 HttpWebRequests Queued/sec APP_POOL_WAS Total Worker Process Ping Failures ASP.NET Application Restarts ASP.NET Applications % Managed Processor Time (estimated) ASP.NET Applications Errors Total/Sec ASP.NET Applications Errors Unhandled During Execution/sec ASP.NET Applications Requests in Application Queue ASP.NET Applications Requests/Sec ASP.NET Request Wait Time ASP.NET Requests Queued HTTP Service Request Queues CurrentQueueSize LogicalDisk % Free Space Memory % Committed Bytes In Use Memory Available Mbytes Memory Pages/sec Network Interface Bytes Total/sec Paging File % Usage PhysicalDisk % Disk Time Supported logs and metrics 1220 Amazon CloudWatch User Guide PhysicalDisk Avg. Disk Queue Length PhysicalDisk Avg. Disk sec/Read PhysicalDisk Avg. Disk sec/Write PhysicalDisk Disk Read Bytes/sec PhysicalDisk Disk Reads/sec PhysicalDisk Disk Write Bytes/sec PhysicalDisk Disk Writes/sec Processor % Idle Time Processor % Interrupt Time Processor % Processor Time Processor % User Time SQLServer:Access Methods Forwarded Records/sec SQLServer:Access Methods Full Scans/sec SQLServer:Access Methods Page Splits/sec SQLServer:Buﬀer Manager Buﬀer cache hit ratio SQLServer:Buﬀer Manager Page life expectancy SQLServer:General Statistics Processes blocked SQLServer:General Statistics User Connections SQLServer:Latches Average Latch Wait Time (ms) SQLServer:Locks Average Wait Time (ms) SQLServer:Locks Lock Timeouts/sec SQLServer:Locks Lock Waits/sec Supported logs and metrics 1221 Amazon CloudWatch User Guide SQLServer:Locks Number of Deadlocks/sec SQLServer:Memory Manager Memory Grants Pending SQLServer:SQL Statistics Batch Requests/sec SQLServer:SQL Statistics SQL Compilations/sec SQLServer:SQL Statistics SQL Re-Compilations/sec System Processor Queue Length TCPv4 Connections Established TCPv6 Connections Established W3SVC_W3WP File Cache Flushes W3SVC_W3WP File Cache Misses W3SVC_W3WP Requests/Sec W3SVC_W3WP URI Cache Flushes W3SVC_W3WP URI Cache Misses Web Service Bytes Received/Sec Web Service Bytes Sent/Sec Web Service Connection attempts/sec Web Service Current Connections Web Service Get Requests/sec Web Service Post Requests/sec Bytes Received/sec Normal Messages Queue Length/sec Urgent Message Queue Length/sec Supported logs and metrics 1222 Amazon CloudWatch Reconnect Count Unacknowledged Message Queue Length/sec User Guide Messages Outstanding Messages Sent/sec Database Update Messages/sec Update Messages/sec Flushes/sec Crypto Checkpoints Saved/sec Crypto Checkpoints Restored/sec Registry Checkpoints Restored/sec Registry Checkpoints Saved/sec Cluster API Calls/sec Resource API Calls/sec Cluster Handles/sec Resource Handles/sec CloudWatch agent process metrics (Windows server) Process metrics are collected using the CloudWatch agent procstat plugin. Only Amazon EC2 instances running Windows workloads support process metrics. procstat cpu_time_system procstat cpu_time_user procstat cpu_usage procstat memory_rss Supported logs and metrics 1223 Amazon CloudWatch procstat memory_vms procstat read_bytes procstat write_bytes .procstat read_count procstat write_count CloudWatch agent metrics (Linux server) cpu_time_active cpu_time_guest cpu_time_guest_nice cpu_time_idle cpu_time_iowait cpu_time_irq cpu_time_nice cpu_time_softirq cpu_time_steal cpu_time_system cpu_time_user cpu_usage_active cpu_usage_guest cpu_usage_guest_nice cpu_usage_idle cpu_usage_iowait Supported logs and metrics User Guide 1224 Amazon CloudWatch cpu_usage_irq cpu_usage_nice cpu_usage_softirq cpu_usage_steal cpu_usage_system cpu_usage_user disk_free disk_inodes_free disk_inodes_used disk_used disk_used_percent diskio_io_time diskio_iops_in_progress diskio_read_bytes diskio_read_time diskio_reads diskio_write_bytes diskio_write_time diskio_writes mem_active mem_available mem_available_percent Supported logs and metrics User Guide 1225 Amazon CloudWatch mem_buﬀered mem_cached mem_free mem_inactive mem_used mem_used_percent net_bytes_recv net_bytes_sent net_drop_in net_drop_out net_err_in net_err_out net_packets_recv net_packets_sent netstat_tcp_close netstat_tcp_close_wait netstat_tcp_closing netstat_tcp_established netstat_tcp_ﬁn_wait1 netstat_tcp_ﬁn_wait2 netstat_tcp_last_ack netstat_tcp_listen Supported logs and metrics User Guide 1226 User Guide Amazon CloudWatch netstat_tcp_none netstat_tcp_syn_recv netstat_tcp_syn_sent netstat_tcp_time_wait netstat_udp_socket processes_blocked processes_dead processes_idle processes_paging processes_running processes_sleeping processes_stopped processes_total processes_total_threads processes_wait processes_zombies swap_free swap_used swap_used_percent Elastic Block Store (EBS) CloudWatch Application Insights supports the following metrics: Supported logs and metrics 1227 Amazon CloudWatch VolumeReadBytes VolumeWriteBytes VolumeReadOps VolumeWriteOps VolumeTotalReadTime VolumeTotalWriteTime VolumeIdleTime VolumeQueueLength VolumeThroughputPercentage VolumeConsumedReadWriteOps BurstBalance Amazon Elastic File System (Amazon EFS) CloudWatch Application Insights supports the following metrics: BurstCreditBalance PercentIOLimit PermittedThroughput MeteredIOBytes TotalIOBytes DataWriteIOBytes DataReadIOBytes MetadataIOBytes Supported logs and metrics User Guide 1228 Amazon CloudWatch ClientConnections TimeSinceLastSync StorageBytes Throughput PercentageOfPermittedThroughputUtilization ThroughputIOPS PercentThroughputDataReadIOByte PercentThroughputDataWriteIOBytes PercentageOfIOPSDataReadIOBytes PercentageOfIOPSDataWriteIOBytes AverageDataReadIOBytesSize AverageDataWriteIOBytesSize Elastic Load Balancer (ELB) CloudWatch Application Insights supports the following metrics: EstimatedALBActiveConnectionCount EstimatedALBConsumedLCUs EstimatedALBNewConnectionCount EstimatedProcessedBytes HTTPCode_Backend_4XX HTTPCode_Backend_5XX HealthyHostCount Supported logs and metrics User Guide 1229 User Guide Amazon CloudWatch RequestCount UnHealthyHostCount Application ELB CloudWatch Application Insights supports the following metrics: EstimatedALBActiveConnectionCount EstimatedALBConsumedLCUs EstimatedALBNewConnectionCount EstimatedProcessedBytes HTTPCode_Backend_4XX HTTPCode_Backend_5XX HealthyHostCount Latency RequestCount SurgeQueueLength UnHealthyHostCount Amazon EC2 Auto Scaling groups CloudWatch Application Insights supports the following metrics: CPUCreditBalance CPUCreditUsage CPUSurplusCreditBalance CPUSurplusCreditsCharged Supported logs and metrics 1230 User Guide Amazon CloudWatch CPUUtilization DiskReadBytes DiskReadOps DiskWriteBytes DiskWriteOps EBSByteBalance% EBSIOBalance% EBSReadBytes EBSReadOps EBSWriteBytes EBSWriteOps NetworkIn NetworkOut NetworkPacketsIn NetworkPacketsOut StatusCheckFailed StatusCheckFailed_Instance StatusCheckFailed_System Amazon Simple Queue Server (SQS) CloudWatch Application Insights supports the following metrics: ApproximateAgeOfOldestMessage Supported logs and metrics 1231 Amazon CloudWatch User Guide ApproximateNumberOfMessagesDelayed ApproximateNumberOfMessagesNotVisible ApproximateNumberOfMessagesVisible NumberOfEmptyReceives NumberOfMessagesDeleted NumberOfMessagesReceived NumberOfMessagesSent Amazon Relational Database Service (RDS) CloudWatch Application Insights supports the following metrics: Metrics • RDS Database instances • RDS Database clusters RDS Database instances BurstBalance CPUCreditBalance CPUUtilization DatabaseConnections DiskQueueDepth FailedSQLServerAgentJobsCount FreeStorageSpace FreeableMemory NetworkReceiveThroughput Supported logs and metrics 1232 User Guide Amazon CloudWatch NetworkTransmitThroughput ReadIOPS ReadLatency ReadThroughput WriteIOPS WriteLatency WriteThroughput RDS Database clusters ActiveTransactions AuroraBinlogReplicaLag AuroraReplicaLag BackupRetentionPeriodStorageUsed BinLogDiskUsage BlockedTransactions BuﬀerCacheHitRatio CPUUtilization CommitLatency CommitThroughput DDLLatency DDLThroughput
acw-ug-348	acw-ug.pdf	348	NetworkIn NetworkOut NetworkPacketsIn NetworkPacketsOut StatusCheckFailed StatusCheckFailed_Instance StatusCheckFailed_System Amazon Simple Queue Server (SQS) CloudWatch Application Insights supports the following metrics: ApproximateAgeOfOldestMessage Supported logs and metrics 1231 Amazon CloudWatch User Guide ApproximateNumberOfMessagesDelayed ApproximateNumberOfMessagesNotVisible ApproximateNumberOfMessagesVisible NumberOfEmptyReceives NumberOfMessagesDeleted NumberOfMessagesReceived NumberOfMessagesSent Amazon Relational Database Service (RDS) CloudWatch Application Insights supports the following metrics: Metrics • RDS Database instances • RDS Database clusters RDS Database instances BurstBalance CPUCreditBalance CPUUtilization DatabaseConnections DiskQueueDepth FailedSQLServerAgentJobsCount FreeStorageSpace FreeableMemory NetworkReceiveThroughput Supported logs and metrics 1232 User Guide Amazon CloudWatch NetworkTransmitThroughput ReadIOPS ReadLatency ReadThroughput WriteIOPS WriteLatency WriteThroughput RDS Database clusters ActiveTransactions AuroraBinlogReplicaLag AuroraReplicaLag BackupRetentionPeriodStorageUsed BinLogDiskUsage BlockedTransactions BuﬀerCacheHitRatio CPUUtilization CommitLatency CommitThroughput DDLLatency DDLThroughput DMLLatency DMLThroughput Supported logs and metrics 1233 Amazon CloudWatch DatabaseConnections Deadlocks DeleteLatency DeleteThroughput EngineUptime FreeLocalStorage FreeableMemory InsertLatency InsertThroughput LoginFailures NetworkReceiveThroughput NetworkThroughput NetworkTransmitThroughput Queries ResultSetCacheHitRatio SelectLatency SelectThroughput SnapshotStorageUsed TotalBackupStorageBilled UpdateLatency UpdateThroughput VolumeBytesUsed Supported logs and metrics User Guide 1234 Amazon CloudWatch VolumeReadIOPs VolumeWriteIOPs AWS Lambda function CloudWatch Application Insights supports the following metrics: User Guide Errors DeadLetterErrors Duration Throttles IteratorAge ProvisionedConcurrencySpilloverInvocations Amazon DynamoDB table CloudWatch Application Insights supports the following metrics: SystemErrors UserErrors ConsumedReadCapacityUnits ConsumedWriteCapacityUnits ReadThrottleEvents WriteThrottleEvents TimeToLiveDeletedItemCount ConditionalCheckFailedRequests TransactionConﬂict Supported logs and metrics 1235 Amazon CloudWatch ReturnedRecordsCount PendingReplicationCount ReplicationLatency Amazon S3 bucket CloudWatch Application Insights supports the following metrics: ReplicationLatency BytesPendingReplication OperationsPendingReplication 4xxErrors 5xxErrors AllRequests GetRequests PutRequests DeleteRequests HeadRequests PostRequests SelectRequests ListRequests SelectScannedBytes SelectReturnedBytes FirstByteLatency Supported logs and metrics User Guide 1236 Amazon CloudWatch TotalRequestLatency BytesDownloaded BytesUploaded AWS Step Functions CloudWatch Application Insights supports the following metrics: Metrics • Execution-level • Activity • Lambda function • Service integration • Step Functions API Execution-level ExecutionTime ExecutionThrottled ExecutionsFailed ExecutionsTimedOut ExecutionsAborted ExecutionsSucceeded ExecutionsStarted Activity ActivityRunTime ActivityScheduleTime Supported logs and metrics User Guide 1237 User Guide Amazon CloudWatch ActivityTime ActivitiesFailed ActivitiesHeartbeatTimedOut ActivitiesTimedOut ActivitiesScheduled ActivitiesSucceeded ActivitiesStarted Lambda function LambdaFunctionRunTime LambdaFunctionScheduleTime LambdaFunctionTime LambdaFunctionsFailed LambdaFunctionsTimedOut LambdaFunctionsScheduled LambdaFunctionsSucceeded LambdaFunctionsStarted Service integration ServiceIntegrationRunTime ServiceIntegrationScheduleTime ServiceIntegrationTime ServiceIntegrationsFailed ServiceIntegrationsTimedOut Supported logs and metrics 1238 User Guide Amazon CloudWatch ServiceIntegrationsScheduled ServiceIntegrationsSucceeded ServiceIntegrationsStarted Step Functions API ThrottledEvents ProvisionedBucketSize ProvisionedReﬁllRate ConsumedCapacity API Gateway REST API stages CloudWatch Application Insights supports the following metrics: 4XXError 5XXError IntegrationLatency Latency CacheHitCount CacheMissCount SAP HANA Note CloudWatch Application Insights supports only single SID HANA environments. If multiple HANA SIDs are attached, monitoring will be set up for only the ﬁrst detected SID. CloudWatch Application Insights supports the following metrics: Supported logs and metrics 1239 Amazon CloudWatch User Guide hanadb_every_service_started_status hanadb_daemon_service_started_status hanadb_preprocessor_service_started_status hanadb_webdispatcher_service_started_status hanadb_compileserver_service_started_status hanadb_nameserver_service_started_status hanadb_server_startup_time_variations_seconds hanadb_level_5_alerts_count hanadb_level_4_alerts_count hanadb_out_of_memory_events_count hanadb_max_trigger_read_ratio_percent hanadb_max_trigger_write_ratio_percent hanadb_log_switch_wait_ratio_percent hanadb_log_switch_race_ratio_percent hanadb_time_since_last_savepoint_seconds hanadb_disk_usage_highlevel_percent hanadb_max_converter_page_number_count hanadb_long_running_savepoints_count hanadb_failed_io_reads_count hanadb_failed_io_writes_count hanadb_disk_data_unused_percent Supported logs and metrics 1240 Amazon CloudWatch User Guide hanadb_current_allocation_limit_used_percent hanadb_table_allocation_limit_used_percent hanadb_host_total_physical_memory_mb hanadb_host_physical_memory_used_mb hanadb_host_physical_memory_free_mb hanadb_swap_memory_free_mb hanadb_swap_memory_used_mb hanadb_host_allocation_limit_mb hanadb_host_total_memory_used_mb hanadb_host_total_peak_memory_used_mb hanadb_host_total_allocation_limit_mb hanadb_host_code_size_mb hanadb_host_shared_memory_allocation_mb hanadb_cpu_usage_percent hanadb_cpu_user_percent hanadb_cpu_system_percent hanadb_cpu_waitio_percent hanadb_cpu_busy_percent hanadb_cpu_idle_percent hanadb_long_delta_merge_count hanadb_unsuccessful_delta_merge_count Supported logs and metrics 1241 Amazon CloudWatch User Guide hanadb_successful_delta_merge_count hanadb_row_store_allocated_size_mb hanadb_row_store_free_size_mb hanadb_row_store_used_size_mb hanadb_temporary_tables_count hanadb_large_non_compressed_tables_count hanadb_total_non_compressed_tables_count hanadb_longest_running_job_seconds hanadb_average_commit_time_milliseconds hanadb_suspended_sql_statements_count hanadb_plan_cache_hit_ratio_percent hanadb_plan_cache_lookup_count hanadb_plan_cache_hit_count hanadb_plan_cache_total_execution_microseconds hanadb_plan_cache_cursor_duration_microseconds hanadb_plan_cache_preparation_microseconds hanadb_plan_cache_evicted_count hanadb_plan_cache_evicted_microseconds hanadb_plan_cache_evicted_preparation_count hanadb_plan_cache_evicted_execution_count hanadb_plan_cache_evicted_preparation_microseconds hanadb_plan_cache_evicted_cursor_duration_microseconds Supported logs and metrics 1242 Amazon CloudWatch User Guide hanadb_plan_cache_evicted_total_execution_microseconds hanadb_plan_cache_evicted_plan_size_mb hanadb_plan_cache_count hanadb_plan_cache_preparation_count hanadb_plan_cache_execution_count hanadb_network_collision_rate hanadb_network_receive_rate hanadb_network_transmit_rate hanadb_network_packet_receive_rate hanadb_network_packet_transmit_rate hanadb_network_transmit_error_rate hanadb_network_receive_error_rate hanadb_time_until_license_expires_days hanadb_is_license_valid_status hanadb_local_running_connections_count hanadb_local_idle_connections_count hanadb_remote_running_connections_count hanadb_remote_idle_connections_count hanadb_last_full_data_backup_age_days hanadb_last_data_backup_age_days hanadb_last_log_backup_age_hours hanadb_failed_data_backup_past_7_days_count Supported logs and metrics 1243 Amazon CloudWatch User Guide hanadb_failed_log_backup_past_7_days_count hanadb_oldest_backup_in_catalog_age_days hanadb_backup_catalog_size_mb hanadb_hsr_replication_status hanadb_hsr_log_shipping_delay_seconds hanadb_hsr_secondary_failover_count hanadb_hsr_secondary_reconnect_count hanadb_hsr_async_buﬀer_used_mb hanadb_hsr_secondary_active_status hanadb_handle_count hanadb_ping_time_milliseconds hanadb_connection_count hanadb_internal_connection_count hanadb_external_connection_count hanadb_idle_connection_count hanadb_transaction_count hanadb_internal_transaction_count hanadb_external_transaction_count hanadb_user_transaction_count hanadb_blocked_transaction_count hanadb_statement_count hanadb_active_commit_id_range_count Supported logs and metrics 1244 User Guide Amazon CloudWatch hanadb_mvcc_version_count hanadb_pending_session_count hanadb_record_lock_count hanadb_read_count hanadb_write_count hanadb_merge_count hanadb_unload_count hanadb_active_thread_count hanadb_waiting_thread_count hanadb_total_thread_count hanadb_active_sql_executor_count hanadb_waiting_sql_executor_count hanadb_total_sql_executor_count hanadb_data_write_size_mb hanadb_data_write_time_milliseconds hanadb_log_write_size_mb hanadb_log_write_time_milliseconds hanadb_data_read_size_mb hanadb_data_read_time_milliseconds hanadb_log_read_size_mb hanadb_log_read_time_milliseconds hanadb_data_backup_write_size_mb Supported logs and metrics 1245 Amazon CloudWatch User Guide hanadb_data_backup_write_time_milliseconds hanadb_log_backup_write_size_mb hanadb_log_backup_write_time_milliseconds hanadb_mutex_collision_count hanadb_read_write_lock_collision_count hanadb_admission_control_admit_count hanadb_admission_control_reject_count hanadb_admission_control_queue_size_mb hanadb_admission_control_wait_time_milliseconds SAP ASE CloudWatch Application Insights supports the following metrics: asedb_database_availability asedb_trunc_log_on_chkpt_enabled asedb_last_db_backup_age_in_days asedb_last_transaction_log_backup_age_in_hours asedb_suspected_database asedb_db_space_usage_percent asedb_db_log_space_usage_percent asedb_locked_login asedb_has_mixed_log_and_data asedb_runtime_for_open_transactions Supported logs and metrics 1246 User Guide Amazon CloudWatch asedb_data_cache_hit_ratio asedb_data_cache_usage asedb_sql_cache_hit_ratio asedb_cache_usage asedb_run_queue_length asedb_number_of_rollbacks asedb_number_of_commits asedb_number_of_transactions asedb_outstanding_disk_io asedb_percent_io_busy asedb_percent_system_busy asedb_percent_locks_active asedb_scheduled_jobs_failed_percent asedb_user_connections_percent asedb_query_logical_reads asedb_query_physical_reads asedb_query_cpu_time asedb_query_memory_usage SAP ASE High Availability on Amazon EC2 CloudWatch Application Insights supports the following metrics: asedb_ha_replication_state Supported logs and metrics 1247 User Guide Amazon CloudWatch asedb_ha_replication_mode asedb_ha_replication_latency_in_minutes SAP NetWeaver CloudWatch Application Insights supports the following metrics: Metric Description sap_alerts_ResponseTime sap_alerts_ResponseTimeDialog sap_alerts_ResponseTimeDialogRFC sap_alerts_DBRequestTime sap_alerts_FrontendResponseTime sap_alerts_Database sap_alerts_QueueTime sap_alerts_AbortedJobs The SAP response time alert from CCMS (RZ20)>R3Services>Dialog>ResponseTime. The SAP response time dialog alert from CCMS (RZ20)>R3Services>Dialog> ResponseT imeDialog. The SAP response time alert from CCMS (RZ20)>R3Services> Dialog>ResponseTim eDialogRFC. The SAP response time alert from CCMS (RZ20)>R3Services>Dialog>DBRequestTime. The SAP response time alert from CCMS (RZ20)>R3Services > Dialog>FrontEndRes ponseTime. The SAP system has logged database-related errors. Alert from SM21 or CCMS (RZ20)>R3 Syslog>Database. The SAP queue time alert from CCMS (RZ20)>R3Services>Dialog>QueueTime. Failed background jobs in SAP system. Alert from (RZ20)>R3Services > Backgroun d>AbortedJobs. Supported logs and metrics 1248 Amazon CloudWatch Metric sap_alerts_BasisSystem sap_alerts_Security sap_alerts_System sap_alerts_LongRunners sap_alerts_SqlError sap_alerts_State sap_alerts_Shortdumps sap_alerts_Availability sap_dispatcher_queue_high sap_dispatcher_queue_max User Guide Description SAP system logged system-level errors. Alert from SM21 or CCMS (RZ20)>R3Syslog>Ba sisSystem. The SAP system logged security-related messages. Alert from SM21 or CCMS (RZ20)>R3Syslog>Security. The SAP system logged security or audit-rel ated messages.
acw-ug-349	acw-ug.pdf	349	(RZ20)>R3Services>Dialog>DBRequestTime. The SAP response time alert from CCMS (RZ20)>R3Services > Dialog>FrontEndRes ponseTime. The SAP system has logged database-related errors. Alert from SM21 or CCMS (RZ20)>R3 Syslog>Database. The SAP queue time alert from CCMS (RZ20)>R3Services>Dialog>QueueTime. Failed background jobs in SAP system. Alert from (RZ20)>R3Services > Backgroun d>AbortedJobs. Supported logs and metrics 1248 Amazon CloudWatch Metric sap_alerts_BasisSystem sap_alerts_Security sap_alerts_System sap_alerts_LongRunners sap_alerts_SqlError sap_alerts_State sap_alerts_Shortdumps sap_alerts_Availability sap_dispatcher_queue_high sap_dispatcher_queue_max User Guide Description SAP system logged system-level errors. Alert from SM21 or CCMS (RZ20)>R3Syslog>Ba sisSystem. The SAP system logged security-related messages. Alert from SM21 or CCMS (RZ20)>R3Syslog>Security. The SAP system logged security or audit-rel ated messages. Alert from SM21 or CCMS (RZ20)>Security>System. There are long running programs in your SAP system. Alert from CCMS (RZ20)>R3Services > Dialog>LongRunners. There are SAP database client layer error logs. Alert from CCMS(RZ20)>DatabaseClient>A bapSql>SqlError. State alert from CCMS (RZ20)>OS Collector >State. Shortdumps alert from ST22 and CCMS (RZ20)>R3Abap>Shortdumps. Availability alert for SAP application server instance from SM21, SM50, SM51, SM66, and CCMS (RZ20)>InstanceAsTask>Availability. The SAPControl Web Service function GetQueueStatistic provides the dispatcher queue high count. The SAPControl Web Service function GetQueueStatistic provides the dispatcher queue max count. Supported logs and metrics 1249 Amazon CloudWatch Metric sap_dispatcher_queue_now sap_dispatcher_queue_reads sap_dispatcher_queue_writes User Guide Description The SAPControl Web Service function GetQueueStatistic provides the dispatcher queue now count. The SAPControl Web Service function GetQueueStatistic provides the dispatcher queue reads count. The SAPControl Web Service function GetQueueStatistic provides the dispatcher queue writes count. sap_enqueue_server_arguments_high The SAPControl Web Service function EnqGetStatistic provides the enqueue arguments high. sap_enqueue_server_arguments_max The SAPControl Web Service function EnqGetStatistic provides the enqueue arguments max. sap_enqueue_server_arguments_now The SAPControl Web Service function EnqGetStatistic provides the enqueue arguments now. sap_enqueue_server_arguments_state The SAPControl Web Service function EnqGetStatistic provides the enqueue arguments state. sap_enqueue_server_backup_requests The SAPControl Web Service function EnqGetStatistic provides the enqueue backup requests. sap_enqueue_server_cleanup_requests The SAPControl Web Service function EnqGetStatistic provides the enqueue cleanup requests. Supported logs and metrics 1250 Amazon CloudWatch Metric Description User Guide sap_enqueue_server_dequeue_all_requests The SAPControl Web Service function EnqGetStatistic provides the dequeue all requests. sap_enqueue_server_dequeue_errors The SAPControl Web Service function EnqGetStatistic provides the dequeue errors. sap_enqueue_server_dequeue_requests The SAPControl Web Service function EnqGetStatistic provides the dequeue requests. sap_enqueue_server_enqueue_errors The SAPControl Web Service function EnqGetStatistic provides the enqueue errors. sap_enqueue_server_enqueue_rejects The SAPControl Web Service function EnqGetStatistic provides the enqueue rejects. sap_enqueue_server_enqueue_requests The SAPControl Web Service function EnqGetStatistic provides the enqueue requests. sap_enqueue_server_lock_time The SAPControl Web Service function EnqGetStatistic provides the enqueue lock time. sap_enqueue_server_lock_wait_time The SAPControl Web Service function EnqGetStatistic provides the enqueue lock wait time. sap_enqueue_server_locks_high The SAPControl Web Service function EnqGetStatistic provides the enqueue locks high. Supported logs and metrics 1251 Amazon CloudWatch Metric Description User Guide sap_enqueue_server_locks_max The SAPControl Web Service function EnqGetStatistic provides the enqueue locks max. sap_enqueue_server_locks_now The SAPControl Web Service function EnqGetStatistic provides the enqueue locks now. sap_enqueue_server_locks_state The SAPControl Web Service function EnqGetStatistic provides the enqueue locks state. sap_enqueue_server_owner_high The SAPControl Web Service function EnqGetStatistic provides the enqueue owner high. sap_enqueue_server_owner_max The SAPControl Web Service function EnqGetStatistic provides the enqueue owner max. sap_enqueue_server_owner_now The SAPControl Web Service function EnqGetStatistic provides the enqueue owner now. sap_enqueue_server_owner_state The SAPControl Web Service function EnqGetStatistic provides the enqueue owner state. sap_enqueue_server_replication_state The SAPControl Web Service function EnqGetStatistic provides the enqueue replication state status. sap_enqueue_server_reporting_requests The SAPControl Web Service function EnqGetStatistic provides the reqporting requests status. Supported logs and metrics 1252 Amazon CloudWatch Metric Description User Guide sap_enqueue_server_server_time The SAPControl Web Service function EnqGetStatistic provides the enqueue server time. sap_HA_check_failover_conﬁg_state The SAPControl Web Service function HACheckFailoverConfig SAP High Availability status. provides the sap_HA_get_failover_conﬁg_HAActive The SAPControl Web Service function HAGetFailoverConfig provides the SAP High Availability Cluster conﬁguration and status. sap_start_service_processes The SAPControl Web Service function GetProcessList provides the disp+work , IGS, gwrd, icman, message server, and enqueue server processes status. HA Cluster CloudWatch Application Insights supports the following metrics: ha_cluster_pacemaker_stonith_enabled ha_cluster_corosync_quorate hanadb_webdispatcher_service_started_status ha_cluster_pacemaker_nodes ha_cluster_corosync_ring_errors ha_cluster_pacemaker_fail_count Java CloudWatch Application Insights supports the following metrics: Supported logs and metrics 1253 Amazon CloudWatch User Guide java_lang_memory_heapmemoryusage_used java_lang_memory_heapmemoryusage_committed java_lang_operatingsystem_openﬁledescriptorcount java_lang_operatingsystem_maxﬁledescriptorcount java_lang_operatingsystem_freephysicalmemorysize java_lang_operatingsystem_freeswapspacesize java_lang_threading_threadcount java_lang_threading_daemonthreadcount java_lang_classloading_loadedclasscount java_lang_garbagecollector_collectiontime_copy java_lang_garbagecollector_collectiontime_ps_scavenge java_lang_garbagecollector_collectiontime_parnew java_lang_garbagecollector_collectiontime_marksweepcompact java_lang_garbagecollector_collectiontime_ps_marksweep java_lang_garbagecollector_collectiontime_concurrentmarksweep java_lang_garbagecollector_collectiontime_g1_young_generation java_lang_garbagecollector_collectiontime_g1_old_generation java_lang_garbagecollector_collectiontime_g1_mixed_generation java_lang_operatingsystem_committedvirtualmemorysize Amazon Elastic Container Service (Amazon ECS) CloudWatch Application Insights supports the following metrics: Metrics • CloudWatch built-in metrics Supported logs and metrics 1254 Amazon CloudWatch • Container Insights metrics • Container Insights Prometheus metrics CloudWatch built-in metrics CPUReservation CPUUtilization MemoryReservation MemoryUtilization GPUReservation Container Insights metrics ContainerInstanceCount CpuUtilized CpuReserved DeploymentCount DesiredTaskCount MemoryUtilized MemoryReserved NetworkRxBytes NetworkTxBytes PendingTaskCount RunningTaskCount ServiceCount StorageReadBytes Supported logs and metrics User Guide 1255 User Guide Amazon CloudWatch StorageWriteBytes TaskCount TaskSetCount instance_cpu_limit instance_cpu_reserved_capacity instance_cpu_usage_total instance_cpu_utilization instance_ﬁlesystem_utilization instance_memory_limit instance_memory_reserved_capacity instance_memory_utilization instance_memory_working_set instance_network_total_bytes instance_number_of_running_tasks Container Insights Prometheus metrics Java JMX metrics java_lang_memory_heapmemoryusage_used java_lang_memory_heapmemoryusage_committed java_lang_operatingsystem_openﬁledescriptorcount java_lang_operatingsystem_maxﬁledescriptorcount java_lang_operatingsystem_freephysicalmemorysize java_lang_operatingsystem_freeswapspacesize Supported logs and metrics 1256 Amazon CloudWatch java_lang_threading_threadcount java_lang_classloading_loadedclasscount java_lang_threading_daemonthreadcount java_lang_garbagecollector_collectiontime_copy java_lang_garbagecollector_collectiontime_ps_scavenge java_lang_garbagecollector_collectiontime_parnew java_lang_garbagecollector_collectiontime_marksweepcompact java_lang_garbagecollector_collectiontime_ps_marksweep java_lang_garbagecollector_collectiontime_concurrentmarksweep java_lang_garbagecollector_collectiontime_g1_young_generation java_lang_garbagecollector_collectiontime_g1_old_generation java_lang_garbagecollector_collectiontime_g1_mixed_generation java_lang_operatingsystem_committedvirtualmemorysize Kubernetes on AWS CloudWatch Application Insights supports the following metrics: Metrics • Container Insights metrics • Container
acw-ug-350	acw-ug.pdf	350	metrics CloudWatch built-in metrics CPUReservation CPUUtilization MemoryReservation MemoryUtilization GPUReservation Container Insights metrics ContainerInstanceCount CpuUtilized CpuReserved DeploymentCount DesiredTaskCount MemoryUtilized MemoryReserved NetworkRxBytes NetworkTxBytes PendingTaskCount RunningTaskCount ServiceCount StorageReadBytes Supported logs and metrics User Guide 1255 User Guide Amazon CloudWatch StorageWriteBytes TaskCount TaskSetCount instance_cpu_limit instance_cpu_reserved_capacity instance_cpu_usage_total instance_cpu_utilization instance_ﬁlesystem_utilization instance_memory_limit instance_memory_reserved_capacity instance_memory_utilization instance_memory_working_set instance_network_total_bytes instance_number_of_running_tasks Container Insights Prometheus metrics Java JMX metrics java_lang_memory_heapmemoryusage_used java_lang_memory_heapmemoryusage_committed java_lang_operatingsystem_openﬁledescriptorcount java_lang_operatingsystem_maxﬁledescriptorcount java_lang_operatingsystem_freephysicalmemorysize java_lang_operatingsystem_freeswapspacesize Supported logs and metrics 1256 Amazon CloudWatch java_lang_threading_threadcount java_lang_classloading_loadedclasscount java_lang_threading_daemonthreadcount java_lang_garbagecollector_collectiontime_copy java_lang_garbagecollector_collectiontime_ps_scavenge java_lang_garbagecollector_collectiontime_parnew java_lang_garbagecollector_collectiontime_marksweepcompact java_lang_garbagecollector_collectiontime_ps_marksweep java_lang_garbagecollector_collectiontime_concurrentmarksweep java_lang_garbagecollector_collectiontime_g1_young_generation java_lang_garbagecollector_collectiontime_g1_old_generation java_lang_garbagecollector_collectiontime_g1_mixed_generation java_lang_operatingsystem_committedvirtualmemorysize Kubernetes on AWS CloudWatch Application Insights supports the following metrics: Metrics • Container Insights metrics • Container Insights Prometheus metrics Container Insights metrics cluster_failed_node_count cluster_node_count namespace_number_of_running_pods node_cpu_limit Supported logs and metrics User Guide 1257 Amazon CloudWatch node_cpu_reserved_capacity node_cpu_usage_total node_cpu_utilization node_ﬁlesystem_utilization node_memory_limit node_memory_reserved_capacity node_memory_utilization node_memory_working_set node_network_total_bytes node_number_of_running_containers node_number_of_running_pods pod_cpu_reserved_capacity pod_cpu_utilization pod_cpu_utilization_over_pod_limit pod_memory_reserved_capacity pod_memory_utilization pod_memory_utilization_over_pod_limit pod_network_rx_bytes pod_network_tx_bytes service_number_of_running_pods Container Insights Prometheus metrics Java JMX metrics Supported logs and metrics User Guide 1258 Amazon CloudWatch User Guide java_lang_memory_heapmemoryusage_used java_lang_memory_heapmemoryusage_committed java_lang_operatingsystem_openﬁledescriptorcount java_lang_operatingsystem_maxﬁledescriptorcount java_lang_operatingsystem_freephysicalmemorysize java_lang_operatingsystem_freeswapspacesize java_lang_threading_threadcount java_lang_classloading_loadedclasscount java_lang_threading_daemonthreadcount java_lang_garbagecollector_collectiontime_copy java_lang_garbagecollector_collectiontime_ps_scavenge java_lang_garbagecollector_collectiontime_parnew java_lang_garbagecollector_collectiontime_marksweepcompact java_lang_garbagecollector_collectiontime_ps_marksweep java_lang_garbagecollector_collectiontime_concurrentmarksweep java_lang_garbagecollector_collectiontime_g1_young_generation java_lang_garbagecollector_collectiontime_g1_old_generation java_lang_garbagecollector_collectiontime_g1_mixed_generation java_lang_operatingsystem_committedvirtualmemorysize Amazon FSx CloudWatch Application Insights supports the following metrics: DataReadBytes Supported logs and metrics 1259 User Guide Amazon CloudWatch DataWriteBytes DataReadOperations DataWriteOperations MetadataOperations FreeStorageCapacity FreeDataStorageCapacity LogicalDiskUsage PhysicalDiskUsage Amazon VPC CloudWatch Application Insights supports the following metrics: NetworkAddressUsage NetworkAddressUsagePeered VPCFirewallQueryVolume Amazon VPC NAT gateways CloudWatch Application Insights supports the following metrics: ErrorPortAllocation IdleTimeoutCount Amazon Route 53 health check CloudWatch Application Insights supports the following metrics: ChildHealthCheckHealthyCount ConnectionTime HealthCheckPercentageHealthy Supported logs and metrics 1260 User Guide Amazon CloudWatch HealthCheckStatus SSLHandshakeTime TimeToFirstByte Amazon Route 53 hosted zone CloudWatch Application Insights supports the following metrics: DNSQueries DNSSECInternalFailure DNSSECKeySigningKeysNeedingAction DNSSECKeySigningKeyMaxNeedingActionAge DNSSECKeySigningKeyAge Amazon Route 53 Resolver endpoint CloudWatch Application Insights supports the following metrics: EndpointHealthyENICount EndpointUnHealthyENICount InboundQueryVolume OutboundQueryVolume OutboundQueryAggregateVolume AWS Network Firewall rule group CloudWatch Application Insights supports the following metrics: FirewallRuleGroupQueryVolume AWS Network Firewall rule group association CloudWatch Application Insights supports the following metrics: Supported logs and metrics 1261 Amazon CloudWatch User Guide FirewallRuleGroupVpcQueryVolume Metrics with data points requirements For metrics without an obvious default threshold to alarm on, Application Insights waits until the metric has enough data points to predict a reasonable threshold to alarm on. The metric data points requirement that CloudWatch Application Insights checks before an alarm is created are: • The metric has at least 100 data points from the past 15 to the past 2 days. • The metric has at least 100 data points from the last day. The following metrics follow these data points requirements. Note that CloudWatch agent metrics require up to one hour to create alarms. Metrics • AWS/ApplicationELB • AWS/AutoScaling • AWS/EC2 • Elastic Block Store (EBS) • AWS/ELB • AWS/RDS • AWS/Lambda • AWS/SQS • AWS/CWAgent • AWS/DynamoDB • AWS/S3 • AWS/States • AWS/ApiGateway • AWS/SNS AWS/ApplicationELB ActiveConnectionCount ConsumedLCUs Supported logs and metrics 1262 User Guide Amazon CloudWatch HTTPCode_ELB_4XX_Count HTTPCode_Target_2XX_Count HTTPCode_Target_3XX_Count HTTPCode_Target_4XX_Count HTTPCode_Target_5XX_Count NewConnectionCount ProcessedBytes TargetResponseTime UnHealthyHostCount AWS/AutoScaling GroupDesiredCapacity GroupInServiceInstances GroupMaxSize GroupMinSize GroupPendingInstances GroupStandbyInstances GroupTerminatingInstances GroupTotalInstances AWS/EC2 CPUCreditBalance CPUCreditUsage CPUSurplusCreditBalance CPUSurplusCreditsCharged Supported logs and metrics 1263 Amazon CloudWatch CPUUtilization DiskReadBytes DiskReadOps DiskWriteBytes DiskWriteOps EBSByteBalance% EBSIOBalance% EBSReadBytes EBSReadOps EBSWriteBytes EBSWriteOps NetworkIn NetworkOut NetworkPacketsIn NetworkPacketsOut Elastic Block Store (EBS) VolumeReadBytes VolumeWriteBytes VolumeReadOps VolumeWriteOps VolumeTotalReadTime VolumeTotalWriteTime VolumeIdleTime Supported logs and metrics User Guide 1264 Amazon CloudWatch VolumeQueueLength VolumeThroughputPercentage VolumeConsumedReadWriteOps BurstBalance AWS/ELB EstimatedALBActiveConnectionCount EstimatedALBConsumedLCUs EstimatedALBNewConnectionCount EstimatedProcessedBytes HTTPCode_Backend_4XX HTTPCode_Backend_5XX HealthyHostCount Latency RequestCount SurgeQueueLength UnHealthyHostCount AWS/RDS ActiveTransactions AuroraBinlogReplicaLag AuroraReplicaLag BackupRetentionPeriodStorageUsed BinLogDiskUsage BlockedTransactions Supported logs and metrics User Guide 1265 Amazon CloudWatch CPUCreditBalance CommitLatency CommitThroughput DDLLatency DDLThroughput DMLLatency DMLThroughput DatabaseConnections Deadlocks DeleteLatency DeleteThroughput DiskQueueDepth EngineUptime FreeLocalStorage FreeStorageSpace FreeableMemory InsertLatency InsertThroughput LoginFailures NetworkReceiveThroughput NetworkThroughput NetworkTransmitThroughput Queries Supported logs and metrics User Guide 1266 User Guide Amazon CloudWatch ReadIOPS ReadThroughput SelectLatency SelectThroughput SnapshotStorageUsed TotalBackupStorageBilled UpdateLatency UpdateThroughput VolumeBytesUsed VolumeReadIOPs VolumeWriteIOPs WriteIOPS WriteThroughput AWS/Lambda Errors DeadLetterErrors Duration Throttles IteratorAge ProvisionedConcurrencySpilloverInvocations AWS/SQS ApproximateAgeOfOldestMessage ApproximateNumberOfMessagesDelayed Supported logs and metrics 1267 Amazon CloudWatch User Guide ApproximateNumberOfMessagesNotVisible ApproximateNumberOfMessagesVisible NumberOfEmptyReceives NumberOfMessagesDeleted NumberOfMessagesReceived NumberOfMessagesSent AWS/CWAgent LogicalDisk % Free Space Memory % Committed Bytes In Use Memory Available Mbytes Network Interface Bytes Total/sec Paging File % Usage PhysicalDisk % Disk Time PhysicalDisk Avg. Disk sec/Read PhysicalDisk Avg. Disk sec/Write PhysicalDisk Disk Read Bytes/sec PhysicalDisk Disk Reads/sec PhysicalDisk Disk Write Bytes/sec PhysicalDisk Disk Writes/sec Processor % Idle Time Processor % Interrupt Time Processor % Processor Time Processor % User Time Supported logs and metrics 1268 Amazon CloudWatch User Guide SQLServer:Access Methods Forwarded Records/sec SQLServer:Access Methods Page Splits/sec SQLServer:Buﬀer Manager Buﬀer cache hit ratio SQLServer:Buﬀer Manager Page life expectancy SQLServer:Database Replica File Bytes Received/sec SQLServer:Database Replica Log Bytes Received/sec SQLServer:Database Replica Log remaining for undo SQLServer:Database Replica Log Send Queue SQLServer:Database Replica Mirrored Write Transaction/sec SQLServer:Database Replica Recovery Queue SQLServer:Database Replica Redo Bytes Remaining SQLServer:Database Replica Redone Bytes/sec SQLServer:Database Replica Total Log requiring undo SQLServer:Database Replica Transaction Delay SQLServer:General Statistics Processes blocked SQLServer:SQL Statistics Batch Requests/sec SQLServer:SQL Statistics SQL Compilations/sec SQLServer:SQL Statistics SQL Re-Compilations/sec System Processor Queue Length
acw-ug-351	acw-ug.pdf	351	% User Time Supported logs and metrics 1268 Amazon CloudWatch User Guide SQLServer:Access Methods Forwarded Records/sec SQLServer:Access Methods Page Splits/sec SQLServer:Buﬀer Manager Buﬀer cache hit ratio SQLServer:Buﬀer Manager Page life expectancy SQLServer:Database Replica File Bytes Received/sec SQLServer:Database Replica Log Bytes Received/sec SQLServer:Database Replica Log remaining for undo SQLServer:Database Replica Log Send Queue SQLServer:Database Replica Mirrored Write Transaction/sec SQLServer:Database Replica Recovery Queue SQLServer:Database Replica Redo Bytes Remaining SQLServer:Database Replica Redone Bytes/sec SQLServer:Database Replica Total Log requiring undo SQLServer:Database Replica Transaction Delay SQLServer:General Statistics Processes blocked SQLServer:SQL Statistics Batch Requests/sec SQLServer:SQL Statistics SQL Compilations/sec SQLServer:SQL Statistics SQL Re-Compilations/sec System Processor Queue Length TCPv4 Connections Established TCPv6 Connections Established AWS/DynamoDB ConsumedReadCapacityUnits Supported logs and metrics 1269 User Guide Amazon CloudWatch ConsumedWriteCapacityUnits ReadThrottleEvents WriteThrottleEvents TimeToLiveDeletedItemCount ConditionalCheckFailedRequests TransactionConﬂict ReturnedRecordsCount PendingReplicationCount ReplicationLatency AWS/S3 ReplicationLatency BytesPendingReplication OperationsPendingReplication 4xxErrors 5xxErrors AllRequests GetRequests PutRequests DeleteRequests HeadRequests PostRequests SelectRequests Supported logs and metrics 1270 User Guide Amazon CloudWatch ListRequests SelectScannedBytes SelectReturnedBytes FirstByteLatency TotalRequestLatency BytesDownloaded BytesUploaded AWS/States ActivitiesScheduled ActivitiesStarted ActivitiesSucceeded ActivityScheduleTime ActivityRuntime ActivityTime LambdaFunctionsScheduled LambdaFunctionsStarted LambdaFunctionsSucceeded LambdaFunctionScheduleTime LambdaFunctionRuntime LambdaFunctionTime ServiceIntegrationsScheduled ServiceIntegrationsStarted ServiceIntegrationsSucceeded Supported logs and metrics 1271 User Guide Amazon CloudWatch ServiceIntegrationScheduleTime ServiceIntegrationRuntime ServiceIntegrationTime ProvisionedReﬁllRate ProvisionedBucketSize ConsumedCapacity ThrottledEvents AWS/ApiGateway 4XXError IntegrationLatency Latency DataProcessed CacheHitCount CacheMissCount AWS/SNS NumberOfNotiﬁcationsDelivered NumberOfMessagesPublished NumberOfNotiﬁcationsFailed NumberOfNotiﬁcationsFilteredOut NumberOfNotiﬁcationsFilteredOut-InvalidAttributes NumberOfNotiﬁcationsFilteredOut-NoMessageAttributes NumberOfNotiﬁcationsRedrivenToDlq NumberOfNotiﬁcationsFailedToRedriveToDlq Supported logs and metrics 1272 Amazon CloudWatch SMSSuccessRate Recommended metrics User Guide The following table lists the recommended metrics for each component type. Component type Workload type Recommended metric EC2 instance (Windows servers) Default/Custom CPUUtilization StatusCheckFailed Processor % Processor Time Memory % Committed Bytes In Use LogicalDisk % Free Space Memory Available Mbytes Active Directory CPUUtilization StatusCheckFailed Processor % Processor Time Memory % Committed Bytes In Use Memory Available Mbytes Database ==> Instances Database Cache % Hit DirectoryServices DRA Pending Replication Operations DirectoryServices DRA Pending Replication Synchronizations Supported logs and metrics 1273 Amazon CloudWatch User Guide Component type Workload type Recommended metric DNS Recursive Query Failure/ sec LogicalDisk Avg. Disk Queue Length Java Application CPUUtilization StatusCheckFailed Processor % Processor Time Memory % Committed Bytes In Use Memory Available Mbytes java_lang_threading_threadc ount java_lang_classloading_load edclasscount java_lang_memory_h eapmemoryusage_used java_lang_memory_h eapmemoryusage_committed java_lang_operatingsystem_f reephysicalmemorysize java_lang_operatingsystem_f reeswapspacesize Supported logs and metrics 1274 Amazon CloudWatch User Guide Component type Workload type Recommended metric Microsoft IIS/.NET Web Front- End CPUUtilization StatusCheckFailed Processor % Processor Time Memory % Committed Bytes In Use Memory Available Mbytes .NET CLR Exceptions # of Exceps Thrown/Sec .NET CLR Memory # Total Committed Bytes .NET CLR Memory % Time in GC ASP.NET Applications Requests in Application Queue ASP.NET Requests Queued ASP.NET Application Restarts Supported logs and metrics 1275 Amazon CloudWatch User Guide Component type Workload type Recommended metric Microsoft SQL Server Database Tier CPUUtilization StatusCheckFailed Processor % Processor Time Memory % Committed Bytes In Use Memory Available Mbytes Paging File % Usage System Processor Queue Length Network Interface Bytes Total/Sec PhysicalDisk % Disk Time SQLServer:Buﬀer Manager Buﬀer Cache Hit ratio SQLServer:Buﬀer Manager Page Life Expectancy SQLServer:General Statistics Processes Blocked SQLServer:General Statistics User Connections SQLServer:Locks Number of Deadlocks/Sec SQLServer:SQL Statistics Batch Requests/Sec Supported logs and metrics 1276 Amazon CloudWatch User Guide Component type Workload type Recommended metric MySQL CPUUtilization StatusCheckFailed Processor % Processor Time Memory % Committed Bytes In Use LogicalDisk % Free Space Memory Available Mbytes .NET workerpool/Mid-Tier CPUUtilization StatusCheckFailed Processor % Processor Time Memory % Committed Bytes In Use Memory Available Mbytes .NET CLR Exceptions # of Exceps Thrown/Sec .NET CLR Memory # Total Committed Bytes .NET CLR Memory % Time in GC Supported logs and metrics 1277 Amazon CloudWatch User Guide Component type Workload type Recommended metric .NET Core Tier CPUUtilization StatusCheckFailed Processor % Processor Time Memory % Committed Bytes In Use Memory Available Mbytes Oracle CPUUtilization StatusCheckFailed Processor % Processor Time Memory % Committed Bytes In Use LogicalDisk % Free Space Memory Available Mbytes Postgres CPUUtilization StatusCheckFailed Processor % Processor Time Memory % Committed Bytes In Use LogicalDisk % Free Space Memory Available Mbytes Supported logs and metrics 1278 Amazon CloudWatch User Guide Component type Workload type Recommended metric SharePoint CPUUtilization StatusCheckFailed Processor % Processor Time Memory % Committed Bytes In Use Memory Available Mbytes ASP.NET Applications Cache API trims ASP.NET Requests Rejected ASP.NET Worker Process Restarts Memory Pages/sec SharePoint Publishing Cache Publishing cache ﬂushes / second SharePoint Foundation Executing Time/Page Request SharePoint Disk-Based Cache Total number of cache compactions SharePoint Disk-Based Cache Blob cache hit ratio SharePoint Disk-Based Cache Blob Cache ﬁll ratio Supported logs and metrics 1279 Amazon CloudWatch User Guide Component type Workload type Recommended metric SharePoint Disk-Based Cache Blob cache ﬂushes / second ASP.NET Requests Queued ASP.NET Applications Requests in Application Queue ASP.NET Application Restarts LogicalDisk Avg. Disk sec/ Write LogicalDisk Avg. Disk sec/ Read Processor % Interrupt Time EC2 instance (Linux servers) Default/Custom CPUUtilization StatusCheckFailed disk_used_percent mem_used_percent Supported logs and metrics 1280 Amazon CloudWatch User Guide Component type Workload type Recommended metric Java Application CPUUtilization StatusCheckFailed disk_used_percent mem_used_percent java_lang_threading_threadc ount java_lang_classloading_load edclasscount java_lang_memory_h
acw-ug-352	acw-ug.pdf	352	cache compactions SharePoint Disk-Based Cache Blob cache hit ratio SharePoint Disk-Based Cache Blob Cache ﬁll ratio Supported logs and metrics 1279 Amazon CloudWatch User Guide Component type Workload type Recommended metric SharePoint Disk-Based Cache Blob cache ﬂushes / second ASP.NET Requests Queued ASP.NET Applications Requests in Application Queue ASP.NET Application Restarts LogicalDisk Avg. Disk sec/ Write LogicalDisk Avg. Disk sec/ Read Processor % Interrupt Time EC2 instance (Linux servers) Default/Custom CPUUtilization StatusCheckFailed disk_used_percent mem_used_percent Supported logs and metrics 1280 Amazon CloudWatch User Guide Component type Workload type Recommended metric Java Application CPUUtilization StatusCheckFailed disk_used_percent mem_used_percent java_lang_threading_threadc ount java_lang_classloading_load edclasscount java_lang_memory_h eapmemoryusage_used java_lang_memory_h eapmemoryusage_committed java_lang_operatingsystem_f reephysicalmemorysize java_lang_operatingsystem_f reeswapspacesize CPUUtilization StatusCheckFailed disk_used_percent mem_used_percent .NET Core Tier or SQL Server Database Tier Supported logs and metrics 1281 Amazon CloudWatch User Guide Component type Workload type Recommended metric Oracle CPUUtilization StatusCheckFailed disk_used_percent mem_used_percent Postgres CPUUtilization StatusCheckFailed disk_used_percent mem_used_percent Supported logs and metrics 1282 Amazon CloudWatch User Guide Component type Workload type Recommended metric EC2 instance group SAP HANA multi-node or single node • hanadb_server_star tup_time_variation s_seconds • hanadb_level_5_ale rts_count • hanadb_level_4_ale rts_count • hanadb_out_of_memo ry_events_count • hanadb_max_trigger _read_ratio_percent • hanadb_max_trigger _write_ratio_percent • hanadb_log_switch_ race_ratio_percent • hanadb_time_since_ last_savepoint_seconds • hanadb_disk_usage_ highlevel_percent • hanadb_current_all ocation_limit_used_percent • hanadb_table_alloc ation_limit_used_percent • hanadb_cpu_usage_percent • hanadb_plan_cache_ hit_ratio_percent • hanadb_last_data_b ackup_age_days Supported logs and metrics 1283 Amazon CloudWatch User Guide Component type Workload type Recommended metric EBS volume Any VolumeReadBytes VolumeWriteBytes VolumeReadOps VolumeWriteOps VolumeQueueLength VolumeThroughputPe rcentage VolumeConsumedRead WriteOps BurstBalance Classic ELB Any HTTPCode_Backend_4XX Application ELB Any HTTPCode_Backend_5XX Latency SurgeQueueLength UnHealthyHostCount HTTPCode_Target_4X X_Count HTTPCode_Target_5X X_Count TargetResponseTime UnHealthyHostCount Supported logs and metrics 1284 Amazon CloudWatch User Guide Component type Workload type Recommended metric RDS Database instance Any CPUUtilization RDS Database cluster Any Lambda Function Any ReadLatency WriteLatency BurstBalance FailedSQLServerAge ntJobsCount CPUUtilization CommitLatency DatabaseConnections Deadlocks FreeableMemory NetworkThroughput VolumeBytesUsed Duration Errors IteratorAge ProvisionedConcurrencySpill overInvocations Throttles Supported logs and metrics 1285 Amazon CloudWatch User Guide Component type Workload type Recommended metric SQS Queue Any Amazon DynamoDB table Any ApproximateAgeOfOl destMessage ApproximateNumberO fMessagesVisible NumberOfMessagesSent SystemErrors UserErrors ConsumedReadCapacityUnits ConsumedWriteCapacityUnits ReadThrottleEvents WriteThrottleEvents ConditionalCheckFailedReque sts TransactionConﬂict Supported logs and metrics 1286 Amazon CloudWatch User Guide Component type Workload type Recommended metric Amazon S3 bucket Any If replication conﬁguration with Replication Time Control (RTC) is enabled: ReplicationLatency BytesPendingReplication OperationsPendingReplicatio n If request metrics are turned on: 5xxErrors 4xxErrors BytesDownloaded BytesUploaded Supported logs and metrics 1287 Amazon CloudWatch User Guide Component type Workload type Recommended metric AWS Step Functions Any General • ExecutionThrottled • ExecutionsAborted • ProvisionedBucketSize • ProvisionedReﬁllRate • ConsumedCapacity If state machine type is EXPRESS or log group level is OFF • ExecutionsFailed • ExecutionsTimedOut If state machine has Lambda functions • LambdaFunctionsFailed • LambdaFunctionsTimedOut If state machine has activitie s • ActivitiesFailed • ActivitiesTimedOut • ActivitiesHeartbea tTimedOut If state machine has service integrations • ServiceIntegrationsFailed Supported logs and metrics 1288 Amazon CloudWatch User Guide Component type Workload type Recommended metric API Gateway REST API stage Any • ServiceIntegration sTimedOut • 4XXErrors • 5XXErrors • Latency Supported logs and metrics 1289 Amazon CloudWatch User Guide Component type Workload type Recommended metric ECS Cluster Any CpuUtilized MemoryUtilized NetworkRxBytes NetworkTxBytes RunningTaskCount PendingTaskCount StorageReadBytes StorageWriteBytes CPUReservation (EC2 Launch Type only) CPUUtilization (EC2 Launch Type only) MemoryReservation (EC2 Launch Type only) MemoryUtilization (EC2 Launch Type only) GPUReservation (EC2 Launch Type only) instance_cpu_utilization (EC2 Launch Type only) instance_ﬁlesystem_utiliza tion (EC2 Launch Type only) instance_memory_utilization (EC2 Launch Type only) Supported logs and metrics 1290 Amazon CloudWatch User Guide Component type Workload type Recommended metric instance_network_total_bytes (EC2 Launch Type only) Supported logs and metrics 1291 Amazon CloudWatch User Guide Component type Workload type Recommended metric Java Application CpuUtilized MemoryUtilized NetworkRxBytes NetworkTxBytes RunningTaskCount PendingTaskCount StorageReadBytes StorageWriteBytes CPUReservation (EC2 Launch Type only) CPUUtilization (EC2 Launch Type only) MemoryReservation (EC2 Launch Type only) MemoryUtilization (EC2 Launch Type only) GPUReservation (EC2 Launch Type only) instance_cpu_utilization (EC2 Launch Type only) instance_ﬁlesystem_utiliza tion (EC2 Launch Type only) instance_memory_utilization (EC2 Launch Type only) Supported logs and metrics 1292 Amazon CloudWatch User Guide Component type Workload type Recommended metric instance_network_total_bytes (EC2 Launch Type only) java_lang_threading_threadc ount java_lang_classloading_load edclasscount java_lang_memory_h eapmemoryusage_used java_lang_memory_h eapmemoryusage_committed java_lang_operatingsystem_f reephysicalmemorysize java_lang_operatingsystem_f reeswapspacesize ECS Service Any CPUUtilization MemoryUtilization CpuUtilized MemoryUtilized NetworkRxBytes NetworkTxBytes RunningTaskCount PendingTaskCount StorageReadBytes StorageWriteBytes Supported logs and metrics 1293 Amazon CloudWatch User Guide Component type Workload type Recommended metric Java Application CPUUtilization MemoryUtilization CpuUtilized MemoryUtilized NetworkRxBytes NetworkTxBytes RunningTaskCount PendingTaskCount StorageReadBytes StorageWriteBytes java_lang_threading_threadc ount java_lang_classloading_load edclasscount java_lang_memory_h eapmemoryusage_used java_lang_memory_h eapmemoryusage_committed java_lang_operatingsystem_f reephysicalmemorysize java_lang_operatingsystem_f reeswapspacesize Supported logs and metrics 1294 Amazon CloudWatch User Guide Component type Workload type Recommended metric EKS Cluster Any cluster_failed_node_count node_cpu_reserved_capacity node_cpu_utilization node_ﬁlesystem_utilization node_memory_reserv ed_capacity node_memory_utilization node_network_total_bytes pod_cpu_reserved_capacity pod_cpu_utilization pod_cpu_utilization_over_po d_limit pod_memory_reserve d_capacity pod_memory_utilization pod_memory_utilization_over _pod_limit pod_network_rx_bytes pod_network_tx_bytes Supported logs and metrics 1295 Amazon CloudWatch User Guide Component type Workload type Recommended metric Java Application cluster_failed_node_count node_cpu_reserved_capacity node_cpu_utilization node_ﬁlesystem_utilization node_memory_reserv ed_capacity node_memory_utilization node_network_total_bytes pod_cpu_reserved_capacity pod_cpu_utilization pod_cpu_utilization_over_po d_limit pod_memory_reserve d_capacity pod_memory_utilization pod_memory_utilization_over _pod_limit pod_network_rx_bytes pod_network_tx_bytes java_lang_threading_threadc ount java_lang_classloading_load edclasscount
acw-ug-353	acw-ug.pdf	353	Application CPUUtilization MemoryUtilization CpuUtilized MemoryUtilized NetworkRxBytes NetworkTxBytes RunningTaskCount PendingTaskCount StorageReadBytes StorageWriteBytes java_lang_threading_threadc ount java_lang_classloading_load edclasscount java_lang_memory_h eapmemoryusage_used java_lang_memory_h eapmemoryusage_committed java_lang_operatingsystem_f reephysicalmemorysize java_lang_operatingsystem_f reeswapspacesize Supported logs and metrics 1294 Amazon CloudWatch User Guide Component type Workload type Recommended metric EKS Cluster Any cluster_failed_node_count node_cpu_reserved_capacity node_cpu_utilization node_ﬁlesystem_utilization node_memory_reserv ed_capacity node_memory_utilization node_network_total_bytes pod_cpu_reserved_capacity pod_cpu_utilization pod_cpu_utilization_over_po d_limit pod_memory_reserve d_capacity pod_memory_utilization pod_memory_utilization_over _pod_limit pod_network_rx_bytes pod_network_tx_bytes Supported logs and metrics 1295 Amazon CloudWatch User Guide Component type Workload type Recommended metric Java Application cluster_failed_node_count node_cpu_reserved_capacity node_cpu_utilization node_ﬁlesystem_utilization node_memory_reserv ed_capacity node_memory_utilization node_network_total_bytes pod_cpu_reserved_capacity pod_cpu_utilization pod_cpu_utilization_over_po d_limit pod_memory_reserve d_capacity pod_memory_utilization pod_memory_utilization_over _pod_limit pod_network_rx_bytes pod_network_tx_bytes java_lang_threading_threadc ount java_lang_classloading_load edclasscount Supported logs and metrics 1296 Amazon CloudWatch User Guide Component type Workload type Recommended metric java_lang_memory_h eapmemoryusage_used java_lang_memory_h eapmemoryusage_committed java_lang_operatingsystem_f reephysicalmemorysize java_lang_operatingsystem_f reeswapspacesize Supported logs and metrics 1297 Amazon CloudWatch User Guide Component type Workload type Recommended metric Kubernetes Cluster on EC2 Any cluster_failed_node_count node_cpu_reserved_capacity node_cpu_utilization node_ﬁlesystem_utilization node_memory_reserv ed_capacity node_memory_utilization node_network_total_bytes pod_cpu_reserved_capacity pod_cpu_utilization pod_cpu_utilization_over_po d_limit pod_memory_reserve d_capacity pod_memory_utilization pod_memory_utilization_over _pod_limit pod_network_rx_bytes pod_network_tx_bytes Supported logs and metrics 1298 Amazon CloudWatch User Guide Component type Workload type Recommended metric Java Application cluster_failed_node_count node_cpu_reserved_capacity node_cpu_utilization node_ﬁlesystem_utilization node_memory_reserv ed_capacity node_memory_utilization node_network_total_bytes pod_cpu_reserved_capacity pod_cpu_utilization pod_cpu_utilization_over_po d_limit pod_memory_reserve d_capacity pod_memory_utilization pod_memory_utilization_over _pod_limit pod_network_rx_bytes pod_network_tx_bytes java_lang_threading_threadc ount java_lang_classloading_load edclasscount Supported logs and metrics 1299 Amazon CloudWatch User Guide Component type Workload type Recommended metric java_lang_memory_h eapmemoryusage_used java_lang_memory_h eapmemoryusage_committed java_lang_operatingsystem_f reephysicalmemorysize java_lang_operatingsystem_f reeswapspacesize The following table lists the recommended processes and process metrics for each component type. CloudWatch Application Insights does not recommend process monitoring for processes that do not run on an instance. Component type Workload type Recommended process Recommended metric EC2 instance (Windows servers) Microsoft IIS/.NET Web Front-End w3wp Microsoft SQL Server Database Tier SQLAgent procstat cpu_usage , procstat memory_rss , procstat memory_vms , procstat read_bytes , procstat write_bytes procstat cpu_usage , Supported logs and metrics 1300 Amazon CloudWatch User Guide Component type Workload type Recommended process sqlservr sqlwriter Recommended metric procstat memory_rss , procstat memory_vms , procstat read_bytes , procstat write_bytes procstat cpu_usage , procstat memory_rss , procstat memory_vms , procstat read_bytes , procstat write_bytes procstat cpu_usage , procstat memory_rss Supported logs and metrics 1301 Amazon CloudWatch User Guide Component type Workload type Recommended process Recommended metric Reporting ServicesS ervice MsDtsServr Msmdsrv procstat cpu_usage , procstat memory_rss procstat cpu_usage , procstat memory_rss , procstat memory_vms , procstat read_bytes , procstat write_bytes procstat cpu_usage , procstat memory_rss , procstat memory_vms , procstat read_bytes , procstat write_bytes Supported logs and metrics 1302 Amazon CloudWatch User Guide Component type Workload type Recommended process Recommended metric .NET workerpool/ Mid-Tier w3wp .NET Core Tier w3wp procstat cpu_usage , procstat memory_rss , procstat memory_vms , procstat read_bytes , procstat write_bytes procstat cpu_usage , procstat memory_rss , procstat memory_vms , procstat read_bytes , procstat write_bytes Performance Counter metrics Performance Counter metrics are recommended for instances only when the corresponding Performance Counter sets are installed on the Windows instances. Supported logs and metrics 1303 Amazon CloudWatch User Guide Performance Counter metric name Performance Counter set name .NET CLR Exceptions # of Exceps Thrown .NET CLR Exceptions .NET CLR Exceptions # of Exceps Thrown/Sec .NET CLR Exceptions .NET CLR Exceptions # of Filters/Sec .NET CLR Exceptions .NET CLR Exceptions # of Finallys/Sec .NET CLR Exceptions .NET CLR Exceptions Throw to Catch Depth/ Sec .NET CLR Exceptions .NET CLR Interop # of CCWs .NET CLR Interop .NET CLR Interop # of Stubs .NET CLR Interop .NET CLR Interop # of TLB exports/Sec .NET CLR Interop .NET CLR Interop # of TLB imports/Sec .NET CLR Interop .NET CLR Interop # of Marshaling .NET CLR Interop .NET CLR Jit % Time in Jit .NET CLR Jit .NET CLR Jit Standard Jit Failures .NET CLR Jit .NET CLR Loading % Time Loading .NET CLR Loading .NET CLR Loading Rate of Load Failures .NET CLR Loading .NET CLR LocksAndThreads Contention Rate/ Sec .NET CLR LocksAndThreads .NET CLR LocksAndThreads Queue Length/Sec .NET CLR LocksAndThreads .NET CLR Memory # Total Committed Bytes .NET CLR Memory .NET CLR Memory % Time in GC .NET CLR Memory Supported logs and metrics 1304 Amazon CloudWatch User Guide Performance Counter metric name Performance Counter set name .NET CLR Networking 4.0.0.0 HttpWebRequest Average Queue Time .NET CLR Networking 4.0.0.0 .NET CLR Networking 4.0.0.0 HttpWebRe quests Aborted/Sec .NET CLR Networking 4.0.0.0 .NET CLR Networking 4.0.0.0 HttpWebRe quests Failed/Sec .NET CLR Networking 4.0.0.0 .NET CLR Networking 4.0.0.0 HttpWebRe quests Queued/Sec .NET CLR Networking 4.0.0.0 APP_POOL_WAS Total Worker Process Ping Failures APP_POOL_WAS ASP.NET Application Restarts ASP.NET Requests Rejected ASP.NET Worker Process Restarts ASP.NET ASP.NET ASP.NET ASP.NET Applications Cache API trims ASP.NET Applications ASP.NET Applications % Managed Processor Time (estimated) ASP.NET Applications ASP.NET Applications Errors Total/Sec ASP.NET Applications ASP.NET Applications Errors Unhandled During Execution/Sec ASP.NET Applications ASP.NET Applications Requests in Application Queue ASP.NET Applications ASP.NET Applications Requests/Sec ASP.NET Applications ASP.NET Request Wait Time ASP.NET Requests Queued ASP.NET ASP.NET Supported logs
acw-ug-354	acw-ug.pdf	354	.NET CLR Networking 4.0.0.0 .NET CLR Networking 4.0.0.0 HttpWebRe quests Failed/Sec .NET CLR Networking 4.0.0.0 .NET CLR Networking 4.0.0.0 HttpWebRe quests Queued/Sec .NET CLR Networking 4.0.0.0 APP_POOL_WAS Total Worker Process Ping Failures APP_POOL_WAS ASP.NET Application Restarts ASP.NET Requests Rejected ASP.NET Worker Process Restarts ASP.NET ASP.NET ASP.NET ASP.NET Applications Cache API trims ASP.NET Applications ASP.NET Applications % Managed Processor Time (estimated) ASP.NET Applications ASP.NET Applications Errors Total/Sec ASP.NET Applications ASP.NET Applications Errors Unhandled During Execution/Sec ASP.NET Applications ASP.NET Applications Requests in Application Queue ASP.NET Applications ASP.NET Applications Requests/Sec ASP.NET Applications ASP.NET Request Wait Time ASP.NET Requests Queued ASP.NET ASP.NET Supported logs and metrics 1305 Amazon CloudWatch User Guide Performance Counter metric name Performance Counter set name Database ==> Instances Database Cache % Hit Database ==> Instances Database ==> Instances I/O Database Reads Average Latency Database ==> Instances Database ==> Instances I/O Database Reads/ sec Database ==> Instances Database ==> Instances I/O Log Writes Average Latency Database ==> Instances DirectoryServices DRA Pending Replication Operations DirectoryServices DirectoryServices DRA Pending Replication Synchronizations DirectoryServices DirectoryServices LDAP Bind Time DirectoryServices DNS Recursive Queries/sec DNS Recursive Query Failure/sec DNS TCP Query Received/sec DNS Total Query Received/sec DNS Total Response Sent/sec DNS UDP Query Received/sec DNS DNS DNS DNS DNS DNS HTTP Service Request Queues CurrentQu eueSize HTTP Service Request Queues LogicalDisk % Free Space LogicalDisk Avg. Disk sec/Write LogicalDisk Avg. Disk sec/Read LogicalDisk LogicalDisk LogicalDisk Supported logs and metrics 1306 Amazon CloudWatch User Guide Performance Counter metric name Performance Counter set name LogicalDisk Avg. Disk Queue Length LogicalDisk Memory % Committed Bytes In Use Memory Available Mbytes Memory Pages/Sec Memory Long-Term Average Standby Cache Lifetime (s) Memory Memory Memory Memory Network Interface Bytes Total/Sec Network Interface Network Interface Bytes Received/sec Network Interface Network Interface Bytes Sent/sec Network Interface Network Interface Current Bandwidth Network Interface Paging File % Usage PhysicalDisk % Disk Time Paging File PhysicalDisk PhysicalDisk Avg. Disk Queue Length PhysicalDisk PhysicalDisk Avg. Disk Sec/Read PhysicalDisk PhysicalDisk Avg. Disk Sec/Write PhysicalDisk PhysicalDisk Disk Read Bytes/Sec PhysicalDisk PhysicalDisk Disk Reads/Sec PhysicalDisk PhysicalDisk Disk Write Bytes/Sec PhysicalDisk PhysicalDisk Disk Writes/Sec PhysicalDisk Processor % Idle Time Processor % Interrupt Time Processor Processor Supported logs and metrics 1307 Amazon CloudWatch User Guide Performance Counter metric name Performance Counter set name Processor % Processor Time Processor % User Time Processor Processor SharePoint Disk-Based Cache Blob Cache ﬁll ratio SharePoint Disk-Based Cache SharePoint Disk-Based Cache Blob cache ﬂushes / second SharePoint Disk-Based Cache SharePoint Disk-Based Cache Blob cache hit ratio SharePoint Disk-Based Cache SharePoint Disk-Based Cache Total number of cache compactions SharePoint Disk-Based Cache SharePoint Foundation Executing Time/Page Request SharePoint Foundation SharePoint Publishing Cache Publishing cache ﬂushes / second SharePoint Publishing Cache Security System-Wide Statistics Kerberos Authentications Security System-Wide Statistics Security System-Wide Statistics NTLM Authentications SQLServer:Access Methods Forwarded Records/Sec Security System-Wide Statistics SQLServer:Access Methods SQLServer:Access Methods Full Scans/Sec SQLServer:Access Methods SQLServer:Access Methods Page Splits/Sec SQLServer:Access Methods SQLServer:Buﬀer Manager Buﬀer cache hit Ratio SQLServer:Buﬀer Manager Supported logs and metrics 1308 Amazon CloudWatch User Guide Performance Counter metric name Performance Counter set name SQLServer:Buﬀer Manager Page life Expectanc y SQLServer:Buﬀer Manager SQLServer:Database Replica File Bytes Received/sec SQLServer:Database Replica Log Bytes Received/sec SQLServer:Database Replica SQLServer:Database Replica SQLServer:Database Replica Log remaining for undo SQLServer:Database Replica SQLServer:Database Replica Log Send Queue SQLServer:Database Replica SQLServer:Database Replica Mirrored Write Transaction/sec SQLServer:Database Replica SQLServer:Database Replica Recovery Queue SQLServer:Database Replica SQLServer:Database Replica Redo Bytes Remaining SQLServer:Database Replica SQLServer:Database Replica Redone Bytes/sec SQLServer:Database Replica SQLServer:Database Replica Total Log requiring undo SQLServer:Database Replica SQLServer:Database Replica Transaction Delay SQLServer:Database Replica SQLServer:General Statistics Processes Blocked SQLServer:General Statistics SQLServer:General Statistics User Connections SQLServer:General Statistics SQLServer:Latches Average Latch Wait Time (ms) SQLServer:Latches SQLServer:Locks Average Wait Time (ms) SQLServer:Locks Supported logs and metrics 1309 Amazon CloudWatch User Guide Performance Counter metric name Performance Counter set name SQLServer:Locks Lock Timeouts/Sec SQLServer:Locks SQLServer:Locks Lock Waits/Sec SQLServer:Locks SQLServer:Locks Number of Deadlocks/Sec SQLServer:Locks SQLServer:Memory Manager Memory Grants Pending SQLServer:Memory Manager SQLServer:SQL Statistics Batch Requests/Sec SQLServer:SQL Statistics SQLServer:SQL Statistics SQL Compilations/ Sec SQLServer:SQL Statistics SQLServer:SQL Statistics SQL Re-Compil ations/Sec SQLServer:SQL Statistics System Processor Queue Length TCPv4 Connections Established TCPv6 Connections Established System TCPv4 TCPv6 W3SVC_W3WP File Cache Flushes W3SVC_W3WP W3SVC_W3WP File Cache Misses W3SVC_W3WP W3SVC_W3WP Requests/Sec W3SVC_W3WP W3SVC_W3WP URI Cache Flushes W3SVC_W3WP W3SVC_W3WP URI Cache Misses W3SVC_W3WP Web Service Bytes Received/Sec Web Service Web Service Bytes Sent/Sec Web Service Web Service Connection Attempts/Sec Web Service Web Service Current Connections Web Service Supported logs and metrics 1310 Amazon CloudWatch User Guide Performance Counter metric name Performance Counter set name Web Service Get Requests/Sec Web Service Web Service Post Requests/Sec Web Service Using the resource health view in the CloudWatch console You can use the resource health view to automatically discover, manage, and visualize the health and performance of hosts across their applications in a single view. You can visualize the health of their hosts by a performance dimension such as CPU or memory, and slice
acw-ug-355	acw-ug.pdf	355	Service Bytes Sent/Sec Web Service Web Service Connection Attempts/Sec Web Service Web Service Current Connections Web Service Supported logs and metrics 1310 Amazon CloudWatch User Guide Performance Counter metric name Performance Counter set name Web Service Get Requests/Sec Web Service Web Service Post Requests/Sec Web Service Using the resource health view in the CloudWatch console You can use the resource health view to automatically discover, manage, and visualize the health and performance of hosts across their applications in a single view. You can visualize the health of their hosts by a performance dimension such as CPU or memory, and slice and dice hundreds of hosts in a single view using ﬁlters. You can ﬁlter by tags or by use cases, such as hosts in the same Auto Scaling group or hosts that use the same load balancer, Prerequisites To make sure that you get the full beneﬁt of the resource health view, check that you have the following prerequisites. • To see the memory utilization of your hosts and use it as a ﬁlter, you must install the CloudWatch agent on your hosts and set it up to send a memory metric to CloudWatch in the default CWAgent namespace. On Linux and macOS instances, the CloudWatch agent must send the mem_used_percent metric. On Windows instances, the agent must send the Memory % Committed Bytes In Use metric. These metrics are included if you use the wizard to create the CloudWatch agent conﬁguration ﬁle and select any of the pre-deﬁned sets of metrics. Metrics collected by the CloudWatch agent are billed as custom metrics. For more information, see Install the CloudWatch agent. When you use the CloudWatch agent to collect these memory metrics to use with the resource health view, you must include the following section in the CloudWatch agent conﬁguration ﬁle. This section contains the default dimension settings and is created by default, so do not change any part of this section to anything diﬀerent than what is shown in the following example. "append_dimensions": { "ImageId": "${aws:ImageId}", "InstanceId": "${aws:InstanceId}", "InstanceType": "${aws:InstanceType}", "AutoScalingGroupName": "${aws:AutoScalingGroupName}" Using the resource health view 1311 Amazon CloudWatch }, User Guide • To view all the information available in the resource health view, you must be signed in to an account that has the following permissions. If you are signed on with fewer permissions, you can still use the resource health view but some performance data will not be visible. { "Version": "2012-10-17", "Statement": [ { "Action": [ "autoscaling:Describe", "cloudwatch:Describe", "cloudwatch:Describe", "cloudwatch:Get", "cloudwatch:List", "logs:Get", "logs:Describe", "sns:Get", "sns:List", "ec2:DescribeInstances", "ec2:DescribeInstanceStatus", "ec2:DescribeRegions" ], "Effect": "Allow", "Resource": "" } ] } To view resource health in your account 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. In the navigation pane, choose Insights, EC2 Resource Health. The resource health page appears, showing a square for each host in your account. Each square is colored based on the current status of that host, based on the setting for Color by. Host squares with an alarm symbol have one or more alarms currently in ALARM state. You can see up to 500 hosts in a single view. If you have more hosts in your account, use the ﬁlter settings in step 6 of this procedure. Prerequisites 1312 Amazon CloudWatch User Guide 3. To change what criteria is used to show each host's health, choose a setting for Color by. You can choose CPU Utilization, Memory Utilization, or Status check. Memory utilization metrics are available only for hosts that are running the CloudWatch agent and have it conﬁgured to collect memory metrics and send them to the default CWAgent namespace. For more information, see Collect metrics, logs, and traces with the CloudWatch agent. 4. To change the thresholds and the colors that are used for the health indicators in the grid, choose the gear icon above the grid. 5. 6. 7. 8. 9. To toggle whether to show alarms in the host grid, choose or clear Show alarms across all metrics. To split the hosts in the map into groups, choose a grouping criteria for Group by. To narrow the view to fewer hosts, choose a ﬁlter criteria for Filter by. You can ﬁlter by tags and by resource groupings such as Auto Scaling group, instance type, security group, and more. To sort hosts, choose a sorting criteria for Sort by. You can sort by status check results, instance state, CPU or memory utilization, and the number of alarms that are in ALARM state. To see more information about a host, choose the square that represents that host. A popup pane appears. To then dive deeper into information about that host, choose View dashboard or View on list. Prerequisites 1313 Amazon CloudWatch User Guide Application performance monitoring (APM) CloudWatch Application Signals provides application performance monitoring (APM) features such as pre-built, standardized dashboards for critical
acw-ug-356	acw-ug.pdf	356	group, instance type, security group, and more. To sort hosts, choose a sorting criteria for Sort by. You can sort by status check results, instance state, CPU or memory utilization, and the number of alarms that are in ALARM state. To see more information about a host, choose the square that represents that host. A popup pane appears. To then dive deeper into information about that host, choose View dashboard or View on list. Prerequisites 1313 Amazon CloudWatch User Guide Application performance monitoring (APM) CloudWatch Application Signals provides application performance monitoring (APM) features such as pre-built, standardized dashboards for critical application metrics, correlated trace spans, and a service map to enable you to visualize interactions between applications and their dependencies. You can also search and analyze transaction spans and trace summaries to debug distributed application issues in a business context, for cases such as troubleshooting customer support tickets or ﬁnding top impacted customers. You can also create Service Level Objectives (SLOs) to closely track the performance KPIs of critical operations in your application, enabling you to easily identify and triage operations that do not meet your business KPIs. See the following sections for an overview of these troubleshooting capabilities: • Monitor the operational health of your applications with Application Signals • Searching and analyzing spans Start collecting application metrics and traces Get the most integrated application performance monitoring experience by auto-instrumenting applications to easily collect telemetry, whether they are running in Amazon EKS clusters, Amazon EC2, Amazon ECS, Kubernetes, Lambda, or on-premise. Optionally, you can also use OpenTelemetry with Application Signals to collect telemetry. Note You must enable transaction search to get all APM features along with a new uniﬁed pricing for CloudWatch Application Signals, inclusive of X-Ray traces and application transaction spans. For more information about pricing, see Amazon CloudWatch Pricing. Topics • Application Signals • Service level objectives (SLOs) • Transaction Search • Synthetic monitoring (canaries) • CloudWatch RUM 1314 Amazon CloudWatch User Guide • Perform launches and A/B experiments with CloudWatch Evidently Application Signals Use CloudWatch Application Signals to automatically instrument your applications on AWS so that you can monitor current application health and track long-term application performance against your business objectives. Application Signals provides you with a uniﬁed, application-centric view of your applications, services, and dependencies, and helps you monitor and triage application health. • Enable Application Signals to automatically collect metrics and traces from your applications, and display key metrics such as call volume, availability, latency, faults, and errors. Quickly see and triage current operational health, and whether your applications are meeting their longer- term performance goals, without writing custom code or creating dashboards. • Create and monitor service-level objectives (SLOs) with Application Signals. Easily create and track status of SLOs related to CloudWatch metrics, including the new standard application metrics that Application Signals collects. See and track the service level indicator (SLI) status of your application services within a services list and topology map. Create alarms to track your SLOs, and track the new standard application metrics that Application Signals collects. • 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. • Application Signals works with CloudWatch RUM, CloudWatch Synthetics canaries, AWS Service Catalog AppRegistry, and Amazon EC2 Auto Scaling to display your client pages, Synthetics canaries, and application names within dashboards and maps. Topics • Permissions required for Application Signals • Supported systems • Supported instrumentation setups • Enable Application Signals in your account • (Optional) Try out Application Signals with a sample app • Enable your applications on Amazon EKS clusters • Enable your applications on Amazon EC2 • Enable your applications on Amazon ECS Application Signals 1315 Amazon CloudWatch User Guide • Enable your applications on Kubernetes • Enable your applications on Lambda • Troubleshooting your Application Signals installation • (Optional) Conﬁguring Application Signals • Monitor the operational health of your applications with Application Signals • Metrics collected by Application Signals Use Application Signals for daily application monitoring Use Application Signals within the CloudWatch console, as part of daily application monitoring: 1. If you have created service level objectives (SLOs) for your services, start with the Service Level Objectives (SLO) page. This gives you an immediate view of the health of your most critical services, operations, and dependencies. Choose the service, operation, or dependency name for an SLO to open the Service detail page and see detailed service information as you troubleshoot issues. 2. Open the Services page to see a summary of all your services, and quickly see services with the highest fault rate or latency. If you have created SLOs, look at the Services table to see which services have unhealthy service level indicators (SLIs). If a particular service is in an unhealthy
acw-ug-357	acw-ug.pdf	357	the Service Level Objectives (SLO) page. This gives you an immediate view of the health of your most critical services, operations, and dependencies. Choose the service, operation, or dependency name for an SLO to open the Service detail page and see detailed service information as you troubleshoot issues. 2. Open the Services page to see a summary of all your services, and quickly see services with the highest fault rate or latency. If you have created SLOs, look at the Services table to see which services have unhealthy service level indicators (SLIs). If a particular service is in an unhealthy state, select the service to open the Service detail page and see service operations, dependencies, Synthetics canaries, and client requests. Select a point in a graph to see correlated traces so that you can troubleshoot and identify the root cause of operational issues. 3. If new services have been deployed or dependencies have changed, open the Service Map to inspect your application topology. See a map of your applications that shows the relationship between clients, Synthetics canaries, services, and dependencies. Quickly see SLI health, view key metrics such as call volume, fault rate, and latency, and drill down to see more detailed information in the Service detail page. Using Application Signals incurs charges. For information about CloudWatch pricing, see Amazon CloudWatch Pricing. Application Signals 1316 Amazon CloudWatch Note User Guide It is not necessary to enable Application Signals to use CloudWatch Synthetics, CloudWatch RUM, or CloudWatch Evidently. However, Synthetics and CloudWatch RUM work with Application Signals to provide beneﬁts when you use these features together. Application Signals cross-account With Application Signals cross-account observability, you can monitor and troubleshoot your applications that span multiple AWS accounts within a single Region. You can use Amazon CloudWatch Observability Access Manager to set up one or more of your AWS accounts as a monitoring account. You’ll provide the monitoring account with the ability to view data in your source account by creating a sink in your monitoring account. You use the sink to create a link from your source account to your monitoring account. For more information, see CloudWatch cross-account observability. Required resources For proper functionality of Application Signals cross-account observability, ensure that the following telemetry types are shared through the CloudWatch Observability Access Manager. • Application Signals services and service level objectives (SLOs) • Metrics in Amazon CloudWatch • Log groups in Amazon CloudWatch Logs • Traces in AWS X-Ray Supported languages and architectures Application Signals supports Java, Python, Node.js, and .NET applications. Application Signals is supported and tested on Amazon EKS, Amazon ECS, and Amazon EC2. On Amazon EKS clusters, it automatically discovers the names of your services and clusters. On other architectures, you must supply the names of services and environments when you enable those services for Application Signals. Application Signals 1317 Amazon CloudWatch User Guide The instructions for enabling Application Signals on Amazon EC2 should work on any architecture that supports the CloudWatch agent and AWS Distro for OpenTelemetry. However, the instructions have not been tested on architectures other than Amazon ECS and Amazon EC2. Supported Regions Application Signals is supported in every commercial Region except for Canada West (Calgary). Permissions required for Application Signals This section explains the permissions necessary for you to enable, manage, and operate Application Signals. Permissions to enable and manage Application Signals To manage Application Signals, you must be signed on with the following permissions: { "Version": "2012-10-17", "Statement": [ { "Sid": "CloudWatchApplicationSignalsFullAccessPermissions", "Effect": "Allow", "Action": "application-signals:", "Resource": "" }, { "Sid": "CloudWatchApplicationSignalsAlarmsPermissions", "Effect": "Allow", "Action": [ "cloudwatch:DescribeAlarms" ], "Resource": "" }, { "Sid": "CloudWatchApplicationSignalsMetricsPermissions", "Effect": "Allow", "Action": [ "cloudwatch:GetMetricData", "cloudwatch:ListMetrics" ], "Resource": "" }, Permissions required for Application Signals 1318 Amazon CloudWatch { User Guide "Sid": "CloudWatchApplicationSignalsLogGroupPermissions", "Effect": "Allow", "Action": [ "logs:StartQuery", "logs:DescribeMetricFilters" ], "Resource": "arn:aws:logs:::log-group:/aws/application-signals/data:" }, { "Sid": "CloudWatchApplicationSignalsLogsPermissions", "Effect": "Allow", "Action": [ "logs:GetQueryResults", "logs:StopQuery" ], "Resource": "" }, { "Sid": "CloudWatchApplicationSignalsSyntheticsPermissions", "Effect": "Allow", "Action": [ "synthetics:DescribeCanaries", "synthetics:DescribeCanariesLastRun", "synthetics:GetCanaryRuns" ], "Resource": "" }, { "Sid": "CloudWatchApplicationSignalsRumPermissions", "Effect": "Allow", "Action": [ "rum:BatchCreateRumMetricDefinitions", "rum:BatchDeleteRumMetricDefinitions", "rum:BatchGetRumMetricDefinitions", "rum:GetAppMonitor", "rum:GetAppMonitorData", "rum:ListAppMonitors", "rum:PutRumMetricsDestination", "rum:UpdateRumMetricDefinition" ], "Resource": "" }, { Permissions required for Application Signals 1319 Amazon CloudWatch User Guide "Sid": "CloudWatchApplicationSignalsXrayPermissions", "Effect": "Allow", "Action": [ "xray:GetTraceSummaries" ], "Resource": "" }, { "Sid": "CloudWatchApplicationSignalsPutMetricAlarmPermissions", "Effect": "Allow", "Action": "cloudwatch:PutMetricAlarm", "Resource": [ "arn:aws:cloudwatch:::alarm:SLO-AttainmentGoalAlarm-", "arn:aws:cloudwatch:::alarm:SLO-WarningAlarm-", "arn:aws:cloudwatch:::alarm:SLI-HealthAlarm-" ] }, { "Sid": "CloudWatchApplicationSignalsCreateServiceLinkedRolePermissions", "Effect": "Allow", "Action": "iam:CreateServiceLinkedRole", "Resource": "arn:aws:iam:::role/aws-service-role/application- signals.cloudwatch.amazonaws.com/AWSServiceRoleForCloudWatchApplicationSignals", "Condition": { "StringLike": { "iam:AWSServiceName": "application-signals.cloudwatch.amazonaws.com" } } }, { "Sid": "CloudWatchApplicationSignalsGetRolePermissions", "Effect": "Allow", "Action": "iam:GetRole", "Resource": "arn:aws:iam:::role/aws-service-role/application- signals.cloudwatch.amazonaws.com/AWSServiceRoleForCloudWatchApplicationSignals" }, { "Sid": "CloudWatchApplicationSignalsSnsWritePermissions", "Effect": "Allow", "Action": [ "sns:CreateTopic", "sns:Subscribe" ], "Resource": "arn:aws:sns:::cloudwatch-application-signals-" Permissions required for Application Signals 1320 Amazon CloudWatch }, { "Sid": "CloudWatchApplicationSignalsSnsReadPermissions", User Guide "Effect": "Allow", "Action": "sns:ListTopics", "Resource": "" } ] } To enable Application Signals on Amazon EC2, or custom architectures, see Enable Application Signals on Amazon EC2. To enable and
acw-ug-358	acw-ug.pdf	358	}, { "Sid": "CloudWatchApplicationSignalsPutMetricAlarmPermissions", "Effect": "Allow", "Action": "cloudwatch:PutMetricAlarm", "Resource": [ "arn:aws:cloudwatch:::alarm:SLO-AttainmentGoalAlarm-", "arn:aws:cloudwatch:::alarm:SLO-WarningAlarm-", "arn:aws:cloudwatch:::alarm:SLI-HealthAlarm-" ] }, { "Sid": "CloudWatchApplicationSignalsCreateServiceLinkedRolePermissions", "Effect": "Allow", "Action": "iam:CreateServiceLinkedRole", "Resource": "arn:aws:iam:::role/aws-service-role/application- signals.cloudwatch.amazonaws.com/AWSServiceRoleForCloudWatchApplicationSignals", "Condition": { "StringLike": { "iam:AWSServiceName": "application-signals.cloudwatch.amazonaws.com" } } }, { "Sid": "CloudWatchApplicationSignalsGetRolePermissions", "Effect": "Allow", "Action": "iam:GetRole", "Resource": "arn:aws:iam:::role/aws-service-role/application- signals.cloudwatch.amazonaws.com/AWSServiceRoleForCloudWatchApplicationSignals" }, { "Sid": "CloudWatchApplicationSignalsSnsWritePermissions", "Effect": "Allow", "Action": [ "sns:CreateTopic", "sns:Subscribe" ], "Resource": "arn:aws:sns:::cloudwatch-application-signals-" Permissions required for Application Signals 1320 Amazon CloudWatch }, { "Sid": "CloudWatchApplicationSignalsSnsReadPermissions", User Guide "Effect": "Allow", "Action": "sns:ListTopics", "Resource": "" } ] } To enable Application Signals on Amazon EC2, or custom architectures, see Enable Application Signals on Amazon EC2. To enable and manage Application Signals on Amazon EKS using the Amazon CloudWatch Observability EKS add-on, you need the following permissions. Important These permissions include iam:PassRole with Resource "” and eks:CreateAddon with Resource “”. These are powerful permissions and you should use caution in granting them. { "Version": "2012-10-17", "Statement": [ { "Sid": "CloudWatchApplicationSignalsEksAddonManagementPermissions", "Effect": "Allow", "Action": [ "eks:AccessKubernetesApi", "eks:CreateAddon", "eks:DescribeAddon", "eks:DescribeAddonConfiguration", "eks:DescribeAddonVersions", "eks:DescribeCluster", "eks:DescribeUpdate", "eks:ListAddons", "eks:ListClusters", "eks:ListUpdates", "iam:ListRoles", "iam:PassRole" ], "Resource": "" Permissions required for Application Signals 1321 Amazon CloudWatch }, { "Sid": User Guide "CloudWatchApplicationSignalsEksCloudWatchObservabilityAddonManagementPermissions", "Effect": "Allow", "Action": [ "eks:DeleteAddon", "eks:UpdateAddon" ], "Resource": "arn:aws:eks:::addon//amazon-cloudwatch-observability/" } ] } The Application Signals dashboard shows the AWS Service Catalog AppRegistry applications that your SLOs are associated with. To see these applications in the SLO pages, you must have the following permissions: { "Version": "2012-10-17", "Statement": [ { "Sid": "CloudWatchApplicationSignalsTaggingReadPermissions", "Effect": "Allow", "Action": "tag:GetResources", "Resource": "" } ] } Operating Application Signals Service operators who are using Application Signals to monitor services and SLOs must be signed on to an account with the following read only permissions: { "Version": "2012-10-17", "Statement": [ { "Sid": "CloudWatchApplicationSignalsReadOnlyAccessPermissions", "Effect": "Allow", "Action": [ Permissions required for Application Signals 1322 Amazon CloudWatch User Guide "application-signals:BatchGet", "application-signals:Get", "application-signals:List" ], "Resource": "" }, { "Sid": "CloudWatchApplicationSignalsGetRolePermissions", "Effect": "Allow", "Action": "iam:GetRole", "Resource": "arn:aws:iam:::role/aws-service-role/application- signals.cloudwatch.amazonaws.com/AWSServiceRoleForCloudWatchApplicationSignals" }, { "Sid": "CloudWatchApplicationSignalsLogGroupPermissions", "Effect": "Allow", "Action": [ "logs:StartQuery", "logs:DescribeMetricFilters" ], "Resource": "arn:aws:logs:::log-group:/aws/application-signals/data:" }, { "Sid": "CloudWatchApplicationSignalsLogsPermissions", "Effect": "Allow", "Action": [ "logs:GetQueryResults", "logs:StopQuery" ], "Resource": "" }, { "Sid": "CloudWatchApplicationSignalsAlarmsReadPermissions", "Effect": "Allow", "Action": [ "cloudwatch:DescribeAlarms" ], "Resource": "" }, { "Sid": "CloudWatchApplicationSignalsMetricsReadPermissions", "Effect": "Allow", "Action": [ "cloudwatch:GetMetricData", Permissions required for Application Signals 1323 Amazon CloudWatch User Guide "cloudwatch:ListMetrics" ], "Resource": "" }, { "Sid": "CloudWatchApplicationSignalsSyntheticsReadPermissions", "Effect": "Allow", "Action": [ "synthetics:DescribeCanaries", "synthetics:DescribeCanariesLastRun", "synthetics:GetCanaryRuns" ], "Resource": "" }, { "Sid": "CloudWatchApplicationSignalsRumReadPermissions", "Effect": "Allow", "Action": [ "rum:BatchGetRumMetricDefinitions", "rum:GetAppMonitor", "rum:GetAppMonitorData", "rum:ListAppMonitors" ], "Resource": "" }, { "Sid": "CloudWatchApplicationSignalsXrayReadPermissions", "Effect": "Allow", "Action": [ "xray:GetTraceSummaries" ], "Resource": "" } ] } To see which AWS Service Catalog AppRegistry Applications that your SLOs are associated within the Application Signals dashboard, you must have the following permissions: { "Version": "2012-10-17", "Statement": [ { Permissions required for Application Signals 1324 Amazon CloudWatch User Guide "Sid": "CloudWatchApplicationSignalsTaggingReadPermissions", "Effect": "Allow", "Action": "tag:GetResources", "Resource": "" } ] } To check if Application Signals on Amazon EKS using the Amazon CloudWatch Observability EKS add-on is enabled, you need to have the following permissions: { "Version": "2012-10-17", "Statement": [ { "Sid": "CloudWatchApplicationSignalsEksReadPermissions", "Effect": "Allow", "Action": [ "eks:ListAddons", "eks:ListClusters" ], "Resource": "" }, { "Sid": "CloudWatchApplicationSignalsEksDescribeAddonReadPermissions", "Effect": "Allow", "Action": [ "eks:DescribeAddon" ], "Resource": "arn:aws:eks:::addon//amazon-cloudwatch-observability/*" } ] } Supported systems Application Signals is supported and tested on Amazon EKS, native Kubernetes, Amazon ECS, and Amazon EC2. The instructions for enabling Application Signals on Amazon EC2 should work on any platform that supports the CloudWatch agent and AWS Distro for OpenTelemetry, but the instructions have not been tested on other platforms. Topics Supported systems 1325 User Guide Amazon CloudWatch • Java compatibility • Python compatibility • .NET compatibility • Node.js compatibility • OpenTelemetry compatibility • Known issues Java compatibility Application Signals supports Java applications, and supports the same Java libraries and frameworks as the AWS Distro for OpenTelemetry does. For more information, see Supported libraries, frameworks, application servers, and JVMs. JVM versions 8, 11, 17, 21, and 23 are supported. Python compatibility Python compatibility Application Signals supports the same libraries and frameworks as the AWS Distro for OpenTelemetry does. For more information, see Supported packages at opentelemetry-python- contrib. Python versions 3.8 and later are supported. Before you enable Application Signals for your Python applications, be aware of the following considerations. • In some containerized applications, a missing PYTHONPATH environment variable can sometimes cause the application to fail to start. To resolve this, ensure that you set the PYTHONPATH environment variable to the location of your application’s working directory. This is due to a known issue with OpenTelemetry auto-instrumentation. For more information about this issue, see Python autoinstrumentation setting of PYTHONPATH is not compliant. • For Django applications, there are additional required conﬁgurations, which are outlined in the OpenTelemetry Python documentation. • Use the --noreload ﬂag to prevent automatic reloading. Supported systems 1326 Amazon CloudWatch User Guide • Set the DJANGO_SETTINGS_MODULE environment variable to the location of
acw-ug-359	acw-ug.pdf	359	missing PYTHONPATH environment variable can sometimes cause the application to fail to start. To resolve this, ensure that you set the PYTHONPATH environment variable to the location of your application’s working directory. This is due to a known issue with OpenTelemetry auto-instrumentation. For more information about this issue, see Python autoinstrumentation setting of PYTHONPATH is not compliant. • For Django applications, there are additional required conﬁgurations, which are outlined in the OpenTelemetry Python documentation. • Use the --noreload ﬂag to prevent automatic reloading. Supported systems 1326 Amazon CloudWatch User Guide • Set the DJANGO_SETTINGS_MODULE environment variable to the location of your Django application’s settings.py ﬁle. This ensures that OpenTelemetry can correctly access and integrate with your Django settings. .NET compatibility Application Signals supports .NET applications with AWS Distro for Open Telemetry (ADOT) instrumentation on Amazon EKS, Amazon EC2, Amazon ECS and Kubernetes running on Amazon EC2. This release supports .NET 6 and 8, and .NET Framework 4.6.2 and higher. Application Signals supports .NET applications that are running on x86-64 or ARM64 CPUs, and supports the Linux x64, Linux ARM64, Microsoft Windows Server 2022 x64, and Microsoft Windows Server 2019 x64 operating systems. Node.js compatibility Application Signals supports the same Node.js libraries and frameworks as the AWS Distro for OpenTelemetry does. For more information, see Supported instrumentations. This release supports Node.js versions 14, 16, 18, 20, and 22. Known limitations about Node.js with ESM The AWS Distro for Opentelemetry Node.js supports two module systems: ECMAScript Modules (ESM) and CommonJS (CJS). To enable Application Signals, we recommend that you use the CJS module format because OpenTelemetry JavaScript’s support of ESM is experimental and a work in progress. For more details, see ECMAScript Modules vs. CommonJS on GitHub. To determine if your application is using CJS and not ESM, ensure that your application does not fulﬁll the conditions to enable ESM. For more information about these conditions, see Enabling in the Node.js documentation. The AWS Distro for Opentelemetry Node.js provides limited support for ESM based on OpenTelemetry JavaScript’s experimental support for ESM. This means the following: • The Node.js version must be 18.19.0 or later. Supported systems 1327 Amazon CloudWatch User Guide • The Node.js application that you want to instrument must include @aws/aws-distro- opentelemetry-node-autoinstrumentation and @opentelemetry/instrumentation as dependencies. • The Node.js application that you want to instrument must start with the following node option: NODE_OPTIONS=' --import @aws/aws-distro-opentelemetry-node-autoinstrumentation/ register --experimental-loader=@opentelemetry/instrumentation/hook.mjs' To enable Application Signals with Node.js ESM module format, we provide the diﬀerent setup for diﬀerent platforms: • Amazon EKS – the section called “Setting up a Node.js application with the ESM module format” • Amazon ECS with sidecar strategy – Setting up a Node.js application with the ESM module format • Amazon ECS with daemon strategy – Setting up a Node.js application with the ESM module format • Amazon ECS with AWS CDK • Amazon EC2 – Setting up a Node.js application with the ESM module format • Kubernetes – the section called “Setting up a Node.js application with the ESM module format” OpenTelemetry compatibility CloudWatch Application Signals is fully compatible with OpenTelemetry. For information about how to get started, see OpenTelemetry with CloudWatch. If you want a more integrated experience, such as using the CloudWatch Agent with AWS Distro for OpenTelemetry (ADOT) SDKs, see Getting started with Application Signals to ﬁnd your preferred conﬁguration method. Known issues The runtime metrics collection in the Java SDK release v1.32.5 is known to not work with applications using JBoss Wildﬂy. This issue extends to the Amazon CloudWatch Observability EKS add-on, aﬀecting versions 2.3.0-eksbuild.1 through 2.6.0-eksbuild.1. The issue is ﬁxed in Java SDK release v1.32.6 and the Amazon CloudWatch Observability EKS add-on version v3.0.0-eksbuild.1. Supported systems 1328 Amazon CloudWatch User Guide If you are impacted, either upgrade the Java SDK version or disable your runtime metrics collection by adding the environment variable OTEL_AWS_APPLICATION_SIGNALS_RUNTIME_ENABLED=false to your application. Supported instrumentation setups You can enable CloudWatch Application Signals with diﬀerent instrumentation setups. This topic describes each of the setup methods and recommendations based on the method you choose. Use AWS Distro for OpenTelemetry with the CloudWatch Agent The most integrated application performance monitoring(APM) experience in CloudWatch is delivered through the AWS Distro for OpenTelemetry (ADOT) SDKs and are used with the CloudWatch Agent to collect application metrics and traces. This option works best if you want to get started with APM in CloudWatch quickly and also leverage out-of-the box integrations with features, such as Container Insights and CloudWatch Logs. For more information, see Enable Application Signals on Amazon EKS Clusters and Enable Application Signals on Amazon EC2, Amazon ECS, or Kubernates. Use the OpenTelemetry SDK and Collector This setup works for the following use cases: 1. You instrumented your application or plan with OpenTelemetry SDKs and currently are using OpenTelemetry Collector. 2. You're using languages, such as Erlang
acw-ug-360	acw-ug.pdf	360	used with the CloudWatch Agent to collect application metrics and traces. This option works best if you want to get started with APM in CloudWatch quickly and also leverage out-of-the box integrations with features, such as Container Insights and CloudWatch Logs. For more information, see Enable Application Signals on Amazon EKS Clusters and Enable Application Signals on Amazon EC2, Amazon ECS, or Kubernates. Use the OpenTelemetry SDK and Collector This setup works for the following use cases: 1. You instrumented your application or plan with OpenTelemetry SDKs and currently are using OpenTelemetry Collector. 2. You're using languages, such as Erlang and Rust, that aren't supported by AWS Distro for OpenTelemetry (ADOT). For more information, see OpenTelemetry with CloudWatch. Use the AWS X-Ray SDK and daemon This option is best if you instrumented your application using X-Ray SDKs and haven't migrated ADOT SDKs or OpenTelemetry SDKs. For more information, see Transaction Search. Supported instrumentation setups 1329 Amazon CloudWatch Feature comparison User Guide Feature ADOT SDK + CloudWatch Open Telemetry SDK + OpenTelemetry Collector AWS Support Nonstandard language support Agent Yes No Container Insights integration Yes Out of the box logging with CloudWatch Logs Out of the box runtime metrics Always gets metrics on 100% of traﬃc Yes Yes Yes Only for data sent to AWS Yes No No Yes Only at 100% sampling rate X- Ray SDKs Yes No No No No Only at 100% sampling rate Enable Application Signals in your account If you haven't enabled Application Signals in this account yet, you must grant Application Signals the permissions it needs to discover your services. You need to do this only once for your account. To enable CloudWatch Application Signals, do the following. 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. In the navigation pane, choose Services. 3. Choose Start discovering your Services. 4. Select the check box and choose Start discovering Services. Enable Application Signals in your account 1330 Amazon CloudWatch User Guide Completing this step for the ﬁrst time in your account creates the AWSServiceRoleForCloudWatchApplicationSignals service-linked role. This role grants Application Signals the following permissions: • xray:GetServiceGraph • logs:StartQuery • logs:GetQueryResults • cloudwatch:GetMetricData • cloudwatch:ListMetrics • tag:GetResources For more information about this role, see Service-linked role permissions for CloudWatch Application Signals. 5. Choose Enable Application Signals. (Optional) Try out Application Signals with a sample app To try out CloudWatch Application Signals on a sample app before you instrument your own applications with it, follow the instructions in this section. These instructions use scripts to help you create an Amazon EKS cluster, install a sample application, and instrument the sample application to work with Application Signals. The sample application is a Spring "Pet Clinic" application that is composed of four microservices. These services run on Amazon EKS on Amazon EC2 and leverage Application Signals enablement scripts to enable the cluster with the Java, Python, or .NET auto-instrumentation agent. Requirements • Currently, Application Signals monitors only Java, Python, or .NET applications. • You must have the AWS CLI installed on the instance. We recommend AWS CLI version 2, but version 1 should also work. For more information about installing the AWS CLI, see Install or update the latest version of the AWS CLI. • The scripts in this section are intended to be run in Linux and macOS environments. For Windows instances, we recommend that you use an AWS Cloud9 environment to run these scripts. For more information about AWS Cloud9, see What is AWS Cloud9?. (Optional) Try out Application Signals with a sample app 1331 Amazon CloudWatch User Guide • Install a supported version of kubectl. You must use a version of kubectl within one minor version diﬀerence of your Amazon EKS cluster control plane. For example, a 1.26 kubectl client works with Kubernetes 1.25, 1.26, and 1.27 clusters. If you already have an Amazon EKS cluster, you might need to conﬁgure AWS credentials for kubectl. For more information, see Creating or updating a kubeconfig ﬁle for an Amazon EKS cluster. • Install eksctl. eksctl uses the AWS CLI to interact with AWS, which means it uses the same AWS credentials as the AWS CLI. For more information, see Installing or updating eksctl. • Install jq. jq is required to run the Application Signals enablement scripts. For more information, see Download jq. Step 1: Download the scripts To download the scripts to set up CloudWatch Application Signals with a sample app, you can download and uncompress the zipped GitHub project ﬁle to a local drive, or you can clone the GitHub project. To clone the project, open a terminal window and enter the following Git command in a given working directory. git clone https://github.com/aws-observability/application-signals-demo.git Step 2: Build and deploy the sample application To build and push the sample application images, follow these instructions. Step 3: Deploy and enable Application
acw-ug-361	acw-ug.pdf	361	to run the Application Signals enablement scripts. For more information, see Download jq. Step 1: Download the scripts To download the scripts to set up CloudWatch Application Signals with a sample app, you can download and uncompress the zipped GitHub project ﬁle to a local drive, or you can clone the GitHub project. To clone the project, open a terminal window and enter the following Git command in a given working directory. git clone https://github.com/aws-observability/application-signals-demo.git Step 2: Build and deploy the sample application To build and push the sample application images, follow these instructions. Step 3: Deploy and enable Application Signals and the sample application Be sure that you have completed the requirements listed in (Optional) Try out Application Signals with a sample app before you complete the following steps. To deploy and enable Application Signals and the sample application 1. Enter the following command. Replace new-cluster-name with the name that you want to use for the new cluster. Replace region-name with the name of the AWS Region, such as us- west-1. This command sets up the sample app running in a new Amazon EKS cluster with Application Signals enabled. (Optional) Try out Application Signals with a sample app 1332 Amazon CloudWatch User Guide # this script sets up a new cluster, enables Application Signals, and deploys the # sample application cd application-signals-demo/scripts/eks/appsignals/one-step && ./setup.sh new- cluster-name region-name The setup script takes about 30 minutes to run, and does the following: • Creates a new Amazon EKS cluster in the speciﬁed Region. • Creates the necessary IAM permissions for Application Signals (arn:aws:iam::aws:policy/AWSXrayWriteOnlyAccess and arn:aws:iam::aws:policy/CloudWatchAgentServerPolicy). • Enables Application Signals by installing the CloudWatch agent and Auto-instrumenting the sample application for CloudWatch metrics and X-Ray traces. • Deploys the PetClinic Spring sample application in the same Amazon EKS cluster. • Creates ﬁve CloudWatch Synthetics canaries, named pc-add-vist, pc-create-owners, pc-visit-pet, pc-visit-vet, pc-clinic-traffic. These canaries will run at a one- minute frequency to generate synthetic traﬃc for the sample app and demonstrate how Synthetics canaries appear in Application Signals. • Creates four service level objectives (SLOs) for the PetClinic application with the following names: • Availability for Searching an Owner • Latency for Searching an Owner • Availability for Registering an Owner • Latency for Registering an Owner • Creates the required IAM role with a custom trust policy granting Application Signals the following permissions: • cloudwatch:PutMetricData • cloudwatch:GetMetricData • xray:GetServiceGraph • logs:StartQuery • logs:GetQueryResults 2. (Optional) If you want to review the source code for the PetClinic sample application, you can ﬁnd them under the root folder. (Optional) Try out Application Signals with a sample app 1333 Amazon CloudWatch User Guide - application-signals-demo - spring-petclinic-admin-server - spring-petclinic-api-gateway - spring-petclinic-config-server - spring-petclinic-customers-service - spring-petclinic-discovery-server - spring-petclinic-vets-service - spring-petclinic-visits-service 3. To view the deployed PetClinic sample application, run the following command to ﬁnd the URL: kubectl get ingress Step 4: Monitor the sample application After completing the steps in the previous section to create the Amazon EKS cluster and deploy the sample application, you can use Application Signals to monitor the application. Note For the Application Signals console to start populating, some traﬃc must reach the sample application. Part of the previous steps created CloudWatch Synthetics canaries that generate traﬃc to the sample application. Service health monitoring After it is enabled, CloudWatch Application Signals automatically discovers and populates a list of services without requiring any additional setup. To view the list of discovered services and monitor their health 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. 3. In the navigation pane, choose Application Signals, Services. To view a service, its operations, and its dependencies, choose the name of one of the services in the list. (Optional) Try out Application Signals with a sample app 1334 Amazon CloudWatch User Guide This uniﬁed, application-centric view helps provide a full perspective of how users are interacting with your service. This can help you triage issues if performance anomalies occur. For complete details about the Services view, see Monitor the operational health of your applications with Application Signals. 4. Choose the Service Operations tab to see the standard application metrics for that service's operations. The operations are the API operations that the service calls, for example. Then, to view the graphs for a single operation of that service, choose that operation name. 5. Choose the Dependencies tab to see the dependencies that your application has, along with the critical application metrics for each dependency. Dependencies include AWS services and third-party services that your application calls. 6. To view correlated traces from the service details page, choose a data point in one of the three graphs above the table. This populates a new pane with ﬁltered traces from the time period. These traces are sorted and ﬁltered based on the graph that you chose. For example, if you chose the
acw-ug-362	acw-ug.pdf	362	the graphs for a single operation of that service, choose that operation name. 5. Choose the Dependencies tab to see the dependencies that your application has, along with the critical application metrics for each dependency. Dependencies include AWS services and third-party services that your application calls. 6. To view correlated traces from the service details page, choose a data point in one of the three graphs above the table. This populates a new pane with ﬁltered traces from the time period. These traces are sorted and ﬁltered based on the graph that you chose. For example, if you chose the Latency graph, the traces are sorted by service response time. 7. In the CloudWatch console navigation pane, choose SLOs. You see the SLOs that the script created for the sample application. For more information about SLOs, see Service level objectives (SLOs). (Optional) Step 5: Cleanup When you're ﬁnished testing Application signals, you can use a script provided by Amazon to clean up and delete the artifacts created in your account for the sample application. To perform the cleanup, enter the following command. Replace new-cluster-name with the name of the cluster that you created for the sample app, and replace region-name with the name of the AWS Region, such as us-west-1. cd application-signals-demo/scripts/eks/appsignals/one-step && ./cleanup.sh new- cluster-name region-name Enable your applications on Amazon EKS clusters CloudWatch Application Signals is supported for Java, Python, Node.js, and .NET applications. To enable Application Signals for your applications on an existing Amazon EKS cluster, you can use the AWS Management Console or the AWS CDK. Enable your applications on Amazon EKS clusters 1335 Amazon CloudWatch Topics • Enable Application Signals on an Amazon EKS cluster using the console • Enable Application Signals on Amazon EKS using AWS CDK User Guide Enable Application Signals on an Amazon EKS cluster using the console To enable CloudWatch Application Signals on your applications on an existing Amazon EKS cluster, use the instructions in this section. Important If you are already using OpenTelemetry with an application that you intend to enable for Application Signals, see OpenTelemetry compatibility before you enable Application Signals. To enable Application Signals for your applications on an existing Amazon EKS cluster Note If you haven't already enabled Application Signals, follow the instructions in Enable Application Signals in your account and then follow the procedure below. 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. Choose Application Signals. 3. 4. 5. For Specify platform, choose EKS. For Select an EKS cluster, select the cluster where you want to enable Application Signals. If this cluster does not already have the Amazon CloudWatch Observability EKS add-on enabled, you are prompted to enable it. If this is the case, do the following: a. b. Choose Add CloudWatch Observability EKS add-on. The Amazon EKS console appears. Select the check box for Amazon CloudWatch Observability and choose Next. The CloudWatch Observability EKS add-on enables both Application Signals and CloudWatch Container Insights with enhanced observability for Amazon EKS. For more information about Container Insights, see Container Insights. Enable your applications on Amazon EKS clusters 1336 Amazon CloudWatch User Guide c. d. Select the most recent version of the add-on to install. Select an IAM role to use for the add-on. If you choose Inherit from node, attach the correct permissions to the IAM role used by your worker nodes. Replace my-worker- node-role with the IAM role used by your Kubernetes worker nodes. aws iam attach-role-policy \ --role-name my-worker-node-role \ --policy-arn arn:aws:iam::aws:policy/CloudWatchAgentServerPolicy \ --policy-arn arn:aws:iam::aws:policy/AWSXRayWriteOnlyAccess e. If you want to create a service role to use the add-on, see Install the CloudWatch agent with the Amazon CloudWatch Observability EKS add-on or the Helm chart. f. g. Choose Next, conﬁrm the information on the screen, and choose Create. In the next screen, choose Enable CloudWatch Application Signals to return to the CloudWatch console and ﬁnish the process. 6. There are two options for enabling your applications for Application Signals. For consistency, we recommend that you choose one option per cluster. • The Console option is simpler. Using this method causes your pods to restart immediately. • The Annotate Manifest File method gives you more control of when your pods restart, and can also help you manage your monitoring in a more decentralized way if you don’t want to centralize it. Note If you are enabling Application Signals for a Node.js application with ESM, skip to Setting up a Node.js application with the ESM module format instead. Console The Console option uses the advanced conﬁguration of the Amazon CloudWatch Observability EKS add-on to setup Application Signals for your services. For more information about the add-on, see (Optional) Additional conﬁguration. If you don’t see a list of workloads and namespaces, ensure you have the right permissions to view them for this cluster. For more information, see Required permissions.
acw-ug-363	acw-ug.pdf	363	your monitoring in a more decentralized way if you don’t want to centralize it. Note If you are enabling Application Signals for a Node.js application with ESM, skip to Setting up a Node.js application with the ESM module format instead. Console The Console option uses the advanced conﬁguration of the Amazon CloudWatch Observability EKS add-on to setup Application Signals for your services. For more information about the add-on, see (Optional) Additional conﬁguration. If you don’t see a list of workloads and namespaces, ensure you have the right permissions to view them for this cluster. For more information, see Required permissions. Enable your applications on Amazon EKS clusters 1337 Amazon CloudWatch User Guide You can monitor single workloads or entire namespaces. To monitor a single workload: 1. Select the check box by the workload that you want to monitor. 2. Use the Select language(s) dropdown list to select the language of the workload. Select the languages that you want to enable Application Signals for, and then choose the check mark icon (✓) to save this selection. For Python applications, ensure your application follows the required prerequisites before continuing. For more information, see Python application doesn't start after Application Signals is enabled. 3. Choose Done. The Amazon CloudWatch Observability EKS add-on will immediately inject AWS Distro for OpenTelemetry autoinstrumentation (ADOT) SDKs into your pods and trigger pod restarts to enable collection of application metrics and traces. To monitor an entire namespace: 1. Select the check box by the namespace that you want to monitor. 2. Use the Select language(s) dropdown list to select the language of the namespace. Select the languages that you want to enable Application Signals for, and then choose the check mark icon (✓) to save this selection. This applies it to all workloads in this namespace, whether they are currently deployed or will be deployed in the future. For Python applications, ensure your application follows the required prerequisites before continuing. For more information, see Python application doesn't start after Application Signals is enabled. 3. Choose Done. The Amazon CloudWatch Observability EKS add-on will immediately inject AWS Distro for OpenTelemetry autoinstrumentation (ADOT) SDKs into your pods and trigger pod restarts to enable collection of application metrics and traces. To enable Application Signals in another Amazon EKS cluster, choose Enable Application Signals from the Services screen. Enable your applications on Amazon EKS clusters 1338 Amazon CloudWatch Annotate manifest ﬁle User Guide In the CloudWatch console, the Monitor Services section explains that you must add an annotation to a manifest YAML in the cluster. Adding this annotation auto-instruments the application to send metrics, traces, and logs to Application Signals. You have two options for the annotation: • Annotate Workload auto-instruments a single workload in the cluster. • Annotate Namespace auto-instruments all workloads deployed in the selected namespace. Choose one of those options, and follow the appropriate steps: • To annotate a single workload: 1. Choose Annotate Workload. 2. Paste one of the following lines into the PodTemplate section of the workload manifest ﬁle. • For Java workloads: annotations: instrumentation.opentelemetry.io/ inject-java: "true" • For Python workloads: annotations: instrumentation.opentelemetry.io/inject-python: "true" For Python applications, there are additional required conﬁgurations. For more information, see Python application doesn't start after Application Signals is enabled. • For .NET workloads annotations: instrumentation.opentelemetry.io/ inject-dotnet: "true" Note To enable Application Signals for a .NET workload on Alpine Linux (linux- musl-x64) based images, add the following annotation. instrumentation.opentelemetry.io/otel-dotnet-auto-runtime: "linux- musl-x64" Enable your applications on Amazon EKS clusters 1339 Amazon CloudWatch User Guide • For Node.js workloads: annotations: instrumentation.opentelemetry.io/inject-nodejs: "true" 3. In your terminal, enter kubectl apply -f your_deployment_yaml to apply the change. • To annotate all workloads in a namespace: 1. Choose Annotate Namespace. 2. Paste one of the following lines into the metadata section of the namespace manifest ﬁle. If the namespace includes Java, Python, and .NET workloads, paste all of the following lines into the namespace manifest ﬁle. • If there are Java workloads in the namespace: annotations: instrumentation.opentelemetry.io/inject-java: "true" • If there are Python workloads in the namespace: annotations: instrumentation.opentelemetry.io/inject-python: "true" For Python applications, there are additional required conﬁgurations. For more information, see Python application doesn't start after Application Signals is enabled. • If there are .NET workloads in the namespace: annotations: instrumentation.opentelemetry.io/inject-dotnet: "true" • If there are Node.JS workloads in the namespace: annotations: instrumentation.opentelemetry.io/inject-nodejs: "true" 3. In your terminal, enter kubectl apply -f your_namespace_yaml to apply the change. 4. In your terminal, enter a command to restart all pods in the namespace. An example command to restart deployment workloads is kubectl rollout restart deployment -n namespace_name 7. Choose View Services when done. This takes you to the Application Signals Services view, where you can see the data that Application Signals is collecting. It might take a few minutes for data to appear. To enable Application Signals in
acw-ug-364	acw-ug.pdf	364	in the namespace: annotations: instrumentation.opentelemetry.io/inject-dotnet: "true" • If there are Node.JS workloads in the namespace: annotations: instrumentation.opentelemetry.io/inject-nodejs: "true" 3. In your terminal, enter kubectl apply -f your_namespace_yaml to apply the change. 4. In your terminal, enter a command to restart all pods in the namespace. An example command to restart deployment workloads is kubectl rollout restart deployment -n namespace_name 7. Choose View Services when done. This takes you to the Application Signals Services view, where you can see the data that Application Signals is collecting. It might take a few minutes for data to appear. To enable Application Signals in another Amazon EKS cluster, choose Enable Application Signals from the Services screen. For more information about the Services view, see Monitor the operational health of your applications with Application Signals. Enable your applications on Amazon EKS clusters 1340 Amazon CloudWatch Note User Guide If you're using a WSGI server for your Python application, see No Application Signals data for Python application that uses a WSGI server for information to make Application Signals work. We've also identiﬁed other considerations that you should keep in mind when enabling Python applications for Application Signals. For more information, see Python application doesn't start after Application Signals is enabled. Setting up a Node.js application with the ESM module format We provide limited support for Node.js applications with the ESM module format. For details, see the section called “Known limitations about Node.js with ESM”. For the ESM module format, enabling Application Signals through the console or by annotating the manifest ﬁle doesn’t work. Skip step 8 of the previous procedure, and do the following instead. To enable Application Signals for a Node.js application with ESM 1. Install the relevant dependencies to your Node.js application for autoinstrumentation: npm install @aws/aws-distro-opentelemetry-node-autoinstrumentation npm install @opentelemetry/instrumentation@0.54.0 2. Add the following environmental variables to the Dockerﬁle for your application and build the image. ... ENV OTEL_AWS_APPLICATION_SIGNALS_ENABLED=true ENV OTEL_TRACES_SAMPLER_ARG='endpoint=http://cloudwatch-agent.amazon- cloudwatch:2000' ENV OTEL_TRACES_SAMPLER='xray' ENV OTEL_EXPORTER_OTLP_PROTOCOL='http/protobuf' ENV OTEL_EXPORTER_OTLP_TRACES_ENDPOINT='http://cloudwatch-agent.amazon- cloudwatch:4316/v1/traces' ENV OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT='http://cloudwatch-agent.amazon- cloudwatch:4316/v1/metrics' ENV OTEL_METRICS_EXPORTER='none' ENV OTEL_LOGS_EXPORTER='none' Enable your applications on Amazon EKS clusters 1341 Amazon CloudWatch User Guide ENV NODE_OPTIONS='--import @aws/aws-distro-opentelemetry-node-autoinstrumentation/ register --experimental-loader=@opentelemetry/instrumentation/hook.mjs' ENV OTEL_SERVICE_NAME='YOUR_SERVICE_NAME' #replace with a proper service name ENV OTEL_PROPAGATORS='tracecontext,baggage,b3,xray' ... # command to start the application # for example # CMD ["node", "index.mjs"] 3. Add the environmental variables OTEL_RESOURCE_ATTRIBUTES_POD_NAME, OTEL_RESOURCE_ATTRIBUTES_NODE_NAME, OTEL_RESOURCE_ATTRIBUTES_DEPLOYMENT_NAME, POD_NAMESPACE and OTEL_RESOURCE_ATTRIBUTES to the deployment yaml ﬁle for the application. For example: apiVersion: apps/v1 kind: Deployment metadata: name: nodejs-app labels: app: nodejs-app spec: replicas: 2 selector: matchLabels: app: nodejs-app template: metadata: labels: app: nodejs-app # annotations: # make sure this annotation doesn't exit # instrumentation.opentelemetry.io/inject-nodejs: 'true' spec: containers: - name: nodejs-app image:your-nodejs-application-image #replace with a proper image uri imagePullPolicy: Always ports: - containerPort: 8000 env: - name: OTEL_RESOURCE_ATTRIBUTES_POD_NAME valueFrom: Enable your applications on Amazon EKS clusters 1342 Amazon CloudWatch User Guide fieldRef: fieldPath: metadata.name - name: OTEL_RESOURCE_ATTRIBUTES_NODE_NAME valueFrom: fieldRef: fieldPath: spec.nodeName - name: OTEL_RESOURCE_ATTRIBUTES_DEPLOYMENT_NAME valueFrom: fieldRef: fieldPath: metadata.labels['app'] # Assuming 'app' label is set to the deployment name - name: POD_NAMESPACE valueFrom: fieldRef: fieldPath: metadata.namespace - name: OTEL_RESOURCE_ATTRIBUTES value: "k8s.deployment.name= $(OTEL_RESOURCE_ATTRIBUTES_DEPLOYMENT_NAME),k8s.namespace.name= $(POD_NAMESPACE),k8s.node.name=$(OTEL_RESOURCE_ATTRIBUTES_NODE_NAME),k8s.pod.name= $(OTEL_RESOURCE_ATTRIBUTES_POD_NAME)" 4. Deploy the Node.js application to the cluster. Once you have enabled your applications on the Amazon EKS Clusters, you can monitor your application health. For more information, see Monitor the operational health of your applications with Application Signals. Enable Application Signals on Amazon EKS using AWS CDK If you haven't enabled Application Signals in this account yet, you must grant Application Signals the permissions it needs to discover your services. See Enable Application Signals in your account. 1. Enable Application Signals for your applications. import { aws_applicationsignals as applicationsignals } from 'aws-cdk-lib'; const cfnDiscovery = new applicationsignals.CfnDiscovery(this, 'ApplicationSignalsServiceRole', { } ); The Discovery CloudFormation resource grants Application Signals the following permissions: Enable your applications on Amazon EKS clusters 1343 Amazon CloudWatch User Guide • xray:GetServiceGraph • logs:StartQuery • logs:GetQueryResults • cloudwatch:GetMetricData • cloudwatch:ListMetrics • tag:GetResources For more information about this role, see Service-linked role permissions for CloudWatch Application Signals. 2. Install the amazon-cloudwatch-observability add-on. • Create an IAM role with the CloudWatchAgentServerPolicy and the OIDC associated with the cluster. const cloudwatchRole = new Role(this, 'CloudWatchAgentAddOnRole', { assumedBy: new OpenIdConnectPrincipal(cluster.openIdConnectProvider), managedPolicies: [ManagedPolicy.fromAwsManagedPolicyName('CloudWatchAgentServerPolicy')], }); 3. Install the add-on with the IAM role created above. new CfnAddon(this, 'CloudWatchAddon', { addonName: 'amazon-cloudwatch-observability', clusterName: cluster.clusterName, serviceAccountRoleArn: cloudwatchRole.roleArn }); 4. Add one of the following into the PodTemplate section of your workload manifest ﬁle. Language Java Python File instrumentation.opentelemetry.io/inject- java: "true" instrumentation.opentelemetry.io/inject- python: "true" Enable your applications on Amazon EKS clusters 1344 Amazon CloudWatch User Guide Language .Net Node.js File instrumentation.opentelemetry.io/inject- dotnet: "true" instrumentation.opentelemetry.io/inject- nodejs: "true" const deployment = { apiVersion: "apps/v1", kind: "Deployment", metadata: { name: "sample-app" }, spec: { replicas: 3, selector: { matchLabels: { "app": "sample-app" } }, template: { metadata: { labels: { "app": "sample-app" }, annotations: { "instrumentation.opentelemetry.io/inject-$LANG": "true" } }, spec: {...}, }, },
acw-ug-365	acw-ug.pdf	365	'CloudWatchAddon', { addonName: 'amazon-cloudwatch-observability', clusterName: cluster.clusterName, serviceAccountRoleArn: cloudwatchRole.roleArn }); 4. Add one of the following into the PodTemplate section of your workload manifest ﬁle. Language Java Python File instrumentation.opentelemetry.io/inject- java: "true" instrumentation.opentelemetry.io/inject- python: "true" Enable your applications on Amazon EKS clusters 1344 Amazon CloudWatch User Guide Language .Net Node.js File instrumentation.opentelemetry.io/inject- dotnet: "true" instrumentation.opentelemetry.io/inject- nodejs: "true" const deployment = { apiVersion: "apps/v1", kind: "Deployment", metadata: { name: "sample-app" }, spec: { replicas: 3, selector: { matchLabels: { "app": "sample-app" } }, template: { metadata: { labels: { "app": "sample-app" }, annotations: { "instrumentation.opentelemetry.io/inject-$LANG": "true" } }, spec: {...}, }, }, }; cluster.addManifest('sample-app', deployment) 5. Enable your applications on Amazon EKS clusters 1345 Amazon CloudWatch User Guide Enable your applications on Amazon EC2 Enable CloudWatch Application Signals on Amazon EC2 by using the custom setup steps described in this section. For applications running on Amazon EC2, you install and conﬁgure the CloudWatch agent and AWS Distro for OpenTelemetry yourself. On these architectures enabled with a custom Application Signals setup, Application Signals doesn't autodiscover the names of your services or the hosts or clusters they run on. You must specify these names during the custom setup, and the names that you specify are what is displayed on Application Signals dashboards. The instructions in this section are for Java, Python, and .NET applications. The steps have been tested on Amazon EC2 instances, but are also expected to work on other architectures that support AWS Distro for OpenTelemetry. Requirements • To get support for Application Signals, you must use the most recent version of both the CloudWatch agent and the AWS Distro for OpenTelemetry agent. • You must have the AWS CLI installed on the instance. We recommend AWS CLI version 2, but version 1 should also work. For more information about installing the AWS CLI, see Install or update the latest version of the AWS CLI. Important If you are already using OpenTelemetry with an application that you intend to enable for Application Signals, see OpenTelemetry compatibility before you enable Application Signals. Step 1: Enable Application Signals in your account You must ﬁrst enable Application Signals in your account. If you haven't, see Enable Application Signals in your account. Enable your applications on Amazon EC2 1346 Amazon CloudWatch User Guide Step 2: Download and start the CloudWatch agent To install the CloudWatch agent as part of enabling Application Signals on an Amazon EC2 instance or on-premises host 1. Download the latest version of the CloudWatch agent to the instance. If the instance already has the CloudWatch agent installed, you might need to update it. Only versions of the agent released on November 30, 2023 or later support CloudWatch Application Signals. For information about downloading the CloudWatch agent, see Download the CloudWatch agent package. 2. Before you start the CloudWatch agent, conﬁgure it to enable Application Signals. The following example is a CloudWatch agent conﬁguration that enables Application Signals for both metrics and traces on an EC2 host. We recommend that you place this ﬁle at /opt/aws/amazon-cloudwatch-agent/etc/ amazon-cloudwatch-agent.json on Linux systems. { "traces": { "traces_collected": { "application_signals": {} } }, "logs": { "metrics_collected": { "application_signals": {} } } } 3. Attach the CloudWatchAgentServerPolicy IAM policy to the IAM role of your Amazon EC2 instance. For permissions for on-premises hosts, see Permissions for on-premises servers. a. Sign in to the AWS Management Console and open the IAM console at https:// console.aws.amazon.com/iam/. b. Choose Roles and ﬁnd the role used by your Amazon EC2 instance. Then choose the name of that role. c. In the Permissions tab, choose Add permissions, Attach policies. Enable your applications on Amazon EC2 1347 Amazon CloudWatch User Guide d. Find CloudWatchAgentServerPolicy. Use the search box if needed. Then select the check box for that policy and choose Add permissions. 4. Start the CloudWatch agent by entering the following commands. Replace agent-config- file-path with the path to the CloudWatch agent conﬁguration ﬁle, such as ./amazon- cloudwatch-agent.json. You must include the file: preﬁx as shown. export CONFIG_FILE_PATH=./amazon-cloudwatch-agent.json sudo /opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent-ctl \ -a fetch-config \ -m ec2 -s -c file:agent-config-file-path Permissions for on-premises servers For an on-premises host, you will need to provide AWS authorization to your device. To set up permissions for an on-premises host 1. Create the IAM user to be used to provide permissions to your on-premises host: a. Open the IAM console at https://console.aws.amazon.com/iam/. b. Choose Users, Create User. c. In User details, for User name, enter a name for the new IAM user. This is the sign-in name for AWS that will be used to authenticate your host. Then choose Next d. On the Set permissions page, under Permissions options, select Attach policies directly. e. From the Permissions policies list, select the CloudWatchAgentServerPolicy policy to add to your user. Then choose Next. f. On the Review and create page, ensure
acw-ug-366	acw-ug.pdf	366	host 1. Create the IAM user to be used to provide permissions to your on-premises host: a. Open the IAM console at https://console.aws.amazon.com/iam/. b. Choose Users, Create User. c. In User details, for User name, enter a name for the new IAM user. This is the sign-in name for AWS that will be used to authenticate your host. Then choose Next d. On the Set permissions page, under Permissions options, select Attach policies directly. e. From the Permissions policies list, select the CloudWatchAgentServerPolicy policy to add to your user. Then choose Next. f. On the Review and create page, ensure that you are satisﬁed with the user name and that the CloudWatchAgentServerPolicy policy is in the Permissions summary. g. Choose Create user 2. Create and retrieve your AWS access key and secret key: a. In the navigation pane in the IAM console, choose Users and then select the user name of the user that you created in the previous step. b. On the user's page, choose the Security credentials tab. Then, in the Access keys section, choose Create access key. Enable your applications on Amazon EC2 1348 Amazon CloudWatch User Guide c. d. e. For Create access key Step 1, choose Command Line Interface (CLI). For Create access key Step 2, optionally enter a tag and then choose Next. For Create access key Step 3, select Download .csv ﬁle to save a .csv ﬁle with your IAM user's access key and secret access key. You need this information for the next steps. f. Choose Done. 3. Conﬁgure your AWS credentials in your on-premises host by entering the following command. Replace ACCESS_KEY_ID and SECRET_ACCESS_ID with your newly generated access key and secret access key from the .csv ﬁle that you downloaded in the previous step. $ aws configure AWS Access Key ID [None]: ACCESS_KEY_ID AWS Secret Access Key [None]: SECRET_ACCESS_ID Default region name [None]: MY_REGION Default output format [None]: json Step 3: Instrument your application and start it The next step is to instrument your application for CloudWatch Application Signals. Java To instrument your Java applications as part of enabling Application Signals on an Amazon EC2 instance or on-premises host 1. Download the latest version of the AWS Distro for OpenTelemetry Java auto- instrumentation agent. You can download the latest version by using this link. You can view information about all released versions at aws-otel-java-instrumentation Releases. 2. To optimize your Application Signals beneﬁts, use environment variables to provide additional information before you start your application. This information will be displayed in Application Signals dashboards. • For the OTEL_RESOURCE_ATTRIBUTES variable, specify the following information as key-value pairs: • (Optional) service.name sets the name of the service. This will be displayed as the service name for your application in Application Signals dashboards. If you don't provide a value for this key, the default of UnknownService is used. Enable your applications on Amazon EC2 1349 Amazon CloudWatch User Guide • (Optional) deployment.environment sets the environment that the application runs in. This will be diplayed as the Hosted In environment of your application in Application Signals dashboards. If you don't specify this, one of the following defaults is used: • If this is an instance that is part of an Auto Scaling group, it is set to ec2:name- of-Auto-Scaling-group • If this is an Amazon EC2 instance that is not part of an Auto Scaling group, it is set to ec2:default • If this is an on-premises host, it is set to generic:default This environment variable is used only by Application Signals, and is converted into X-Ray trace annotations and CloudWatch metric dimensions. • For the OTEL_EXPORTER_OTLP_TRACES_ENDPOINT variable, specify the base endpoint URL where traces are to be exported to. The CloudWatch agent exposes 4316 as its OTLP port. On Amazon EC2, because applications communicate with the local CloudWatch agent, you should set this value to OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:4316/v1/ traces • For the OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT variable, specify the base endpoint URL where metrics are to be exported to. The CloudWatch agent exposes 4316 as its OTLP port. On Amazon EC2, because applications communicate with the local CloudWatch agent, you should set this value to OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT=http:// localhost:4316/v1/metrics • For the JAVA_TOOL_OPTIONS variable, specify the path where the AWS Distro for OpenTelemetry Java auto-instrumentation agent is stored. export JAVA_TOOL_OPTIONS=" -javaagent:$AWS_ADOT_JAVA_INSTRUMENTATION_PATH" For example: export AWS_ADOT_JAVA_INSTRUMENTATION_PATH=./aws-opentelemetry-agent.jar • For the OTEL_METRICS_EXPORTER variable, we recommend that you set the value to none. This disables other metrics exporters so that only the Application Signals exporter is used. Enable your applications on Amazon EC2 1350 Amazon CloudWatch User Guide • Set OTEL_AWS_APPLICATION_SIGNALS_ENABLED to true. This generates Application Signals metrics from traces. 3. Start your application with the environment variables listed in the previous step. The following is an example of a starting script. Note The following conﬁguration supports only versions 1.32.2 and later of the AWS
acw-ug-367	acw-ug.pdf	367	for OpenTelemetry Java auto-instrumentation agent is stored. export JAVA_TOOL_OPTIONS=" -javaagent:$AWS_ADOT_JAVA_INSTRUMENTATION_PATH" For example: export AWS_ADOT_JAVA_INSTRUMENTATION_PATH=./aws-opentelemetry-agent.jar • For the OTEL_METRICS_EXPORTER variable, we recommend that you set the value to none. This disables other metrics exporters so that only the Application Signals exporter is used. Enable your applications on Amazon EC2 1350 Amazon CloudWatch User Guide • Set OTEL_AWS_APPLICATION_SIGNALS_ENABLED to true. This generates Application Signals metrics from traces. 3. Start your application with the environment variables listed in the previous step. The following is an example of a starting script. Note The following conﬁguration supports only versions 1.32.2 and later of the AWS Distro for OpenTelemetry auto-instrumentation agent for Java. JAVA_TOOL_OPTIONS=" -javaagent:$AWS_ADOT_JAVA_INSTRUMENTATION_PATH" \ OTEL_METRICS_EXPORTER=none \ OTEL_LOGS_EXPORTER=none \ OTEL_AWS_APPLICATION_SIGNALS_ENABLED=true \ OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT=http://localhost:4316/v1/metrics \ OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf \ OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:4316/v1/traces \ OTEL_RESOURCE_ATTRIBUTES="service.name=$YOUR_SVC_NAME" \ java -jar $MY_JAVA_APP.jar 4. (Optional) To enable log correlation, in OTEL_RESOURCE_ATTRIBUTES, set an additional environment variable aws.log.group.names for the log groups of your application. By doing so, the traces and metrics from your application can be correlated with the relevant log entries from these log groups. For this variable, replace $YOUR_APPLICATION_LOG_GROUP with the log group names for your application. If you have multiple log groups, you can use an ampersand (&) to separate them as in this example: aws.log.group.names=log-group-1&log-group-2. To enable metric to log correlation, setting this current environmental variable is enough. For more information, see Enable metric to log correlation. To enable trace to log correlation, you'll also need to change the logging conﬁguration in your application. For more information, see Enable trace to log correlation. The following is an example of a starting script that helps enable log correlation. JAVA_TOOL_OPTIONS=" -javaagent:$AWS_ADOT_JAVA_INSTRUMENTATION_PATH" \ OTEL_METRICS_EXPORTER=none \ OTEL_LOGS_EXPORT=none \ Enable your applications on Amazon EC2 1351 Amazon CloudWatch User Guide OTEL_AWS_APPLICATION_SIGNALS_ENABLED=true \ OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT=http://localhost:4316/v1/metrics \ OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf \ OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:4316/v1/traces \ OTEL_RESOURCE_ATTRIBUTES="aws.log.group.names=$YOUR_APPLICATION_LOG_GROUP,service.name=$YOUR_SVC_NAME" \ java -jar $MY_JAVA_APP.jar Python Note If you're using a WSGI server for your Python application, in addition to the following steps in this section, see No Application Signals data for Python application that uses a WSGI server for information to make Application Signals work. To instrument your Python applications as part of enabling Application Signals on an Amazon EC2 instance 1. Download the latest version of the AWS Distro for OpenTelemetry Python auto- instrumentation agent. Install it by running the following command. pip install aws-opentelemetry-distro You can view information about all released versions at AWS Distro for OpenTelemetry Python instrumentation. 2. To optimize your Application Signals beneﬁts, use environment variables to provide additional information before you start your application. This information will be displayed in Application Signals dashboards. a. For the OTEL_RESOURCE_ATTRIBUTES variable, specify the following information as key-value pairs: • service.name sets the name of the service. This will be diplayed as the service name for your application in Application Signals dashboards. If you don't provide a value for this key, the default of UnknownService is used. Enable your applications on Amazon EC2 1352 Amazon CloudWatch User Guide • deployment.environment sets the environment that the application runs in. This will be diplayed as the Hosted In environment of your application in Application Signals dashboards. If you don't specify this, one of the following defaults is used: • If this is an instance that is part of an Auto Scaling group, it is set to ec2:name- of-Auto-Scaling-group. • If this is an Amazon EC2 instance that is not part of an Auto Scaling group, it is set to ec2:default • If this is an on-premises host, it is set to generic:default b. c. This attribute key is used only by Application Signals, and is converted into X-Ray trace annotations and CloudWatch metric dimensions. For the OTEL_EXPORTER_OTLP_PROTOCOL variable, specify http/protobuf to export telemetry data over HTTP to the CloudWatch agent endpoints listed in the following steps. For the OTEL_EXPORTER_OTLP_TRACES_ENDPOINT variable, specify the base endpoint URL where traces are to be exported to. The CloudWatch agent exposes 4316 as its OTLP port over HTTP. On Amazon EC2, because applications communicate with the local CloudWatch agent, you should set this value to OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:4316/v1/ traces d. For the OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT variable, specify the base endpoint URL where metrics are to be exported to. The CloudWatch agent exposes 4316 as its OTLP port over HTTP. On Amazon EC2, because applications communicate with the local CloudWatch agent, you should set this value to OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT=http:// localhost:4316/v1/metrics e. f. For the OTEL_METRICS_EXPORTER variable, we recommend that you set the value to none. This disables other metrics exporters so that only the Application Signals exporter is used. Set the OTEL_AWS_APPLICATION_SIGNALS_ENABLED variable to true to have your container start sending X-Ray traces and CloudWatch metrics to Application Signals. 3. Start your application with the environment variables discussed in the previous step. The following is an example of a starting script. Enable your applications on Amazon EC2 1353 Amazon CloudWatch User Guide • Replace $SVC_NAME with your application name.
acw-ug-368	acw-ug.pdf	368	local CloudWatch agent, you should set this value to OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT=http:// localhost:4316/v1/metrics e. f. For the OTEL_METRICS_EXPORTER variable, we recommend that you set the value to none. This disables other metrics exporters so that only the Application Signals exporter is used. Set the OTEL_AWS_APPLICATION_SIGNALS_ENABLED variable to true to have your container start sending X-Ray traces and CloudWatch metrics to Application Signals. 3. Start your application with the environment variables discussed in the previous step. The following is an example of a starting script. Enable your applications on Amazon EC2 1353 Amazon CloudWatch User Guide • Replace $SVC_NAME with your application name. This will be displayed as the name of the application, in Application Signals dashboards. • Replace $PYTHON_APP with the location and name of your application. OTEL_METRICS_EXPORTER=none \ OTEL_LOGS_EXPORTER=none \ OTEL_AWS_APPLICATION_SIGNALS_ENABLED=true \ OTEL_PYTHON_DISTRO=aws_distro \ OTEL_PYTHON_CONFIGURATOR=aws_configurator \ OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf \ OTEL_TRACES_SAMPLER=xray \ OTEL_TRACES_SAMPLER_ARG="endpoint=http://localhost:2000" \ OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT=http://localhost:4316/v1/metrics \ OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:4316/v1/traces \ OTEL_RESOURCE_ATTRIBUTES="service.name=$SVC_NAME" \ opentelemetry-instrument python $MY_PYTHON_APP.py Before you enable Application Signals for your Python applications, be aware of the following considerations. • In some containerized applications, a missing PYTHONPATH environment variable can sometimes cause the application to fail to start. To resolve this, ensure that you set the PYTHONPATH environment variable to the location of your application’s working directory. This is due to a known issue with OpenTelemetry auto-instrumentation. For more information about this issue, see Python autoinstrumentation setting of PYTHONPATH is not compliant. • For Django applications, there are additional required conﬁgurations, which are outlined in the OpenTelemetry Python documentation. • Use the --noreload ﬂag to prevent automatic reloading. • Set the DJANGO_SETTINGS_MODULE environment variable to the location of your Django application’s settings.py ﬁle. This ensures that OpenTelemetry can correctly access and integrate with your Django settings. 4. (Optional) To enable log correlation, in OTEL_RESOURCE_ATTRIBUTES, set an additional environment variable aws.log.group.names for the log groups of your application. By doing so, the traces and metrics from your application can be Enable your applications on Amazon EC2 1354 Amazon CloudWatch User Guide correlated with the relevant log entries from these log groups. For this variable, replace $YOUR_APPLICATION_LOG_GROUP with the log group names for your application. If you have multiple log groups, you can use an ampersand (&) to separate them as in this example: aws.log.group.names=log-group-1&log-group-2. To enable metric to log correlation, setting this current environmental variable is enough. For more information, see Enable metric to log correlation. To enable trace to log correlation, you'll also need to change the logging conﬁguration in your application. For more information, see Enable trace to log correlation. The following is an example of a starting script that helps enable log correlation. OTEL_METRICS_EXPORTER=none \ OTEL_LOGS_EXPORTER=none \ OTEL_AWS_APPLICATION_SIGNALS_ENABLED=true \ OTEL_PYTHON_DISTRO=aws_distro \ OTEL_PYTHON_CONFIGURATOR=aws_configurator \ OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf \ OTEL_TRACES_SAMPLER=xray \ OTEL_TRACES_SAMPLER_ARG="endpoint=http://localhost:2000" \ OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT=http://localhost:4316/v1/metrics \ OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:4316/v1/traces \ OTEL_RESOURCE_ATTRIBUTES="aws.log.group.names=$YOUR_APPLICATION_LOG_GROUP,service.name=$YOUR_SVC_NAME" \ java -jar $MY_PYTHON_APP.jar .NET To instrument your .NET applications as part of enabling Application Signals on an Amazon EC2 instance or on-premises host 1. Download the latest version of the AWS Distro for OpenTelemetry .NET auto- instrumentation package. You can download the latest version at aws-otel-dotnet- instrumentation Releases. 2. To enable Application Signals, set the following environment variables to provide additional information before you start your application. These variables are necessary to set up the startup hook for .NET instrumentation, before you start your .NET application. Replace dotnet-service-name in the OTEL_RESOURCE_ATTRIBUTES environment variable with the service name of your choice. Enable your applications on Amazon EC2 1355 Amazon CloudWatch User Guide • The following is an example for Linux. export INSTALL_DIR=OpenTelemetryDistribution export CORECLR_ENABLE_PROFILING=1 export CORECLR_PROFILER={918728DD-259F-4A6A-AC2B-B85E1B658318} export CORECLR_PROFILER_PATH=${INSTALL_DIR}/linux-x64/ OpenTelemetry.AutoInstrumentation.Native.so export DOTNET_ADDITIONAL_DEPS=${INSTALL_DIR}/AdditionalDeps export DOTNET_SHARED_STORE=${INSTALL_DIR}/store export DOTNET_STARTUP_HOOKS=${INSTALL_DIR}/net/ OpenTelemetry.AutoInstrumentation.StartupHook.dll export OTEL_DOTNET_AUTO_HOME=${INSTALL_DIR} export OTEL_DOTNET_AUTO_PLUGINS="AWS.Distro.OpenTelemetry.AutoInstrumentation.Plugin, AWS.Distro.OpenTelemetry.AutoInstrumentation" export OTEL_RESOURCE_ATTRIBUTES=service.name=dotnet-service-name export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf export OTEL_EXPORTER_OTLP_ENDPOINT=http://127.0.0.1:4316 export OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT=http://127.0.0.1:4316/ v1/metrics export OTEL_METRICS_EXPORTER=none export OTEL_AWS_APPLICATION_SIGNALS_ENABLED=true export OTEL_TRACES_SAMPLER=xray export OTEL_TRACES_SAMPLER_ARG=http://127.0.0.1:2000 • The following is an example for Windows Server. $env:INSTALL_DIR = "OpenTelemetryDistribution" $env:CORECLR_ENABLE_PROFILING = 1 $env:CORECLR_PROFILER = "{918728DD-259F-4A6A-AC2B-B85E1B658318}" $env:CORECLR_PROFILER_PATH = Join-Path $env:INSTALL_DIR "win-x64/ OpenTelemetry.AutoInstrumentation.Native.dll" $env:DOTNET_ADDITIONAL_DEPS = Join-Path $env:INSTALL_DIR "AdditionalDeps" $env:DOTNET_SHARED_STORE = Join-Path $env:INSTALL_DIR "store" $env:DOTNET_STARTUP_HOOKS = Join-Path $env:INSTALL_DIR "net/ OpenTelemetry.AutoInstrumentation.StartupHook.dll" $env:OTEL_DOTNET_AUTO_HOME = $env:INSTALL_DIR Enable your applications on Amazon EC2 1356 Amazon CloudWatch User Guide $env:OTEL_DOTNET_AUTO_PLUGINS = "AWS.Distro.OpenTelemetry.AutoInstrumentation.Plugin, AWS.Distro.OpenTelemetry.AutoInstrumentation" $env:OTEL_RESOURCE_ATTRIBUTES = "service.name=dotnet-service-name" $env:OTEL_EXPORTER_OTLP_PROTOCOL = "http/protobuf" $env:OTEL_EXPORTER_OTLP_ENDPOINT = "http://127.0.0.1:4316" $env:OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT = "http://127.0.0.1:4316/ v1/metrics" $env:OTEL_METRICS_EXPORTER = "none" $env:OTEL_AWS_APPLICATION_SIGNALS_ENABLED = "true" $env:OTEL_TRACES_SAMPLER = "xray" $env:OTEL_TRACES_SAMPLER_ARG = "http://127.0.0.1:2000" 3. Start your application with the environment variables listed in the previous step. (Optional) Alternatively, you can use the installation scripts provided to help installation and setup of AWS Distro for OpenTelemetry .NET auto-instrumentation package. For Linux, download and install the Bash installation script from the GitHub releases page: # Download and Install curl -L -O https://github.com/aws-observability/aws-otel-dotnet-instrumentation/ releases/latest/download/aws-otel-dotnet-install.sh chmod +x ./aws-otel-dotnet-install.sh ./aws-otel-dotnet-install.sh # Instrument . $HOME/.otel-dotnet-auto/instrument.sh export OTEL_RESOURCE_ATTRIBUTES=service.name=dotnet-service-name For Windows Server, download and install the PowerShell installation script from the GitHub releases page: # Download and Install $module_url = "https://github.com/aws-observability/aws-otel-dotnet- instrumentation/releases/latest/download/AWS.Otel.DotNet.Auto.psm1" $download_path = Join-Path $env:temp "AWS.Otel.DotNet.Auto.psm1" Invoke-WebRequest -Uri $module_url -OutFile $download_path Import-Module $download_path Install-OpenTelemetryCore Enable your applications
acw-ug-369	acw-ug.pdf	369	variables listed in the previous step. (Optional) Alternatively, you can use the installation scripts provided to help installation and setup of AWS Distro for OpenTelemetry .NET auto-instrumentation package. For Linux, download and install the Bash installation script from the GitHub releases page: # Download and Install curl -L -O https://github.com/aws-observability/aws-otel-dotnet-instrumentation/ releases/latest/download/aws-otel-dotnet-install.sh chmod +x ./aws-otel-dotnet-install.sh ./aws-otel-dotnet-install.sh # Instrument . $HOME/.otel-dotnet-auto/instrument.sh export OTEL_RESOURCE_ATTRIBUTES=service.name=dotnet-service-name For Windows Server, download and install the PowerShell installation script from the GitHub releases page: # Download and Install $module_url = "https://github.com/aws-observability/aws-otel-dotnet- instrumentation/releases/latest/download/AWS.Otel.DotNet.Auto.psm1" $download_path = Join-Path $env:temp "AWS.Otel.DotNet.Auto.psm1" Invoke-WebRequest -Uri $module_url -OutFile $download_path Import-Module $download_path Install-OpenTelemetryCore Enable your applications on Amazon EC2 1357 Amazon CloudWatch # Instrument User Guide Import-Module $download_path Register-OpenTelemetryForCurrentSession -OTelServiceName "dotnet-service-name" Register-OpenTelemetryForIIS You can ﬁnd the NuGet package of the AWS Distro for OpenTelemetry .NET auto- instrumentation package in the oﬃcial NuGet repository. Be sure to check the README ﬁle for instructions. Node.js Note If you are enabling Application Signals for a Node.js application with ESM, see Setting up a Node.js application with the ESM module format before you start these steps. To instrument your Node.js applications as part of enabling Application Signals on an Amazon EC2 instance 1. Download the latest version of the AWS Distro for OpenTelemetry JavaScript auto- instrumentation agent for Node.js. Install it by running the following command. npm install @aws/aws-distro-opentelemetry-node-autoinstrumentation You can view information about all released versions at AWS Distro for OpenTelemetry JavaScript instrumentation. 2. To optimize your Application Signals beneﬁts, use environment variables to provide additional information before you start your application. This information will be displayed in Application Signals dashboards. a. For the OTEL_RESOURCE_ATTRIBUTES variable, specify the following information as key-value pairs: • service.name sets the name of the service. This will be diplayed as the service name for your application in Application Signals dashboards. If you don't provide a value for this key, the default of UnknownService is used. Enable your applications on Amazon EC2 1358 Amazon CloudWatch User Guide • deployment.environment sets the environment that the application runs in. This will be diplayed as the Hosted In environment of your application in Application Signals dashboards. If you don't specify this, one of the following defaults is used: • If this is an instance that is part of an Auto Scaling group, it is set to ec2:name- of-Auto-Scaling-group. • If this is an Amazon EC2 instance that is not part of an Auto Scaling group, it is set to ec2:default • If this is an on-premises host, it is set to generic:default b. c. This attribute key is used only by Application Signals, and is converted into X-Ray trace annotations and CloudWatch metric dimensions. For the OTEL_EXPORTER_OTLP_PROTOCOL variable, specify http/protobuf to export telemetry data over HTTP to the CloudWatch agent endpoints listed in the following steps. For the OTEL_EXPORTER_OTLP_TRACES_ENDPOINT variable, specify the base endpoint URL where traces are to be exported to. The CloudWatch agent exposes 4316 as its OTLP port over HTTP. On Amazon EC2, because applications communicate with the local CloudWatch agent, you should set this value to OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:4316/v1/ traces d. For the OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT variable, specify the base endpoint URL where metrics are to be exported to. The CloudWatch agent exposes 4316 as its OTLP port over HTTP. On Amazon EC2, because applications communicate with the local CloudWatch agent, you should set this value to OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT=http:// localhost:4316/v1/metrics e. f. For the OTEL_METRICS_EXPORTER variable, we recommend that you set the value to none. This disables other metrics exporters so that only the Application Signals exporter is used. Set the OTEL_AWS_APPLICATION_SIGNALS_ENABLED variable to true to have your container start sending X-Ray traces and CloudWatch metrics to Application Signals. 3. Start your application with the environment variables discussed in the previous step. The following is an example of a starting script. Enable your applications on Amazon EC2 1359 Amazon CloudWatch User Guide • Replace $SVC_NAME with your application name. This will be displayed as the name of the application, in Application Signals dashboards. OTEL_METRICS_EXPORTER=none \ OTEL_LOGS_EXPORTER=none \ OTEL_AWS_APPLICATION_SIGNALS_ENABLED=true \ OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf \ OTEL_TRACES_SAMPLER=xray \ OTEL_TRACES_SAMPLER_ARG="endpoint=http://localhost:2000" \ OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT=http://localhost:4316/v1/metrics \ OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:4316/v1/traces \ OTEL_RESOURCE_ATTRIBUTES="service.name=$SVC_NAME" \ node --require '@aws/aws-distro-opentelemetry-node-autoinstrumentation/ register' your-application.js 4. (Optional) To enable log correlation, in OTEL_RESOURCE_ATTRIBUTES, set an additional environment variable aws.log.group.names for the log groups of your application. By doing so, the traces and metrics from your application can be correlated with the relevant log entries from these log groups. For this variable, replace $YOUR_APPLICATION_LOG_GROUP with the log group names for your application. If you have multiple log groups, you can use an ampersand (&) to separate them as in this example: aws.log.group.names=log-group-1&log-group-2. To enable metric to log correlation, setting this current environmental variable is enough. For more information, see Enable metric to log correlation. To enable trace to log correlation, you'll also need to change the logging conﬁguration in your application. For more information, see Enable trace to
acw-ug-370	acw-ug.pdf	370	doing so, the traces and metrics from your application can be correlated with the relevant log entries from these log groups. For this variable, replace $YOUR_APPLICATION_LOG_GROUP with the log group names for your application. If you have multiple log groups, you can use an ampersand (&) to separate them as in this example: aws.log.group.names=log-group-1&log-group-2. To enable metric to log correlation, setting this current environmental variable is enough. For more information, see Enable metric to log correlation. To enable trace to log correlation, you'll also need to change the logging conﬁguration in your application. For more information, see Enable trace to log correlation. The following is an example of a starting script that helps enable log correlation. export OTEL_METRICS_EXPORTER=none \ export OTEL_LOGS_EXPORTER=none \ export OTEL_AWS_APPLICATION_SIGNALS_ENABLED=true \ export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf \ export OTEL_TRACES_SAMPLER=xray \ export OTEL_TRACES_SAMPLER_ARG=endpoint=http://localhost:2000 \ export OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT=http://localhost:4316/v1/ metrics \ export OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:4316/v1/traces \ Enable your applications on Amazon EC2 1360 Amazon CloudWatch export User Guide OTEL_RESOURCE_ATTRIBUTES="aws.log.group.names=$YOUR_APPLICATION_LOG_GROUP,service.name=$SVC_NAME" \ node --require '@aws/aws-distro-opentelemetry-node-autoinstrumentation/ register' your-application.js Setting up a Node.js application with the ESM module format We provide limited support for Node.js applications with the ESM module format. For details, see the section called “Known limitations about Node.js with ESM”. To enable Application Signals for a Node.js application with ESM, you need to modify the steps in the previous procedure. First, install @opentelemetry/instrumentation for your Node.js application: npm install @opentelemetry/instrumentation@0.54.0 Then, in steps 3 and 4 in the previous procedure, change the node options from: --require '@aws/aws-distro-opentelemetry-node-autoinstrumentation/register' to the following: --import @aws/aws-distro-opentelemetry-node-autoinstrumentation/register -- experimental-loader=@opentelemetry/instrumentation/hook.mjs (Optional) Step 4: Monitor your application health Once you have enabled your applications on Amazon EC2, you can monitor your application health. For more information, see Monitor the operational health of your applications with Application Signals. Enable your applications on Amazon ECS Enable CloudWatch Application Signals on Amazon ECS by using the custom setup steps described in this section. Enable your applications on Amazon ECS 1361 Amazon CloudWatch User Guide For applications running on Amazon ECS, you install and conﬁgure the CloudWatch agent and AWS Distro for OpenTelemetry yourself. On these architectures enabled with a custom Application Signals setup, Application Signals doesn't autodiscover the names of your services or the hosts or clusters they run on. You must specify these names during the custom setup, and the names that you specify are what is displayed on Application Signals dashboards. Use a custom setup to enable Application Signals on Amazon ECS Use these custom setup instructions to onboard your applications on Amazon ECS to CloudWatch Application Signals. You install and conﬁgure the CloudWatch agent and AWS Distro for OpenTelemetry yourself. There are two methods for deploying Application Signals on Amazon ECS. Choose the one that is best for your environment. • Deploy using the sidecar strategy – You add a CloudWatch agent sidecar container to each task deﬁnition in the cluster. Advantages: • Supports both the ec2 and Fargate launch types. • You can always use localhost as the IP address when you set up environment variables. Disadvantages: • You must set up the CloudWatch agent sidecar container for each service task that runs in the cluster. • Only the awsvpc network mode is supported. • Deploy using the daemon strategy – You add a CloudWatch agent task only once in the cluster, and the Amazon ECS daemon scheduling strategy deploys it as needed. The ensures that each instance continuously receives traces and metrics, providing centralized visibility without the need for the agent to run as a sidecar with each application task deﬁnition. Advantages: • You need to set up the daemon service for the CloudWatch agent only once in the cluster. Disadvantages: • Doesn't support the Fargate launch type. • If you use the awsvpc or bridge network mode, you have to manually specify each container instance's private IP address in the environment variables. Enable your applications on Amazon ECS 1362 Amazon CloudWatch User Guide With either method, on Amazon ECS clusters Application Signals doesn't autodiscover the names of your services. You must specify your service names during the custom setup, and the names that you specify are what is displayed on Application Signals dashboards. Deploy using the sidecar strategy Step 1: Enable Application Signals in your account You must ﬁrst enable Application Signals in your account. If you haven't, see Enable Application Signals in your account. Step 2: Create IAM roles You must create an IAM role. If you already have created this role, you might need to add permissions to it. • ECS task role— Containers use this role to run. The permissions should be whatever your applications need, plus CloudWatchAgentServerPolicy. For more information about creating IAM roles, see Creating IAM Roles. Step 3: Prepare CloudWatch agent conﬁguration First, prepare the agent conﬁguration with Application Signals enabled. To do this, create a local ﬁle named /tmp/ecs-cwagent.json. { "traces": { "traces_collected":

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.