CloudWatchAgentProps

@cosmos-building-blocks/service › Globals › CloudWatchAgentProps

Properties for Cloud Watch Agent https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-Configuration-File-Details.html

Hierarchy

• CloudWatchAgentProps

Index

Properties

• compute
• defaultMetrics
• dimensions
• interval
• metrics
• omitHostname
• runAsUser

Properties

compute

• compute: Instance | AutoScalingGroup

Defined in packages/@cosmos-building-blocks/service/src/ec2/ec2-cloud-watch-agent.ts:14

Which Compute to install the agent onto

---

Optional defaultMetrics

• defaultMetrics? : undefined | object

Defined in packages/@cosmos-building-blocks/service/src/ec2/ec2-cloud-watch-agent.ts:44

Enable some default metrics

default { cpu: false, memory: true, disk: true, network: false }

---

Optional dimensions

• dimensions? : Record‹string, string›

Defined in packages/@cosmos-building-blocks/service/src/ec2/ec2-cloud-watch-agent.ts:24

Extra dimensions to add to each metric (labels)

default { InstanceId: '${aws:InstanceId}', InstanceType: '${aws:InstanceType}' }

---

Optional interval

• interval? : undefined | number

Defined in packages/@cosmos-building-blocks/service/src/ec2/ec2-cloud-watch-agent.ts:19

The number of seconds for the update interval

default 60

---

Optional metrics

• metrics? : CloudWatchMetric[]

Defined in packages/@cosmos-building-blocks/service/src/ec2/ec2-cloud-watch-agent.ts:39

Initialize with some metrics

default []

---

Optional omitHostname

• omitHostname? : undefined | false | true

Defined in packages/@cosmos-building-blocks/service/src/ec2/ec2-cloud-watch-agent.ts:29

Omit the Hostname as an dimension

default true

---

Optional runAsUser

• runAsUser? : undefined | string

Defined in packages/@cosmos-building-blocks/service/src/ec2/ec2-cloud-watch-agent.ts:34

Which user to runt he agent under on the host

default "root"