Configuring the Amazon Web Services monitor type

This topic provides information about configuring PATROL for Amazon Web Services. 

Based on the number of Amazon Web Services accounts that you plan to monitor, do one of the following actions:

  • Single account: If you plan to monitor a single account, create a policy and a user that is used for monitoring, and get the access key and secret key for this account. For more information, see
  • Multiple accounts: If you plan to monitor multiple accounts, monitor all these accounts by using a trusted or management account. To enable multi-account support, perform the following actions:
    1. Create a policy and a user for the primary account that will be used for monitoring, and get the access key and secret key and the account ID for this account.
    2. Configure multiple Amazon Web Services  accounts.
    3. Associate the primary account with the additional accounts.

For more information, see Prerequisites-for-configuring-AWS-instance.

With Amazon Web Services as the selected monitor type, the Add Monitor Types dialog box enables you to configure details for connecting to the accounts and web services provided by Amazon Web Services. For more information, see Defining-a-monitoring-policy.

Field

Details

AWS Monitoring Configuration

AWS Account Configuration

Account Name

Specify the name that identifies this set of AWS account monitoring configuration. This name is used as the instance name of the top level container.

Note: Special characters @ / \ are not supported in this field.

Access Key

Specify the access key for the account provided by Amazon Web Services account user.

Secret Key

Specify the secret key for the account provided by Amazon Web Services account user.

Note

Generate these keys for the user created on the Prerequisites-for-configuring-AWS-instance page.

When you are monitoring a GovCloud, you need to add an additional configuration key to point to a different endpoint. The additional key is /AWS/<Account Name>/IAMEndpoint and its value is iam.us-gov.amazonaws.com. The KM uses the AWS Identity and Access Management (IAM)service endpoint. You add the configuration key as a new variable on the Infrastructure Policy > Configuration Variables tab.

AWS Organization Configuration

Organization Management Account

If you are configuring monitoring with a management account, select the check box.

Ensure that you perform the pre-requisites and enter the management account in the Account Name field. 

Assume Role Name

Enter the role name that is common to all member accounts and the management account.

Account Filter Configuration

Account Filter Type

Select if you want to configure account filters to be included or excluded from monitoring.

Accounts Filter

Enter a comma-separated list of the account IDs that you want to include or exclude from monitoring.

Proxy Server Configuration

Use Proxy Configuration

Select the check box to enable the proxy configuration.

Server Name

Specify the proxy server name to route HTTP requests. If you select the Use Proxy Configuration check box, this field is mandatory.

Port

Specify the proxy server port number to connect to the specified proxy server. If you select the Use Proxy Configuration check box, this field is mandatory.

Proxy Server Authentication (Optional)

Click this tab to configure the proxy authentication. It is optional to add username and password to access the proxy server.

Username

Specify the proxy server username that is being used to log in.

Password

Specify the proxy server password that is being used to log in.

Select Services

Click this tab to enable or disable the services. The Elastic Compute Cloud (EC2), Elastic Block Storage (EBS), Elastic Load Balancer are monitored by default.

Analytics

Elasticsearch

Select the Elasticsearch service for monitoring.

EMR

Select the EMR service for monitoring.

Kafka

Select the Kafka service for monitoring.

Kinesis Data Analytics

Select the Kinesis Data Analytics service for monitoring.

Kinesis Data Firehose

Select the Kinesis Data Firehose service for monitoring.

Kinesis Data Stream

Select the Kinesis Data Stream service for monitoring.

Kinesis Video Stream

Select the Kinesis Video Stream service for monitoring.

Redshift

Select the Redshift service for monitoring.

Application Integration

Simple Notification Service

Select the Simple Notification service for monitoring.

Simple Queue Service

Select the Simple Queue service for monitoring.

Compute

EC2, EBS, ELB

Clear the check box to stop monitoring EC2, EBS, and ELB services.

Elastic Beanstalk

Select the Elastic Beanstalk service for monitoring.

Lambda

Select the Lambda service for monitoring.

Containers

Elastic Container Service

Select the Elastic Container service for monitoring.

Elastic Kubernetes Service

Select the Elastic Kubernetes service for monitoring.

Enable Container Insights Metrics

Elastic Container Services

Enable monitoring of ECS Container Insights metrics.

Elastics Kubernetes Services

Enable monitoring of EKS Container Insights metrics.

Databases

DocumentDB

Select the DocumentDB service for monitoring.

DynamoDB

Select the DynamoDB service for monitoring.

ElastiCache

Select the ElastiCache service for monitoring.

Relational Database Service

Select the Relational Database service for monitoring.

Developer Tools

CodeBuild

Select the CodeBuild service for monitoring.

Internet of Things

IoT

Select the IoT service for monitoring.

Management and Governance

Auto Scaling

Select the AutoScaling service for monitoring.

OpsWorks

Select the OpsWorks service for monitoring.

Networking and Content Delivery

API Gateway

Select the API Gateway service for monitoring.

CloudFront

Select the CloudFront service for monitoring.

Route 53

Select the Route 53 service for monitoring.

VPC Availability

Select the VPC Availability service for monitoring.

VPC Virtual Private Network

Select the VPC virtual private network service for monitoring.

VPC Transit Gateway

Select the VPC transit gateway service for monitoring.

Security, Identity, and Compliance

CloudHSM

Select the CloudHSM service for monitoring.

Web Application Firewall

Select the Web Application Firewall service for monitoring.

Storage

Elastic File System

Select the Elastic File System service for monitoring.

Simple Storage Service

Select the Simple Storage service for monitoring.

Storage Gateway

Select the Storage Gateway service for monitoring.

Custom Metric Configuration

Custom Metrics

Select the check box to enable the monitoring of Custom Metrics.

Note

To configure custom metrics to monitor Linux EC2 metrics, see Use-case-for-Custom-Metric-Configuration-to-monitor-Linux-EC2-metrics.


Custom Metric Configuration

Custom Metric Details

Note

  • After a valid custom metric configuration, PATROL Agent gets restarted automatically.
  • If you do not want PATROL Agent to be restarted automatically, set the following configuration variable to 0:
    /AWS/<ACCOUNT_NAME>/AgentRestartFlag  = 0


Metric Configuration Label

Specify a unique configuration label to identify the set of Custom Metric Configuration. This configuration label is used as an instance name of namespace. Special characters like /, @, &, and \ are not allowed.

For example: MyCustomMetric, My_CustomMetric

Namespace Name

Specify the name of AWS Namespace from which the custom metrics are monitored.

For example: System/mynamespace

Dimension Name

Specify the dimension names having a unique value and which can distinguish metrics of different entities. You can add multiple dimensions separated by a comma.

For example: In the AWS/RDS Namespace, you can enter one or two dimensions to identify different RDS instances:

  • Single dimension - EngineName
  • Multiple dimensions - EngineName,DbClusterIdentifier

Note

The KM monitors the custom metrics that have unique dimensions. For example: DbClusterIdentifier in the case of AWS/RDS.

Statistics Type

Select the statistics type from the following to bring performance data of custom metrics:

  • Average
  • Sum
  • Minimum
  • Maximum

Period (Minutes)

Specify the period in minutes. A period is the length of time associated with a specific Amazon CloudWatch statistic.
Each statistic represents an aggregation of the metrics data collected for a specified period.

Exclude Dimension Filter

Specify the value of dimension that you want to exclude from monitoring. The dimension value should match with the dimension value in AWS management console or a regex matching one or more dimension values.

Exclude Metric Filter

Specify the metric name that you want to exclude from monitoring. The metric name should match with the metric name in AWS management console or a regex matching one or more metric names.
For example: Metric.* or Metric1|Metric2

Filter Configuration

Region Filter Type

Select if you want to configure AWS regions to be included or excluded from monitoring.

Regions Filter

Enter a comma-separated list of the regions that you want to include or exclude from monitoring. The following is the format for specifying regions:

us-east-1,us-west-2,us-east-2

EC2 Tag Filter Type

Select if you want to configure EC2 instances that have tags to be included or excluded from monitoring.

EC2 Tag Filter

Enter a comma-separated list of the EC2 tags key-value pairs (TagKey=TagValue) that you want to include or exclude from monitoring.

Lambda Filter Type

Select if you want to configure lambda functions to be included or excluded from monitoring.

Lambda Filter

Enter a comma-separated list of the lambda functions that you want to include or exclude from monitoring. You can also enter regular expressions.

Monitor Lambda Custom Metrics

Select this check box to enable lambda function log monitoring for custom metrics.

Note

  • To monitor Lambda function custom metrics, it is recommended to use the following format in the AWS Lambda function log:
    LOGMON|<CUSTOM_METRIC_NAME>|<CUSTOM_METRIC_VALUE>
  • To find the custom metric name and metric value, it searches AWS Lambda function logs for the following string:
    LOGMON|metricname|metricvalue
    Metricname     represents the name of the metric. It should not have any spaces and special characters. For example: TestAWS, Amazon
    Metricvalue represents the value of the metric. It should be any integer or float value. For example: 101, 21.0

For example:

LOGMON|CustomMetric1|768

By default, the Lambda custom metrics monitoring is disabled. You can enable the Lambda custom metrics monitoring by enabling the Monitor Lambda Custom Metrics check box in Central Monitoring Administration, TrueSight console, and BMC Helix Operations Management.

Filter Service Instances by Tag

Click Add to filter service instances by their tags to be included or excluded from monitoring.

Service Tag Filter

Select the service that you want to monitor.

Filter Type

Select if you want to configure service instances that have tags to be included or excluded from monitoring.
Note: If you select EC2 and enter the EC2 tags key-value pairs (TagKey=TagValue) in the Tag Filter field, the value that you enter in the EC2 Tag Filter field is not considered.

Tag Filter

Enter a comma-separated list of the service tags key-value pairs (TagKey=TagValue) that you want to include or exclude from monitoring. Example: network=apac*,name=retail*

Administration

JVM Arguments

Enter additional Java (JVM) arguments.

Device Mapping

Device mapping is enabled by default and devices are created for each monitored EC2 instance on the Monitoring > Devices page. It saves you extra clicks to navigate the PATROL Agent hierarchy while viewing monitoring results.

Note: Device mapping is supported only for EC2 instances.

If you disable device mapping, all monitored EC2 instances are displayed under the PATROL Agent on the Devices page.

Select the check box to disable device mapping.

Device Mapping Type

Select how you want to create the device. The following options are available:

  • Private DNS (Private IPv4 address): device is created with the private DNS of the EC2 instance.
  • Public DNS (Public IPv4 address): device is created with the public DNS of the EC2 instance.
  • Instance ID: device is created with the instance ID of the EC2 instance.
  • Name Tag: device is created with the name tag used for the EC2 instance. You add Name Tag on EC2 console in your AWS environment.

If the option that you select has no value, a separate device is not created and the monitored information is shown under the PATROL Agent hierarchy.

Administration

Java Home

Specify the full path of JRE directory on the PATROL Agent server.

Enable Debug

Enable Debug

Select the check-box to enable debug. Log files are created in the <PATROL_HOME>/aws directory on the PATROL Agent server.

For example:

RemoteCollector-<PATROL_AGENT_PORT>-<environment name>-aws.log

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*