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.

Sign up for GitHub

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

CloudWatch language edit #206

Merged
merged 1 commit into from
Jul 31, 2024
Merged

CloudWatch language edit #206

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions astro/src/content/docs/operate/secure-and-monitor/cloudwatch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@

## Overview

Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real time. You can use CloudWatch to collect and track metrics for your resources and applications. Additionally, you can create dashboards to display metrics for your applications or to show custom collections of metrics.
Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real-time. You can use CloudWatch to collect and track metrics for your resources and applications. Additionally, you can create dashboards to display metrics for your applications or to show custom collections of metrics.

This guide will show you how to:

- Connect FusionAuth to Amazon CloudWatch using Docker in an on-premise environment or an Amazon EC2 instance.
- Set up a custom collector agent to send data to Amazon CloudWatch.
- Create a dashboard in Amazon CloudWatch to view metrics.

We'll also take a look at which FusionAuth metrics are useful in Amazon CloudWatch. Please go through the [FusionAuth guide to monitoring for an overview of the available metrics](/docs/operate/secure-and-monitor/monitor). For an overview of the metrics you can collect with Amazon CloudWatch agent, review the [CloudWatch agent metrics document](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/metrics-collected-by-CloudWatch-agent.html).
We'll also take a look at which FusionAuth metrics are useful in Amazon CloudWatch. Please read the [FusionAuth guide to monitoring for an overview of the available metrics](/docs/operate/secure-and-monitor/monitor). For an overview of the metrics you can collect with Amazon CloudWatch agent, review the [CloudWatch agent metrics document](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/metrics-collected-by-CloudWatch-agent.html).

## Set Up Your Amazon Account

Expand Down Expand Up @@ -95,7 +95,7 @@
The access keys will look something like this:

<Aside type='note'>
Inplace of `your_key_id` and `your_access_key` use your actual AWS credential values in all occurrences in this guide.
In this guide, use your actual AWS credential values instead of `your_key_id` and `your_access_key` wherever these placeholder texts occur.
</Aside>

```sh
Expand All @@ -119,9 +119,9 @@
Save the Dockerfile from the [FusionAuth containers repo](https://github.com/FusionAuth/fusionauth-containers/blob/master/docker/fusionauth/fusionauth-app/Dockerfile) to your working directory on your computer.


Edit the Dockerfile and replace line 92 `&& apt-get -y install --no-install-recommends curl \` with `&& apt-get -y install --no-install-recommends curl unzip ca-certificates sudo \`. This adds the `unzip`, `sudo` and `ca-certificates` packages to the image.
Edit the Dockerfile and replace line 92 `&& apt-get -y install --no-install-recommends curl \` with `&& apt-get -y install --no-install-recommends curl unzip ca-certificates sudo \`. This adds the `unzip`, `sudo`, and `ca-certificates` packages to the image.

Replace the section marked the comment "###### Connect the log file to stdout" with the following configuration.
Replace the section marked with the comment "###### Connect the log file to stdout" with the following configuration.

Check failure on line 124 in astro/src/content/docs/operate/secure-and-monitor/cloudwatch.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'stdout'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'stdout'?", "location": {"path": "astro/src/content/docs/operate/secure-and-monitor/cloudwatch.mdx", "range": {"start": {"line": 124, "column": 77}}}, "severity": "ERROR"}

```
###### Connect the log file to stdout #############################################################
Expand Down Expand Up @@ -306,7 +306,7 @@

Click <InlineUIElement>Next</InlineUIElement>.

Now you can add metrics to the widget and configure some options. Give your graph a title and choose "1h" for the time preference. You can also set the refresh interval from the drop down on the far right.
Now you can add metrics to the widget and configure some options. Give your graph a title and choose "1h" for the time preference. You can also set the refresh interval from the dropdown on the far right.

<img src="/img/docs/operate/secure-and-monitor/cloudwatch/add-metrics-dashboard.png" alt="Add Metrics To The Dashboards" role="bottom-cropped" width="1200" />

Expand Down Expand Up @@ -569,7 +569,7 @@
docker build --platform linux/amd64 -t cloudwatch-logger .
```

Finally, add the following service to the FusionAuth `docker-compose.yml` file. You will need to change the region, access key, secret access key, FusionAuth API key and FusionAuth app Id to your values.
Finally, add the following service to the FusionAuth `docker-compose.yml` file. You will need to change the region, access key, secret access key, FusionAuth API key, and FusionAuth app Id to your values.

```yaml
cloudwatch-logger: # NEW for custom logging
Expand Down Expand Up @@ -664,7 +664,7 @@

Return to the instance screen and make sure the instance is running.

Now, find the public IP on the Instance overview screen, then log in to the console by typing the following in the terminal, replacing `16.16.204.161` with your public IP and `test.pem` with the name of you downloaded key pair file.
Now, find the public IP on the Instance overview screen, then log in to the console by typing the following in the terminal, replacing `16.16.204.161` with your public IP and `test.pem` with the name of your downloaded key pair file.

First change the permissions of the key file if they are too open

Expand Down Expand Up @@ -776,7 +776,7 @@
scp -i ./test.pem ./Dockerfile [email protected]:~/fusionauth-project/
```

Comment out the `cloudwatch-logger:` service you added to `docker-compose.yml` file earlier and also copy the file to the instance.
Comment out the `cloudwatch-logger:` service you added to the `docker-compose.yml` file earlier and copy the file to the instance.

```sh
scp -i ./test.pem ./docker-compose.yml [email protected]:~/fusionauth-project/
Expand Down
Loading