IPF Standard - CloudWatch Agent Configuration (2023-06-22).docx
DOCX document 33 KB Posted
- Solicitation number
- HM047625R0016_Bidder_Library
About this file
This is a technical configuration standard document that defines the standardized deployment and operation of CloudWatch Agent on EC2 instances within an Integrated Processing Facility (IPF) environment. The document establishes baseline metrics collection requirements applicable across all systems, programs, and AWS accounts, with the primary objectives of using generic naming conventions, minimizing console dimension visibility, eliminating metric duplication, and implementing a consistent 300-second reporting frequency.
The baseline configuration mandates that all EC2 instances collect two minimum metrics: Memory Usage Percent (renamed as "Mem_Used_Percent") and Disk Space Usage Percent (renamed as "Disk_Used_Percent"), with every mounted disk or partition included unless metrics are not needed. All metrics must be collected within the "CWAgent" namespace with InstanceId appended as a dimension. Configurations must be stored in Systems Manager Parameter Store using descriptive parameter names that identify the configuration purpose, target operating system, and version number (e.g., CWAgent_Base_Linux_2023-01-01 or CWAgent_Base_Windows_2023-01-01). The standard supports Linux and Windows operating systems, with separate JSON baseline configurations provided for each. Additional custom metrics may be implemented through separate, purpose-driven configuration files applied with the append option, while maintaining uniform baseline configuration across all IPF instances. The document references AWS CloudWatch monitoring documentation and was established as of June 22, 2023.
View the file
Other files
Show 40 more
Latest 50 of 80 listed here. See the rest on GovTribe.
On GovTribe
Work with this file
- Download the original file
- Contacts named in this file
- Similar government files
- Ask GovTribe AI about this file
Text version
UNCLASSIFIED
IPF Standard CloudWatch Agent Configuration 2023-06-22 Purpose This document defines the configuration of CloudWatch Agent on EC2 instances. A minimum set of metrics is identified here and should not be considered as a maximum set. Use of additional metrics is encouraged on an as-needed basis on a per-program level.
This CloudWatch (CW) Agent standard was developed with the intent that:
· Uses generic names that are applicable to any system, program, or AWS account
· Minimizes dimension collections visible in the console
· Does not duplicate the same metric into multiple namespaces or dimension collections
· Renames metrics so that they do not contain special characters and are consistent across different operating systems
· Uses a reporting frequency that meets the need but is not excessive. Initially, the value will be 300 seconds. In the future, we may choose to use a longer interval which will reduce the metrics cost.
Resources:
https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Install-CloudWatch-Agent.html https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html Standard for CloudWatch Agent Configuration Baseline
1. Namespace
a. Use default namespace "CWAgent".
b. Send all CWAgent collected metrics into this namespace
2. Metrics to collect:
a. All systems shall be configured to report this minimum set
b. Percent of Memory in use, renamed to "Mem_Used_Percent"
c. Percent of disk space used, renamed to "Disk_Used_Percent"
· Include every disk or partition mounted in the OS, excluding partitions where metrics are not needed.
3. Collection interval
a. 300 seconds
4. Store the CloudWatch Agent configuration in the Systems Manager Parameter Store, not a per-server local file.
a. It is highly suggested to use a parameter name that easily identifies what the configuration does, what OS it is written for, and a version. Examples:
| · CWAgent_Base_Linux_2023-01-01 | #Linux format | ||
| · CWAgent_Base_Windows_2023-01-01 | #Windows format | ||
| · CWAgent_Base_Windows_2023-02-02 | #newer version | ||
| · CWAgent_Include_<APP-NAME>_2023-05-17 | #additional config for custom metrics |
Additional Metrics The CloudWatch agent may be operated with multiple configuration files in order to gather additional metrics. If additional metrics are needed, make separate purpose-driven configurations to be applied to the CWAgent with the append option. The baseline configuration should remain uniform across all instances in the IPF.
Baseline Configuration JSON Windows "metrics": { "namespace": "CWAgent", "append_dimensions": {
| "InstanceId": "${aws:InstanceId}" | |||||
| }, | |||||
| "metrics_collected": { | |||||
| "LogicalDisk": { | |||||
| "measurement": [ | |||||
| { | |||||
| "name": "% Free Space", | |||||
| "rename": "Disk_Used_Percent" | |||||
| } | |||||
| ], | |||||
| "metrics_collection_interval": 300, | |||||
| "resources": ["*"] | |||||
| }, | |||||
| "Memory": { | |||||
| "measurement": [ | |||||
| { | |||||
| "name": "% Committed Bytes In Use", | |||||
| "rename": "Mem_Used_Percent" | |||||
| } | |||||
| ], | |||||
| "metrics_collection_interval": 300 | |||||
| } | |||||
| } | |||||
| } |
Linux "metrics": { "namespace": "CWAgent", "append_dimensions": { "InstanceId": "${aws:InstanceId}" "metrics_collected": { "disk": { "measurement": [ "name": "used_percent", "rename": "Disk_Used_Percent" "metrics_collection_interval": 300, "resources": ["*"], "ignore_file_system_types": [ "tmpfs", "devtmpfs", "iso9660" "mem": { "measurement": [ "name": "used_percent", "rename": "Mem_Used_Percent" "metrics_collection_interval": 300
File details come from the government source that posted it. Updated .