# Work with component configurations
A component configuration is a text file in JSON format that describes the configuration settings of the component. This section provides an example template fragment, descriptions of component configuration sections, and example component configurations.
**Topics**
+ [Template fragment](component-config-json.md)
+ [Sections](component-config-sections.md)
+ [Example configurations for relevant services](component-configuration-examples.md)
# Component configuration template fragment
The following example shows a template fragment in JSON format.
```
{
"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
}
]
}
```
# Component configuration sections
A component configuration includes several major sections. Sections in a component configuration can be listed in any order.
+ **alarmMetrics (optional)**
A list of [metrics](#component-config-metric) to monitor for the component. All component types can have an alarmMetrics section.
+ **logs (optional)**
A list of [logs](#component-configuration-log) to monitor for the component. Only EC2 instances can have a logs section.
+ **processes (optional)**
A list of [processes](#component-configuration-process) to monitor for the component. Only EC2 instances can have a processes section.
+ **subComponents (optional)**
Nested instance and volume subComponent configuration 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](#component-configuration-alarms) to monitor for the component. All component types can have an alarm section.
+ **windowsEvents (optional)**
A list of [windows events](#windows-events) to monitor for the component. Only Windows on EC2 instances have a `windowsEvents` section.
+ **JMXPrometheusExporter (optional)**
JMXPrometheus Exporter configuration.
+ **hanaPrometheusExporter (optional)**
SAP HANA Prometheus Exporter configuration.
+ **haClusterPrometheusExporter (optional)**
HA Cluster Prometheus Exporter configuration.
+ **netWeaverPrometheusExporter (optional) **
SAP NetWeaver Prometheus Exporter configuration.
+ **sapAsePrometheusExporter (optional)**
SAP ASE Prometheus Exporter configuration.
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 configuration section properties
This section describes the properties of each component configuration section.
**Topics**
+ [Metric](#component-config-metric)
+ [Log](#component-configuration-log)
+ [Process](#component-configuration-process)
+ [JMX Prometheus Exporter](#component-configuration-prometheus)
+ [HANA Prometheus Exporter](#component-configuration-hana-prometheus)
+ [HA Cluster Prometheus Exporter](#component-configuration-ha-cluster-prometheus)
+ [NetWeaver Prometheus Exporter](#component-configuration-netweaver-prometheus)
+ [SAP ASE Prometheus Exporter](#component-configuration-sap-ase-prometheus)
+ [Windows Events](#windows-events)
+ [Alarm](#component-configuration-alarms)
### Metric
Defines 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](appinsights-logs-and-metrics.md).
+ **monitor (optional)**
Boolean to indicate whether to monitor the metric. The default value is `true`.
### Log
Defines a log to be monitored for the component.
**JSON**
```
{
"logGroupName" : "logGroupName",
"logPath" : "logPath",
"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](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogGroup.html).
+ **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 file path. For more information, see [CloudWatch Agent Configuration File: Logs Section](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-Configuration-File-Details.html#CloudWatch-Agent-Configuration-File-Logssection).
+ **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`
+ `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 specified encoding should be included in the list of [CloudWatch agent supported encodings](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AgentReference.html). 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
Defines a process to be monitored for the component.
**JSON**
```
{
"processName" : "monitoredProcessName",
"alarmMetrics" : [
list of alarm metrics
]
}
```
**Properties**
+ **processName (required)**
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](#component-config-metric) to monitor for this process. To view process metrics supported by CloudWatch Application Insights, see [Amazon Elastic Compute Cloud (EC2)](appinsights-metrics-ec2.md).
### JMX Prometheus Exporter
Defines 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 specified.
+ **prometheusPort (optional)**
The target port to send Prometheus metrics to. If not specified, the default port 9404 is used.
### HANA Prometheus Exporter
Defines the HANA Prometheus Exporter settings.
**JSON**
```
"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 specified, the default port 9668 is used.
### HA Cluster Prometheus Exporter
Defines 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 specified, the default port 9664 is used.
### NetWeaver Prometheus Exporter
Defines the NetWeaver Prometheus Exporter settings.
**JSON**
```
"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 specified, the default port `9680` is used.
### SAP ASE Prometheus Exporter
Defines 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
}
```
**Properties**
+ **sapAseSid**
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 specified, the default port 9399 is used. If there is another ASE DB that is using the default port, then we use 9499.
### Windows Events
Defines 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](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogGroup.html).
+ **eventName (required)**
The type of Windows Events to log. It is equivalent to the Windows Event log channel name. For example, System, Security, CustomEventName, etc. This field 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 field 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
Defines 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 off.
# Component configuration examples
The following examples show component configurations in JSON format for relevant services.
**Topics**
+ [Amazon DynamoDB table](component-configuration-examples-dynamo.md)
+ [Amazon EC2 Auto Scaling (ASG)](component-configuration-examples-asg.md)
+ [Amazon EKS cluster](component-configuration-examples-eks-cluster.md)
+ [Amazon Elastic Compute Cloud (EC2) instance](component-configuration-examples-ec2.md)
+ [Amazon Elastic Container Service (Amazon ECS)](component-configuration-examples-ecs.md)
+ [Amazon ECS services](component-configuration-examples-ecs-service.md)
+ [Amazon ECS tasks](component-configuration-examples-ecs-task.md)
+ [Amazon Elastic File System (Amazon EFS)](component-configuration-examples-efs.md)
+ [Amazon FSx](component-configuration-examples-fsx.md)
+ [Amazon Relational Database Service (RDS) Aurora MySQL](component-configuration-examples-rds-aurora.md)
+ [Amazon Relational Database Service (RDS) instance](component-configuration-examples-rds.md)
+ [Amazon Route 53 health check](component-configuration-examples-health-check.md)
+ [Amazon Route 53 hosted zone](component-configuration-examples-hosted-zone.md)
+ [Amazon Route 53 Resolver endpoint](component-configuration-examples-resolver-endpoint.md)
+ [Amazon Route 53 Resolver query logging configuration](component-configuration-examples-resolver-query-logging.md)
+ [Amazon S3 bucket](component-configuration-examples-s3.md)
+ [Amazon Simple Queue Service (SQS)](component-configuration-examples-sqs.md)
+ [Amazon SNS topic](component-configuration-examples-sns.md)
+ [Amazon Virtual Private Cloud (Amazon VPC)](component-configuration-examples-vpc.md)
+ [Amazon VPC Network Address Translation (NAT) gateways](component-configuration-examples-nat-gateway.md)
+ [API Gateway REST API stages](component-configuration-examples-api-gateway.md)
+ [Application Elastic Load Balancing](component-configuration-examples-application-elb.md)
+ [AWS Lambda Function](component-configuration-examples-lambda.md)
+ [AWS Network Firewall rule group](component-configuration-examples-firewall-rule-group.md)
+ [AWS Network Firewall rule group association](component-configuration-examples-firewall-rule-group-assoc.md)
+ [AWS Step Functions](component-configuration-examples-step-functions.md)
+ [Customer-grouped Amazon EC2 instances](component-configuration-examples-grouped-ec2.md)
+ [Elastic Load Balancing](component-configuration-examples-elb.md)
+ [Java](component-configuration-examples-java.md)
+ [Kubernetes on Amazon EC2](component-configuration-examples-kubernetes-ec2.md)
+ [RDS MariaDB and RDS MySQL](component-configuration-examples-mysql.md)
+ [RDS Oracle](component-configuration-examples-oracle.md)
+ [RDS PostgreSQL](component-configuration-examples-rds-postgre-sql.md)
+ [SAP ASE on Amazon EC2](component-configuration-examples-sap-ase.md)
+ [SAP ASE High Availability on Amazon EC2](component-configuration-examples-sap-ase-ha.md)
+ [SAP HANA on Amazon EC2](component-configuration-examples-hana.md)
+ [SAP HANA High Availability on Amazon EC2](component-configuration-examples-hana-ha.md)
+ [SAP NetWeaver on Amazon EC2](component-configuration-examples-netweaver.md)
+ [SAP NetWeaver High Availability on Amazon EC2](component-configuration-examples-netweaver-ha.md)
+ [SQL Always On Availability Group](component-configuration-examples-sql.md)
+ [SQL failover cluster instance](component-configuration-examples-sql-failover-cluster.md)
# Amazon DynamoDB table
The following example shows a component configuration 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
},
{
"alarmMetricName": "WriteThrottleEvents",
"monitor": false
},
{
"alarmMetricName": "ConditionalCheckFailedRequests",
"monitor": false
},
{
"alarmMetricName": "TransactionConflict",
"monitor": false
}
],
"logs": []
}
```
# Amazon EC2 Auto Scaling (ASG)
The following example shows a component configuration 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"
}
],
"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"
}
]
}
```
# Amazon EKS cluster
The following example shows a component configuration 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",
"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
},
{
"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
}
]
},
{
"subComponentType":"AWS::AutoScaling::AutoScalingGroup",
"alarmMetrics":[
{
"alarmMetricName":"CPUCreditBalance",
"monitor":true
},
{
"alarmMetricName":"EBSIOBalance%",
"monitor":true
}
]
},
{
"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
}
]
}
]
}
```
**Note**
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 configuration 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 configuration is not saved.
```
{
"alarmMetrics" : [
{
"alarmMetricName" : "CPUUtilization",
"monitor" : true
}, {
"alarmMetricName" : "StatusCheckFailed"
}
],
"logs" : [
{
"logGroupName" : "my_log_group",
"logPath" : "C:\\LogFolder\\*",
"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"
}
],
"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 configuration 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
},
{
"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
},
{
"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":[
{
"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":[
"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 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 configuration in JSON format for an Amazon ECS service.
```
{
"alarmMetrics":[
{
"alarmMetricName":"CPUUtilization",
"monitor":true
},
{
"alarmMetricName":"MemoryUtilization",
"monitor":true
},
{
"alarmMetricName":"CpuUtilized",
"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",
"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":[
{
"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":[
"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 configuration in JSON format for an Amazon ECS task.
```
{
"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 configuration in JSON format for Amazon EFS.
```
{
"alarmMetrics": [
{
"alarmMetricName": "BurstCreditBalance",
"monitor": true
},
{
"alarmMetricName": "PercentIOLimit",
"monitor": true
},
{
"alarmMetricName": "PermittedThroughput",
"monitor": true
},
{
"alarmMetricName": "MeteredIOBytes",
"monitor": true
},
{
"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
},
{
"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 configuration in JSON format for Amazon FSx.
```
{
"alarmMetrics": [
{
"alarmMetricName": "DataReadBytes",
"monitor": true
},
{
"alarmMetricName": "DataWriteBytes",
"monitor": true
},
{
"alarmMetricName": "DataReadOperations",
"monitor": true
},
{
"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 configuration 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
}
]
}
```
# Amazon Relational Database Service (RDS) instance
The following example shows a component configuration 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 configuration in JSON format for Amazon Route 53 health check.
```
{
"alarmMetrics": [
{
"alarmMetricName": "ChildHealthCheckHealthyCount",
"monitor": true
},
{
"alarmMetricName": "ConnectionTime",
"monitor": true
},
{
"alarmMetricName": "HealthCheckPercentageHealthy",
"monitor": true
},
{
"alarmMetricName": "HealthCheckStatus",
"monitor": true
},
{
"alarmMetricName": "SSLHandshakeTime",
"monitor": true
},
{
"alarmMetricName": "TimeToFirstByte",
"monitor": true
}
]
}
```
# Amazon Route 53 hosted zone
The following example shows a component configuration 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
}
],
"logs": [
{
"logGroupName":"/hosted-zone/logs",
"logType": "ROUTE53_DNS_PUBLIC_QUERY_LOGS",
"monitor": true
}
]
}
```
# Amazon Route 53 Resolver endpoint
The following example shows a component configuration 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 configuration
The following example shows a component configuration in JSON format for Amazon Route 53 Resolver query logging configuration.
```
{
"logs": [
{
"logGroupName": "/resolver-query-log-config/logs",
"logType": "ROUTE53_RESOLVER_QUERY_LOGS",
"monitor": true
}
]
}
```
# Amazon S3 bucket
The following example shows a component configurations 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 configuration in JSON format for Amazon Simple Queue Service.
```
{
"alarmMetrics" : [
{
"alarmMetricName" : "ApproximateAgeOfOldestMessage"
}, {
"alarmMetricName" : "NumberOfEmptyReceives"
}
],
"alarms" : [
{
"alarmName" : "my_sqs_alarm",
"severity" : "MEDIUM"
}
]
}
```
# Amazon SNS topic
The following example shows a component configuration 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 configuration in JSON format for Amazon VPC.
```
{
"alarmMetrics": [
{
"alarmMetricName": "NetworkAddressUsage",
"monitor": true
},
{
"alarmMetricName": "NetworkAddressUsagePeered",
"monitor": true
},
{
"alarmMetricName": "VPCFirewallQueryVolume",
"monitor": true
}
]
}
```
# Amazon VPC Network Address Translation (NAT) gateways
The following example shows a component configuration 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 configuration in JSON format for API Gateway REST API stages.
```
{
"alarmMetrics" : [
{
"alarmMetricName" : "4XXError",
"monitor" : true
},
{
"alarmMetricName" : "5XXError",
"monitor" : true
}
],
"logs" : [
{
"logType" : "API_GATEWAY_EXECUTION",
"monitor" : true
},
{
"logType" : "API_GATEWAY_ACCESS",
"monitor" : true
}
]
}
```
# Application Elastic Load Balancing
The following example shows a component configuration 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",
}
],
"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 configuration in JSON format for AWS Lambda Function.
```
{
"alarmMetrics": [
{
"alarmMetricName": "Errors",
"monitor": true
},
{
"alarmMetricName": "Throttles",
"monitor": true
},
{
"alarmMetricName": "IteratorAge",
"monitor": true
},
{
"alarmMetricName": "Duration",
"monitor": true
}
],
"logs": [
{
"logType": "DEFAULT",
"monitor": true
}
]
}
```
# AWS Network Firewall rule group
The following example shows a component configuration 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 configuration in JSON format for AWS Network Firewall rule group association.
```
{
"alarmMetrics": [
{
"alarmMetricName": "FirewallRuleGroupQueryVolume",
"monitor": true
}
]
}
```
# AWS Step Functions
The following example shows a component configurations 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 configuration in JSON format for customer-grouped Amazon EC2 instances.
```
{
"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",
"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_alarm",
"severity": "MEDIUM"
}
]
}
```
# Elastic Load Balancing
The following example shows a component configuration 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",
"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 configuration in JSON format for Java.
```
{
"alarmMetrics": [ {
"alarmMetricName": "java_lang_threading_threadcount",
"monitor": true
},
{
"alarmMetricName": "java_lang_memory_heapmemoryusage_used",
"monitor": true
},
{
"alarmMetricName": "java_lang_memory_heapmemoryusage_committed",
"monitor": true
}],
"logs": [ ],
"JMXPrometheusExporter": {
"hostPort": "8686",
"prometheusPort": "9404"
}
}
```
**Note**
Application Insights does not support configuring authentication for Prometheus JMX exporter. For information about how to set up authentication, see the [Prometheus JMX exporter example configuration](https://github.com/prometheus/jmx_exporter#configuration).
# Kubernetes on Amazon EC2
The following example shows a component configuration 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
},
{
"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
},
{
"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
},
{
"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
}
]
}
]
},
{
"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
}
]
}
]
}
```
# RDS MariaDB and RDS MySQL
The following example shows a component configuration 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 configuration in JSON format for RDS Oracle.
```
{
"alarmMetrics": [
{
"alarmMetricName": "CPUUtilization",
"monitor": true
}
],
"logs": [
{
"logType": "ORACLE_ALERT",
"monitor": true,
},
{
"logType": "ORACLE_LISTENER",
"monitor": false
}
]
}
```
# RDS PostgreSQL
The following example shows a component configurations 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 configuration 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
},
{
"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"
}
],
"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 configuration 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
},
{
"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",
"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 configuration 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
},
{
"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"
}
}
```
# SAP HANA High Availability on Amazon EC2
The following example shows a component configuration 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,
"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 configuration 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
},
{
"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
},
{
"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": {
"sapSid": "ML4",
"instanceNumbers": [
"00",
"11"
],
"prometheusPort": "9680"
}
}
```
# SAP NetWeaver High Availability on Amazon EC2
The following example shows a component configuration 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
},
{
"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
},
{
"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//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"
}
}
```
# SQL Always On Availability Group
The following example shows a component configuration 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
}, {
"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" : "SQLServer:Database Replica Transaction Delay",
"monitor" : true
} ],
"windowsEvents" : [ {
"logGroupName" : "WINDOWS_EVENTS-Application-",
"eventName" : "Application",
"eventLevels" : [ "WARNING", "ERROR", "CRITICAL", "INFORMATION" ],
"monitor" : true
}, {
"logGroupName" : "WINDOWS_EVENTS-System-",
"eventName" : "System",
"eventLevels" : [ "WARNING", "ERROR", "CRITICAL" ],
"monitor" : true
}, {
"logGroupName" : "WINDOWS_EVENTS-Security-",
"eventName" : "Security",
"eventLevels" : [ "WARNING", "ERROR", "CRITICAL" ],
"monitor" : true
} ],
"logs" : [ {
"logGroupName" : "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP-",
"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
} ]
} ]
}
```
# SQL failover cluster instance
The following example shows a component configuration 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",
"monitor" : true
}, {
"alarmMetricName" : "Urgent Message Queue Length/se",
"monitor" : true
}, {
"alarmMetricName" : "Reconnect Count",
"monitor" : true
}, {
"alarmMetricName" : "Unacknowledged Message Queue Length/sec",
"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
}, {
"alarmMetricName" : "Cluster Handles/sec",
"monitor" : true
}, {
"alarmMetricName" : "Resource Handles/sec",
"monitor" : true
} ],
"windowsEvents" : [ {
"logGroupName" : "WINDOWS_EVENTS-Application-",
"eventName" : "Application",
"eventLevels" : [ "WARNING", "ERROR", "CRITICAL"],
"monitor" : true
}, {
"logGroupName" : "WINDOWS_EVENTS-System-",
"eventName" : "System",
"eventLevels" : [ "WARNING", "ERROR", "CRITICAL", "INFORMATION" ],
"monitor" : true
}, {
"logGroupName" : "WINDOWS_EVENTS-Security-",
"eventName" : "Security",
"eventLevels" : [ "WARNING", "ERROR", "CRITICAL" ],
"monitor" : true
} ],
"logs" : [ {
"logGroupName" : "SQL_SERVER_FAILOVER_CLUSTER_INSTANCE-",
"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
}, {
"alarmMetricName" : "VolumeQueueLength",
"monitor" : true
}, {
"alarmMetricName" : "VolumeThroughputPercentage",
"monitor" : true
}, {
"alarmMetricName" : "BurstBalance",
"monitor" : true
} ]
} ]
}
```