Configuring the Amazon EC2 monitor type

This topic provides information about configuring PATROL for Amazon EC2 KM in the Central Monitoring Administration and TrueSight console. To configure the KM, set the following preferences on the Add Monitoring Configuration dialog.

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-Amazon-EC2-instance.

With Amazon EC2 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 EC2. For more information, see Defining-a-monitoring-policy.

Field

Instructions

Amazon EC2 Monitoring Configuration

Administration

JAVA Home

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

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: Do not use special characters like (@), slash mark (/) in the Account Name field.

Access Key

Specify the access key for the account provided by Amazon EC2 account user.

Secret Key

Specify the secret key for the account provided by Amazon EC2 account user.

Note

Generate these keys for the user created on the Prerequisites-for-configuring-Amazon-EC2-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 following enter the management account in the Account Name field and perform the 

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/disable the services.

Note

The services like Elastic Compute Cloud (EC2), Elastic Block Storage (EBS), Elastic Load Balancer (ELB) are monitored by default. 

Elasticache

Select the check box to enable the monitoring of Elasticache.

Auto Scaling

Select the check box to enable the monitoring of Auto Scaling.

Route 53

Select the check box to enable the monitoring of Route 53.

Filter Configuration

Region Filter Type

Select Include to monitor only the regions mentioned in the Regions field below.

Select Exclude to exclude the regions mentioned in the Regions field below.

Regions Filter

Specify 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

Use comma (,) only to separate the regions.

EC2 Tag Filter Type

Select Include to monitor only the EC2 tags mentioned in the EC2 Tag Filter field below.

Select Exclude to exclude the EC2 tags mentioned in the EC2 Tag Filter field below.

EC2 Tag Filter

Specify the EC2 tags that you want to include or exclude from monitoring. The following is the format for EC2 tags:

  • TagKey=TagValue

Use comma (,) only to separate the tags.

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

By default, when device mapping is disabled, all monitored EC2 instances are displayed under the PATROL Agent on the Monitoring > Devices page. When device mapping is enabled, a device is created for each monitored EC2 instance on the Devices page. It saves you extra clicks to navigate the PATROL Agent hierarchy while viewing monitoring results.

Select the check box to enable device mapping. Device mapping is enabled only for EC2 instances of your AWS environment.

Device Mapping Type

Select how you want to generate the name of the device. The following options are available:

  • Private DNS (Private IPv4 address): device name is generated with the private DNS of the EC2 instance.
  • Public DNS (Public IPv4 address): device name is generated with the public DNS of the EC2 instance.
  • Instance ID: device name is generated with the instance ID of the EC2 instance.
  • Name Tag: device name is generated 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.

Enable Debug

Enable Debug

Select the check-box to enable debug. This will create log files at <PATROL_HOME>/pll directory on the PATROL Agent server.

For example:

RemoteCollector-<PATROL_AGENT_PORT>-aws.log

 

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