Monitoring FSx for ONTAP file systems using Harvest and Grafana - FSx for ONTAP

Monitoring FSx for ONTAP file systems using Harvest and Grafana

You can use standard NetApp monitoring tools to monitor your file system storage usage and performance, with the following Harvest and Grafana solution being one example.

Setting up a Harvest and Grafana environment

You can monitor your Amazon FSx for NetApp ONTAP file system by using Harvest and Grafana. NetApp Harvest monitors ONTAP datacenters by collecting performance, capacity, and hardware metrics from FSx for ONTAP file systems. Grafana provides a dashboard where the collected Harvest metrics can be displayed.

To get started, you can deploy an AWS CloudFormation template that automatically launches an Amazon EC2 instance running Harvest and Grafana. As an input to the AWS CloudFormation template, you specify the fsxadmin user and the Amazon FSx management endpoint for the file system which will be added as part of this deployment. After the deployment is completed, you can log in to the Grafana dashboard to monitor your file system.

AWS CloudFormation template

This solution uses AWS CloudFormation to automate the deployment of the Harvest and Grafana solution. The template creates an Amazon EC2 Linux instance and installs Harvest and Grafana software. To use this solution, download the fsx-ontap-harvest-grafana.template AWS CloudFormation template.

Note

Implementing this solution incurs billing for the associated AWS services. For more information, see the pricing details pages for those services.

Amazon EC2 instance types

When configuring the template, you provide the Amazon EC2 instance type. NetApp's recommendation for the instance size depends on how many file systems you monitor and the number of metrics you choose to collect. With the default configuration, for each 10 file systems you monitor, NetApp recommends:

  • CPU: 2 cores

  • Memory: 1 GB

  • Disk: 500 MB (mostly used by log files)

Following are some sample configurations and the t3 instance type you might choose.

File systems CPU Disk Instance type

Under 10

2 cores

500 MB

t3.micro

10–40

4 cores

1000 MB

t3.xlarge

40+

8 cores

2000 MB

t3.2xlarge

For more information on Amazon EC2 instance types, see General purpose instances in the Amazon EC2 User Guide for Linux Instances.

Instance port rules

When you set up your Amazon EC2 instance, make sure that ports 3000 and 9090 are open for inbound traffic for the security group that the Amazon EC2 Harvest and Grafana instance is in.

Deployment procedure

The following procedure configures and deploys the Harvest/Grafana solution. It takes about five minutes to deploy. Before you start, you must have an FSx for ONTAP file system running in an Amazon Virtual Private Cloud (Amazon VPC) in your AWS account, and the parameter information for the template listed below. For more information on creating a file system, see Creating FSx for ONTAP file systems.

To launch the Harvest/Grafana solution stack

  1. Download the fsx-ontap-harvest-grafana.template AWS CloudFormation template. For more information on creating an AWS CloudFormation stack, see Creating a stack on the AWS CloudFormation console in the AWS CloudFormation User Guide.

    Note

    By default, this template launches in the US East (N. Virginia) AWS Region. You must launch this solution in an AWS Region where Amazon FSx is available. For more information, see Amazon FSx endpoints and quotas in the AWS General Reference.

  2. For Parameters, review the parameters for the template and modify them for the needs of your file system. This solution uses the following default values.

    Parameter Default Description
    InstanceType t3.micro

    The Amazon EC2 instance type. Following are the t3 instance types.

    • t3.micro

    • t3.small

    • t3.medium

    • t3.large

    • t3.xlarge

    • t3.2xlarge

    For the complete list of allowed Amazon EC2 instance type values for this parameter, see the fsx-ontap-harvest-grafana.template.

    KeyPair No default value The key pair that is used to access the Amazon EC2 instance.
    SecurityGroup No default value The Security group ID for the Harvest/Grafana Instance. Ensure Inbound ports 3000 and 9090 are open from the clients you wish to use to access your Grafana dashboard.
    Subnet No default value Specify the same subnet as your Amazon FSx for NetApp ONTAP file system's preferred subnet. You can find the file system's Preferred subnet ID in the Amazon FSx console, in the Network & security tab of the FSx for ONTAP file system details page
    LatestLinuxAmiId /aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2 The latest version of the Amazon Linux 2 AMI in a given AWS Region.
    FSxEndPoint No default value The file system's Management endpoint IP address. You can find the file system's management endpoint IP address in the Amazon FSx console, in the Administration tab of the FSx for ONTAP file system details page.
    SecretName No default value AWS Secrets Manager secret name containing the password for the file system's fsxadmin user. This is the password you provided when you created the file system.
  3. Choose Next.

  4. For Options, choose Next.

  5. For Review, review and confirm the settings. You must select the check box acknowledging that the template create IAM resources.

  6. Choose Create to deploy the stack.

You can view the status of the stack in the AWS CloudFormation console in the Status column. You should see a status of CREATE_COMPLETE in about five minutes.

Logging in to Grafana

After the deployment has finished, use your browser to log in to the Grafana dashboard at the IP and port 3000 of the Amazon EC2 instance:

http://EC2_instance_IP:3000

When prompted, use the Grafana default user name (admin) and password (pass). We recommend that you change your password as soon as you log in.

For more information, see Monitor all of your ONTAP clusters with Harvest on the NetApp website..