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 SolutionMonitoring ProfileMonitor Type
Amazon Web ServicesAmazon Web ServicesAmazon 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

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) Open link service endpoint. You add the configuration key as a new variable on the Infrastructure Policy > Configuration Variables tab.

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

 https://youtu.be/7YJ6XtkhBnA

Proxy Server Configuration
Use Proxy ConfigurationSelect the check box to enable the proxy configuration.
Server NameSpecify the proxy server name to route HTTP requests. If you select the Use Proxy Configuration check box, this field is mandatory.
PortSpecify 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.
UsernameSpecify the proxy server username that is being used to log in.
PasswordSpecify 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
ElasticsearchSelect the Elasticsearch service for monitoring.
EMRSelect the EMR service for monitoring.
KafkaSelect the Kafka service for monitoring.
RedshiftSelect the Redshift service for monitoring.
Application Integration
Simple Notification ServiceSelect the Simple Notification service for monitoring.
Simple Queue ServiceSelect the Simple Queue service for monitoring.
Compute
LambdaSelect the Lambda service for monitoring.
Containers
Elastic Container ServiceSelect the Elastic Container service for monitoring.
Elastic Kubernetes ServiceSelect the Elastic Kubernetes service for monitoring.
Databases
DocumentDBSelect the DocumentDB service for monitoring.
DynamoDBSelect the DynamoDB service for monitoring.
ElastiCacheSelect the ElastiCache service for monitoring.
Relational Database ServiceSelect the Relational Database service for monitoring.
Internet of Things
IoTSelect the IoT service for monitoring.
Management and Governance
Auto ScalingSelect the AutoScaling service for monitoring.
OpsWorksSelect the OpsWorks service for monitoring.
Networking and Content Delivery
API GatewaySelect the API Gateway service for monitoring.
CloudFrontSelect the CloudFront service for monitoring.
Route 53Select the Route 53 service for monitoring.
VPC AvailabilitySelect the VPC Availability service for monitoring.
VPC Virtual Private NetworkSelect the VPC virtual private network service for monitoring.
VPC Transit GatewaySelect the VPC transit gateway service for monitoring.
Security, Identity, and Compliance
CloudHSMSelect the CloudHSM service for monitoring.
Web Application FirewallSelect the Web Application Firewall service for monitoring.
Storage
Elastic File SystemSelect the Elastic File System service for monitoring.
Simple Storage ServiceSelect the Simple Storage service for monitoring.
Storage GatewaySelect 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 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


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

https://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 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 FilterSpecify 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 TagClick Add to filter service instances by their tags to be included or excluded from monitoring.
Service Tag FilterSelect the service that you want to monitor.
Filter TypeSelect 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 FilterEnter 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 ArgumentsEnter 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

Was this page helpful? Yes No Submitting... Thank you

Comments