WORKERS AHEAD!
You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.
Amazon Cloudwatch Storage - CAS Metrics
AWS CloudWatch is a monitoring and observability service in the AWS cloud platform. One of its main features is collecting metrics and storing the metrics in a time-series database. It is a dimensional time-series service in the AWS cloud platform. It provides the following features:
- Collecting and monitoring logs.
- Storing metrics from AWS resources, and applications running in AWS or outside AWS.
- Providing system-wide visualization with graphs and statistics.
- Creating alarms that watch a single or multiple CloudWatch metrics and perform some actions based on the value of the metric.
Support is enabled by including the following module in the overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-aws-cloudwatch</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-aws-cloudwatch:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
imports {
mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
}
}
dependencies {
implementation "org.apereo.cas:cas-server-support-aws-cloudwatch"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
/*
The following platform references should be included automatically and are listed here for reference only.
implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
*/
implementation "org.apereo.cas:cas-server-support-aws-cloudwatch"
}
Configuration
The default configuration provides for the following:
- Metrics are asynchronously sent to AWS CloudWatch every
30
seconds. - The predefined AWS region is
us-east-1
. - The predefined AWS CloudWatch namespace is
apereo-cas
. - Connection and read timeouts are predefined to be
5
seconds.