Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add document about CloudWatch metrics #2350

Merged
merged 5 commits into from Jul 10, 2019
Merged

Add document about CloudWatch metrics #2350

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
585d4cc
add document about CloudWatch metrics
mikena-truss Jul 5, 2019
6642733
add Terraform location
mikena-truss Jul 5, 2019
0b33271
add metrics to doc root
mikena-truss Jul 5, 2019
945582e
add docs on updating dashboards
mikena-truss Jul 9, 2019
0f6868d
Merge branch 'master' into mw-add-dashboard-docs
mikena-truss Jul 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/README.md
View file
Open in desktop
Expand Up @@ -15,6 +15,10 @@ If you are looking to understand choices made in this project, see the list of [

* [Pairing](pairing.md). A list of past pairing recordings.

## Metrics

* [Metrics](metrics.md). Documentation for application metrics.

<!--index-->

## HOWTOs
Expand Down
22 changes: 22 additions & 0 deletions docs/metrics.md
View file
Open in desktop
@@ -0,0 +1,22 @@
# MilMove Application Metrics

This document provides an overview of the metrics collected by the MilMove application.

## Dashboards

Various AWS metrics have been aggregated in CloudWatch dashboards.
These include data about network requests, container resources, and errors.

* [Prod Dashboard](https://us-west-2.console.aws.amazon.com/cloudwatch/home?region=us-west-2#dashboards:name=mil-prod)
* [Staging Dashboard](https://us-west-2.console.aws.amazon.com/cloudwatch/home?region=us-west-2#dashboards:name=mil-staging)
* [Experimental Dashboard](https://us-west-2.console.aws.amazon.com/cloudwatch/home?region=us-west-2#dashboards:name=mil-experimental)

### Updating Dashboards
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chrisgilmerproj can I get some of your time to create a small guide for this?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Absolutely, just grab any time on my calendar.

For what to write here I think it depends on how deep you want to go. I might just say "If you want to preserve changes to one of these dashboards have infrastructure update their terraform configurations." And then you could link them to this file: https://github.com/transcom/ppp-infra/blob/master/modules/aws-app-environment/main.tf#L840-L995. All I do is copy the source from the dashboard, paste it in that file, and update it a bit to use templated variables.


Dashboards are maintained by Terraform in the [MilMove infra repo](https://github.com/transcom/ppp-infra/blob/master/modules/aws-app-environment/main.tf#L840).
When changes are made in the AWS CloudWatch UI,
they can be exported by clicking "Actions" > "View/edit source".
The Terraform file can be updated with this source,
replacing environment variables as shown in the existing file.
Feel free to ask the Infrastructure team for help,
as they'll have access to deploy changes across environments.