Skip to content
This repository was archived by the owner on Jan 19, 2022. It is now read-only.

Commit 211990c

Browse files
Add CloudWatch integration documentation to the reference.
Fixes gh-402
1 parent f61178d commit 211990c

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

docs/src/main/asciidoc/spring-cloud-aws.adoc

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2334,6 +2334,41 @@ public class SimpleResourceLoadingBean {
23342334
}
23352335
}
23362336
----
2337+
== CloudWatch Metrics
2338+
Spring Cloud AWS provides Spring Boot auto-configuration for Micrometer CloudWatch integration.
2339+
To send metrics to CloudWatch add a dependency to `spring-cloud-aws-actuator` module:
2340+
2341+
[source,xml,indent=0]
2342+
----
2343+
<dependency>
2344+
<groupId>org.springframework.cloud</groupId>
2345+
<artifactId>spring-cloud-aws-actuator</artifactId>
2346+
</dependency>
2347+
----
2348+
2349+
Additionally CloudWatch integration requires a value provided for `management.metrics.export.cloudwatch.namespace` configuration property.
2350+
2351+
Following configuration properties are available to configure CloudWatch integration:
2352+
2353+
[cols="3*", options="header"]
2354+
|===
2355+
|property
2356+
|default
2357+
|description
2358+
2359+
|management.metrics.export.cloudwatch.namespace
2360+
|
2361+
|The namespace which will be used when sending metrics to CloudWatch. This property is needed and must not be null.
2362+
2363+
|management.metrics.export.cloudwatch.enabled
2364+
|true
2365+
|If CloudWatch integration should be enabled. This property should be likely set to `false` for a local development profile.
2366+
2367+
|management.metrics.export.cloudwatch.step
2368+
|1m
2369+
|The interval at which metrics are sent to CloudWatch. The default is 1 minute.
2370+
|===
2371+
23372372
== Configuration properties
23382373

23392374
To see the list of all Spring Cloud AWS related configuration properties please check link:appendix.html[the Appendix page].

0 commit comments

Comments
 (0)