Skip to content

Commit d113269

Browse files
committed
Updated README.md
1 parent 8074547 commit d113269

File tree

1 file changed

+9
-7
lines changed
  • Monitoring/monitor_fsxn_with_harvest_on_eks

1 file changed

+9
-7
lines changed

Monitoring/monitor_fsxn_with_harvest_on_eks/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ The following command will create a role, associated with the policy created abo
173173
```
174174
eksctl create iamserviceaccount --name harvest-sa --region=<REGION> --namespace <NAMESPACE> --role-name harvest-role --cluster <YOUR_CLUSTER_NAME> --attach-policy-arn "$POLICY_ARN" --approve
175175
```
176-
Of course replace all the strings within the <> with your own values. Note that the <NAMESPACE> should
176+
Of course replace all the strings within the <> with your own values. Note that the `<NAMESPACE>` should
177177
be where your Prometheus stack is deployed. If you used the command above to install Prometheus
178178
then the namespace should be `prometheus`.
179179

@@ -184,14 +184,15 @@ by running:
184184
```text
185185
helm upgrade --install harvest -f values.yaml ./ --namespace=<NAMESPACE> --set promethues=<your_promethues_release_name>
186186
```
187-
Note that the <NAMESPACE> should be where your Prometheus stack is deployed. If you used the command above to install Prometheus
187+
Note that the `<NAMESPACE>` should be where your Prometheus stack is deployed. If you used the command above to install Prometheus
188188
then it will be `prometheus`.
189189

190190
Once the deployment is complete, Harvest should be listed as a target on Prometheus. You can check that by running
191191
the following commands. The first one sets up a port forwarder for port 9090 on your local machine to the Prometheus server running
192192
in the EKS cluster as a background job.
193193
```bash
194194
kubectl port-forward -n prometheus prometheus-kube-prometheus-stack-prometheus-0 9090 &
195+
sleep 4 # Give it a few seconds to establish the connection
195196
curl -s http://localhost:9090/api/v1/targets | jq -r '.data.activeTargets[] | select(.labels.service[0:14] == "harvest-poller") | "\(.labels.service) Status = \(.health)"'
196197
```
197198
It should list a status of 'up' for each of the FSxN clusters you are monitoring. For example:
@@ -212,7 +213,7 @@ That kills any background job that has 9090 in the command line, which the port
212213
### Import FSxN CloudWatch metrics into your monitoring stack using YACE
213214
AWS CloudWatch provides metrics for the FSx for ONTAP file systems which cannot be collected by Harvest.
214215
Therefore, we recommend to using the [yet-another-cloudwatch-exporter](https://github.com/prometheus-community/yet-another-cloudwatch-exporter)
215-
(by Prometheus community) for collecting these metrics.
216+
(by Prometheus community) to collect these metrics.
216217

217218
#### 1. Create Service Account with permissions to get AWS CloudWatch metrics
218219
The following IAM policy can be used to grant the all permissions required by YACE to fetch the CloudWatch metrics:
@@ -345,17 +346,18 @@ Once you have access to Grafana, you can log in using the default credentials:
345346
### Adding Grafana dashboards and visualize your FSxN metrics on Grafana
346347
Once you login, you'll want to import some dashboards to visualize the metrics collected by Harvest and YACE. You will find
347348
some example dashboards in the `dashboards` folder in this repository. You can import these dashboards into Grafana by following these steps:
349+
1. Download the dashboards from the `dashboards` folder in this repository to your local PC.
348350
1. Log in to your Grafana instance.
349-
2. Click on the "+" icon on the left-hand side menu and select "Import Dashboard".
350-
3. Click in the box with "Upload dashboard JSON file" and browse to one of the dashboard JSON files from the `dashboards` folder in this repository.
351-
4. Click "Import."
351+
1. Click on the "+" icon on the left-hand side menu and select "Import Dashboard".
352+
1. Click in the box with "Upload dashboard JSON file" and browse to one of the dashboard JSON files from the `dashboards` folder in this repository.
353+
1. Click "Import."
352354

353355
You can repeat the steps above for each of the dashboard JSON files you want to import.
354356

355357
You can also import the "default" dashboards from the Harvest repo found [here](https://github.com/NetApp/harvest/tree/main/grafana/dashboards).
356358
Only consider the dashboards in the `cmode` and `cmode-details` directories.
357359

358-
:memo: **NOTE:** Since the special 'fsxadmin' account doesn't have access to all the metrics that a traditional 'admin' account would have,
360+
:memo: **NOTE:** Since the special 'fsxadmin' account doesn't have access to all the metrics that a traditional ONTAP 'admin' account would have,
359361
some of the metrics and dashboards may not be fully applicable or available. The ones with 'fsx' tag are more relevant for FSxN.
360362

361363
## Author Information

0 commit comments

Comments
 (0)