Skip to main content
How to enable StorageGRID in your environment

Advanced monitoring in StorageGRID

Contributors netapp-aronk
PDFs

Learn how to access and export metrics to help troubleshoot issues.

View metrics API through a Prometheus query

Prometheus is an open-source software for collecting metrics. To access StorageGRID’s embedded Prometheus through the GMI, go to Support › Metrics.

monitor-metrics-page

Alternatively, you can navigate to the link directly.

monitor-prometheus-interface

With this view, you can access the Prometheus interface. From there, you can search through available metrics and even experiment with queries.

To make a Prometheus URL query, follow these steps:

Steps

  1. Start typing in the query text box. As you type, metrics are listed. For our purposes, only metrics that start with StorageGRID and Node are important.

  2. To see the number of HTTP sessions for each node, type storagegrid_http and select storagegrid_http_sessions_incoming_currently_established. Click Execute and display the information in a graph or console format.

    monitor-http-sessions

Note Queries and charts that you build through this URL do not persist. Complex queries consume resources on the admin node. NetApp recommends that you use this view to explore available metrics.
Note It is not recommended to directly interface to our Prometheus instance because this requires opening additional ports. Accessing metrics through our API is the recommended and secure method.

Export metrics through the API

You can also access the same data through the StorageGRID management API.

To export metrics through the API, follow these steps:

  1. From the GMI, select Help › API Documentation.

  2. Scroll down to Metrics and select GET /grid/metric-query.

    monitor-metrics-query

    The response includes the same information that you can obtain through a Prometheus URL query. You can again see the number of HTTP sessions that are currently established on each storage node. You can also download the response in JSON format for readability. The following figure shows sample Prometheus query responses.

    monitor-sample-prometheus-query-responses

Note The advantage of using the API is that it enables you to perform authenticated queries