Skip to content

Commit

Permalink
chore(README): Fix wording
Browse files Browse the repository at this point in the history
  • Loading branch information
vmercierfr committed Dec 20, 2023
1 parent c1603de commit bdd7f72
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Are you ready to take your AWS RDS monitoring to the next level? Say hello to pr

Built by SRE Engineers, designed for production: Meticulously crafted by a team of Site Reliability Engineers with years of hands-on experience in managing RDS production systems. Trust in their expertise to supercharge your monitoring.

It collect key metrics about:
It collects key metrics about:

- Hardware resource usage
- Underlying EC2 instances hard limits
- Pending AWS RDS maintenances
- Underlying EC2 instance's hard limits
- Pending AWS RDS maintenance operations
- Pending modifications
- Logs size
- RDS quota usage information
Expand All @@ -22,7 +22,7 @@ It collect key metrics about:

🧩 AWS Quotas Insights: Stay in control with real-time information about AWS quotas. Ensure you never hit limits unexpectedly.

💡 Hard Limits visibility: Know the hard limits of EC2 instance used by RDS and manage your resources effectively.
💡 Hard Limits visibility: Know the hard limits of the EC2 instance used by RDS and manage your resources effectively.

🔔 Alerting at Your Fingertips: Easily set up Prometheus alerting rules to stay informed of critical events, ensuring you're always ahead of issues.

Expand All @@ -32,7 +32,7 @@ It collect key metrics about:

🌐 Community-Driven: Join a vibrant community of users and contributors. Collaborate, share knowledge, and shape the future of AWS RDS monitoring together.

🚀 When combined with [prometheus-community/postgres_exporter](https://github.com/prometheus-community/postgres_exporter), it provides a production ready monitoring framework for RDS PostgreSQL.
🚀 When combined with [prometheus-community/postgres_exporter](https://github.com/prometheus-community/postgres_exporter), it provides a production-ready monitoring framework for RDS PostgreSQL.

## Metrics

Expand Down Expand Up @@ -119,7 +119,7 @@ It collect key metrics about:

## Dashboards

Grafana dashoards are available on Grafana labs:
Grafana dashboards are available on Grafana labs:

<table>
<tr>
Expand Down Expand Up @@ -175,7 +175,7 @@ Configuration parameters priorities:

Prometheus RDS exporter needs read-only AWS IAM permissions to fetch metrics from AWS RDS, CloudWatch, EC2 and ServiceQuota AWS APIs.

Standard AWS authentication methods (AWS credentials, SSO and assume role), see <https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html>.
Standard AWS authentication methods (AWS credentials, SSO and assumed role) are supported, see <https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html>.

If you are running on [AWS EKS](https://aws.amazon.com/eks/), we strongly recommend to use [IRSA](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html)

Expand Down Expand Up @@ -258,11 +258,11 @@ Terraform uers can take example on Terraform code in `configs/terraform/`.

## Installation

See [Development environment](#development-environment) to start the Prometheus RDS exporter, Prometheus, Grafana with dashboards in a minute.
See the [Development environment](#development-environment) to start the Prometheus RDS exporter, Prometheus, and Grafana with dashboards in a minute.

### AWS EKS

**Recommanded method** to deploy on AWS EKS using [IRSA](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html) and Helm.
**Recommended method** to deploy on AWS EKS using [IRSA](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html) and Helm.

1. Create an IAM policy

Expand All @@ -276,9 +276,9 @@ See [Development environment](#development-environment) to start the Prometheus
aws iam create-policy --policy-name ${IAM_POLICY_NAME} --policy-document file:///tmp/prometheus-rds-exporter.policy.json
```

1. Attach IAM role to your EKS cluster
1. Create and attach an IAM role to your EKS cluster

eksctl will create an IAM role and a Kubernetes Service account
[eksctl](https://eksctl.io) will create an IAM role and a Kubernetes Service account

```bash
EKS_CLUSTER_NAME=default # Replace with your EKS cluster name
Expand Down Expand Up @@ -313,7 +313,7 @@ See [Development environment](#development-environment) to start the Prometheus
--set serviceAccount.annotations."eks\.amazonaws\.com\/role-arn"="${SERVICE_ACCOUNT_ANNOTATION}"
```

1. Option. Customize prometheus exporter settings
1. Option. Customize Prometheus exporter settings

Download Helm chart default values

Expand Down Expand Up @@ -394,7 +394,7 @@ See [Development environment](#development-environment) to start the Prometheus
aws iam attach-role-policy --role-name ${IAM_ROLE_NAME} --policy-arn ${IAM_POLICY_ARN}
```
1. Create IAM instance profile
1. Create an IAM instance profile
```bash
EC2_INSTANCE_PROFILE_NAME="prometheus-rds-exporter"
Expand All @@ -406,7 +406,7 @@ See [Development environment](#development-environment) to start the Prometheus
aws iam add-role-to-instance-profile --instance-profile-name ${EC2_INSTANCE_PROFILE_NAME} --role-name ${IAM_ROLE_NAME}
```
1. Attach IAM instance profile to the EC2 instance
1. Attach the IAM instance profile to the EC2 instance
```bash
EC2_INSTANCE_ID="i-1234567890abcdef0" # Replace with your AWS instance ID
Expand All @@ -429,7 +429,7 @@ See [Development environment](#development-environment) to start the Prometheus
1. Install package
Prometheus RDS exporter will be automatically started as service.
Prometheus RDS exporter will be automatically started as a service.
```bash
dpkg -i ${PACKAGE_NAME}
Expand Down Expand Up @@ -523,7 +523,7 @@ It will start and configure Grafana, Prometheus, and the RDS exporter:
### Running the tests
Execute golang tests:
Execute Go tests:
```bash
make test
Expand Down

0 comments on commit bdd7f72

Please sign in to comment.