Configuring the Amazon Web Services monitor type

This topic provides information about configuring PATROL for Amazon Web Services KM. To configure the KM, set the following preferences on the Add Monitoring Configuration screen.

Monitoring Solution

Monitoring Profile

Monitor Type

Amazon Web Services

Amazon Web Services

Amazon Web Services

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

Instructions

Amazon Web Services 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: 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.

Click to view a short video on how to create user policy in Amazon Web Services console.

Note

These keys are generated from the AWS console. Also, see Prerequisites-for-configuring-AWS-instance. 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.


icon-play.png https://youtu.be/7YJ6XtkhBnA

Proxy Server Configuration

Click this tab to configure the proxy server.

Use Proxy Configuration

Select the check box to enable the proxy configuration.

Server Name

Specify the proxy server name that is being used to route HTTP requests.

Port

Specify the proxy server port number that is being used to connect specified proxy server.

User Name

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. 

Relational Database Service (RDS)

Select the check box to enable the monitoring of Relational Database Service (RDS) for the specified account.

Simple Notification Service (SNS)

Select the check box to enable the monitoring of Simple Notification Service (SNS) for the specified account.

Simple Queue Service (SQS)

Select the check box to enable the monitoring of Simple Queue Service (SQS).

Elasticache

Select the check box to enable the monitoring of Elasticache.

Lambda

Select the check box to enable the monitoring of Lambda metrics.

DynamoDB

Select the check box to enable the monitoring of DynamoDB.

Redshift

Select the check box to enable the monitoring of Redshift.

API Gateway

Select the check box to enable the monitoring of API Gateway.

IoT

Select the check box to enable the monitoring of IoT.

CloudFront

Select the check box to enable the monitoring of CloudFront.

Auto Scaling

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

Simple Storage Service (S3)

Select the check box to enable the monitoring of Simple Storage Service (S3).

Route 53

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

OpsWorks

Select the check box to enable the monitoring of OpsWorks.

EMR

Select the check box to enable the monitoring of EMR.

Storage Gateway

Select the check box to enable the monitoring of Storage Gateway.

Elastic File System

Select this option to monitor your Amazon elastic file systems.

Elastic Container Service

Select this option to monitor your elastic containers.

Web Application Firewall

Select this option to monitor your web application firewalls.

Cloud HSM

Select this option to monitor data of your cloud HSM devices in the AWS cloud.

Document DB

Select this option to monitor data of your document databases.

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 Custom metric configuration to monitor Linux EC2 metrics.


Custom Metric Configuration

Custom Metric Details

 Click to view a short video on how to configure Custom CloudWatch metrics in TrueSight console.

icon-play.pnghttps://youtu.be/i22_Pn0wGeE

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 name having a unique value and which can distinguish metric of different entities.
For example: In AWS EC2, InstanceId dimension is used to identify different EC2 instances.

Note

The KM monitors the Custom Metrics that have unique dimension. For example: InstanceId in the case of EC2.

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

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

Filter Configuration

Click this tab to enable filtering options.

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

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.

Lambda Function Filter Type

Select Include to monitor only the Lambda functions mentioned in the Lambda function filter.

Select Exclude to exclude the Lambda functions mentioned in the Lambda function filter.

Lambda Function Filter

Specify the lambda function name that you want to include or exclude from monitoring. Use comma (,) only to separate the functions.

It supports regex pattern.

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.

Add to List

Click this option to add the account to the list of monitored accounts.

Modify Selection

Click this option to save the changes you made in the configuration details for the selected account. After doing this, click Update to reflect your changes under the list of Defined Monitor Types and Attributes on the Monitor Configuration tab.

This option is only available when you select an existing policy and click Edit on the Monitor Configuration tab.

Remove from List

Click this option to remove the account from the list of monitored accounts.

This option is only available when you select an existing policy and click Edit or Delete on the Monitor Configuration tab.

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

Add

Click this option to add the monitor type under the list of Defined Monitor Types and Attributes on the Monitor Configuration tab

Close 

Click this option to close the Add Monitor Types dialog box without saving any changes

Reset

Click this option to clear off your configuration and revert to default settings

 

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