NetApp OnTap (Remote)NetApp OnTap (Remote)
Remote extension that collects NetApp OnTap metrics from the OnTap 9.6+ API.
Extension
- Product information
- Release notes
Overview
Collect, view, and analyze metrics from your NetApp OnTap clusters in context with your hosts, applications, and services already being monitored by OneAgents. Make use of powerful charting and dashboarding capabilities as well as allow the Davis® AI causation engine to generate baselines and alert you when anomalies are detected in designated metrics. Metrics will be collected OnTap cluster-wide as well as for each of your nodes and storage virtual machines (SVMs).
Compatibility information
Connects to and collects data from the NetApp OnTap API. This REST API is available in OnTap 9.6+.
Details
Assets
A NetApp OnTap Overview dashboard is included with the extension. This includes links to access the various OnTap entities detected.
Metric events
Three metric event configurations are included with the extension. These must be enabled in the Metric events for alerting settings before they will be active:
- OnTap Cluster monitoring unavailable
- OnTap FRU in error state
- High Temperature on OnTap Node
Metrics
Metrics are associated with different feature sets that can be enabled or disabled as needed. Metrics will be collected once per minute. Review the bottom of the Hub page for a breakdown of metrics.
Volume to VMware datastore linking
Starting with version 2.3.2 rules are included to allow linking of this extension's netapp_ontap:volume entity to the vmware:datastore from the VMware remote monitoring extension. Version 3.5.1 of the VMware extension is required for the necessary attributes to be collected. This linking is done via a "same as" relationship and is based on the volume's name matching the datastore's 'NAS remote path' property.
Installation
Requirements
- NetApp OnTap version 9.6+ with REST API reachable
- OnTap user with 'http' application access that is assigned a rest-role with at least readonly access to the following API paths:
- /api/cluster
- /api/svm/svms
- /api/storage/cluster
- /api/storage/aggregates
- /api/storage/disks
- /api/storage/volumes
Dynatrace configuration
Find 'NetApp OnTap' in the in-product Extensions or Hub page and activate (if offline you can download the extension from this Hub page in the 'Versions' section and install as a custom extension).
Monitoring configurations
Once activated in your environment you can create monitoring configurations. Each monitoring configuration can have one or more OnTap clusters configured.
First select the desired ActiveGate group that will run the monitoring configuration.
For each cluster configure a NetApp OnTap Extension Endpoint:
- OnTap REST API URL: URL (including protocol) to where OnTap API is available (e.g. https://ontap-prod/)
- Cluster name: Used in naming the cluster entity (default is detected hostname)
- Username: For API access
- Password: For API access (check requirements section for needed permissions)
- Proxy
- Address: e.g. http://proxy.example.com:8080
- Proxy username
- Proxy password
- Verify SSL certificate
The Frequency can be used to collect metrics less frequently than the default of once per minute. You may need to use this in large clusters where collecting all requested data would take longer than 1 minute.
The Log level will be set at the monitoring configuration level and will apply to all endpoints. INFO by default. DEBUG logging is only needed when investigating issues with support.
Finally, enable the desired feature sets (refer to the Details tab for what metrics are associated with which feature sets).
Licensing
Licensing
There is no charge for obtaining the extension, only for the data (metrics & events) that the extension ingests. The details of license consumption will depend on which licensing model you are using. This will either be Dynatrace classic licensing or the Dynatrace Platform Subscription (DPS) model.
Metrics
License consumption is based on the number of metric data points ingested. The following formula will provide approximate annual data points ingested assuming all feature sets are enabled (formula must be adjusted if a lower frequency than once per minute used):
(16 + (4 x nodes) + (1 x frus) + (1 x svms) + (2 x disks) + (5 x aggregates) + (20 x volumes) +(4 x volume of svm with qos policy) + (3 x snapmirror relationships)) x 60 min x 24 h x 365 days data points/year
Classic licensing
In the classic licensing model, metric ingestion will consume Davis Data Units (DDUs) at the rate of .001 DDUs per metric data point.
Multiply the above formula for annual data points by .001 to estimate annual DDU usage.
Log records
This extension will report log events in 2 situations:
- When a cluster node restart is detected
- When the extension cannot connect to the configured cluster API endpoint
- Each minute will have another event reported until the issue is resolved and a successful connection occurs
Log management and analytics (powered by Grail)
License consumption is based on the size (in bytes) of data ingested & processed, retained, and queried so there is not a single formula to estimate the total consumption from this extension. Consult the log management and analytics documentation for details on the other dimensions that will effect license consumption.
Classic licensing
In the classic licensing model, log record ingestion will consume Davis Data Units (DDUs) at the rate of 100 DDUs per Gigabyte of log records ingested.
Log monitoring classic
In log monitoring classic, license consumption is based on the number of ingested log records.
Classic licensing
In the classic licensing model, log record ingestion will consume Davis Data Units (DDUs) at the rate of .0005 DDUs per ingested log record.
Multiply estimated ingested log records by .0005 to estimate DDU usage from log records.
Extension content
Feature sets
Below is a complete list of the feature sets provided in this version. To ensure a good fit for your needs, individual feature sets can be activated and deactivated by your administrator during configuration.
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Cluster IOPS (other) | netapp.ontap.cluster.iops_other.count | The cluster's number of I/O operations observed at the storage object (other) | Count |
| Cluster IOPS (read) | netapp.ontap.cluster.iops_read.count | The cluster's number of I/O operations observed at the storage object (read) | Count |
| Cluster IOPS (total) | netapp.ontap.cluster.iops_total.count | The cluster's number of I/O operations observed at the storage object (total) | Count |
| Cluster IOPS (write) | netapp.ontap.cluster.iops_write.count | The cluster's number of I/O operations observed at the storage object (write) | Count |
| Cluster throughput (other) | netapp.ontap.cluster.throughput_other.count | The cluster's rate of throughput bytes observed at the storage object (other) | Byte |
| Cluster throughput (read) | netapp.ontap.cluster.throughput_read.count | The cluster's rate of throughput bytes observed at the storage object (read) | Byte |
| Cluster throughput (total) | netapp.ontap.cluster.throughput_total.count | The cluster's rate of throughput bytes observed at the storage object (total) | Byte |
| Cluster throughput (write) | netapp.ontap.cluster.throughput_write.count | The cluster's rate of throughput bytes observed at the storage object (write) | Byte |
| Cluster latency (other) | netapp.ontap.cluster.latency_other.count | The cluster's raw latency in microseconds observed at the storage object (other) | MicroSecond |
| Cluster latency (read) | netapp.ontap.cluster.latency_read.count | The cluster's raw latency in microseconds observed at the storage object (read) | MicroSecond |
| Cluster latency (total) | netapp.ontap.cluster.latency_total.count | The cluster's raw latency in microseconds observed at the storage object (total) | MicroSecond |
| Cluster latency (write) | netapp.ontap.cluster.latency_write.count | The cluster's raw latency in microseconds observed at the storage object (write) | MicroSecond |
| Cluster block storage size | netapp.ontap.cluster.block_storage_size | The size of the cluster's block storage | Byte |
| Cluster block storage used | netapp.ontap.cluster.block_storage_used | Amount of block storage on the cluster in use | Byte |
| Cluster block storage used percentage | netapp.ontap.cluster.block_storage_used_percentage | The percentage of the cluster's block storage that is currently in use | Percent |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Cluster availability | netapp.ontap.cluster.availability | Connectivity to the configured OnTap cluster URL as detected by the extension | Percent |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Rated life used | netapp.ontap.disk.rated_life_used_percentage | Percentage of rated life used | Percent |
| Disk state | netapp.ontap.disk.state | Current disk state: broken, copy, maintenance, partner, pending, present, reconstructing, removed, spare, unfail, or zeroing | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Lag time | netapp.ontap.snapmirror.relationship.lag_time | The time since the exported snapshot was created | Second |
| Relationship state | netapp.ontap.snapmirror.relationship.state | The state of the relationship | State |
| Relationship health | netapp.ontap.snapmirror.relationship.health | Is the relationship healthy? | State |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Volume QOS minimum throughput (IOPS) | netapp.ontap.volume.qos.min_throughput_iops | The minimum throughput in IOPS (volumes) | Count |
| Volume QOS maximum throughput (IOPS) | netapp.ontap.volume.qos.max_throughput_iops | The maximum throughput in IOPS (volumes) | Count |
| Volume QOS maximum throughput (Mbps) | netapp.ontap.volume.qos.max_throughput_mbps | The maximum throughput in Mbps (volumes) | MegaBytePerSecond |
| Volume QOS minimum throughput (Mbps) | netapp.ontap.volume.qos.min_throughput_mbps | The minimum throughput in Mbps (volumes) | MegaBytePerSecond |
| SVM QOS minimum throughput (IOPS) | netapp.ontap.svm.qos.min_throughput_iops | The minimum throughput in IOPS (svms) | Count |
| SVM QOS maximum throughput (IOPS) | netapp.ontap.svm.qos.max_throughput_iops | The maximum throughput in IOPS (svms) | Count |
| - | netapp.ontap.svm.qos.max_throughput_mbps | - | - |
| SVM QOS minimum throughput (Mbps) | netapp.ontap.svm.qos.min_throughput_mbps | The minimum throughput in Mbps (svms) | MegaBytePerSecond |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| FRU state | netapp.ontap.node.fru.state | State of the field replaceable unit (100% for OK 0% for ERROR)) | Percent |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| LUN state | netapp.ontap.lun.state | The state of the LUN. Normal states for a LUN are online and offline. Other states indicate errors | Count |
| LUN container state | netapp.ontap.lun.container_state | The state of the volume and aggregate that contain the LUN. LUNs are only available when their containers are available | Count |
| LUN enabled state | netapp.ontap.lun.enabled | The enabled state of the LUN. LUNs can be disabled to prevent access to the LUN. 1 = enabled, 0 = disabled | Count |
| LUN space used | netapp.ontap.lun.used | The amount of space consumed by the main data stream of the LUN | Byte |
| LUN size | netapp.ontap.lun.size | The total provisioned size of the LUN | Byte |
| LUN space used percentage | netapp.ontap.lun.used_percentage | Space used in the LUN as a percentage | Percent |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Node uptime | netapp.ontap.node.uptime | How long the node reports it has been running | Second |
| Over temperature | netapp.ontap.node.over_temperature | Specifies whether the hardware is currently operating outside of its recommended temperature range (1 = "normal", 2 = "over"). | Count |
| Node membership | netapp.ontap.node.membership | Membership status of the cluster node | State |
| Node processor utilization | netapp.ontap.node.processor_utilization | Average CPU Utilization for the node | Percent |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| SVM state | netapp.ontap.svm.state | Current SVM state: starting, running, stopping, stopped,or deleting | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Aggregate state | netapp.ontap.aggregate.state | Current aggregate state: online, onlining, offline, offlining, relocating, unmounted, restricted, inconsistent, failed, or unknown | Count |
| Aggregate block storage used | netapp.ontap.aggregate.block_storage_used | Space used or reserved in bytes. Includes volume guarantees and aggregate metadata. | Byte |
| Aggregate block storage available | netapp.ontap.aggregate.block_storage_available | Space available in bytes | Byte |
| Aggregate block storage size | netapp.ontap.aggregate.block_storage_size | Total usable space in bytes, not including WAFL reserve and aggregate Snapshot copy reserve. | Byte |
| Aggregate block storage used percentage | netapp.ontap.aggregate.block_storage_used_percent | Percentage of block storage used | Percent |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Volume state | netapp.ontap.volume.state | Volume state: error, mixed, offline, or online | Count |
| Volume throughput (other) | netapp.ontap.volume.throughput.other.count | The volume's rate of throughput bytes observed at the storage object (other) | Byte |
| Volume throughput (read) | netapp.ontap.volume.throughput.read.count | The volume's rate of throughput bytes observed at the storage object (read) | Byte |
| Volume throughput (write) | netapp.ontap.volume.throughput.write.count | The volume's rate of throughput bytes observed at the storage object (write) | Byte |
| Volume throughput (total) | netapp.ontap.volume.throughput.total.count | The volume's rate of throughput bytes observed at the storage object (total) | Byte |
| Volume IOPS (other) | netapp.ontap.volume.iops.other.count | The volume's number of I/O operations observed at the storage object (other) | Count |
| Volume IOPS (read) | netapp.ontap.volume.iops.read.count | The volume's number of I/O operations observed at the storage object (read) | Count |
| Volume IOPS (write) | netapp.ontap.volume.iops.write.count | The volume's number of I/O operations observed at the storage object (write) | Count |
| Volume IOPS (total) | netapp.ontap.volume.iops.total.count | The volume's number of I/O operations observed at the storage object (total) | Count |
| Volume latency (total) | netapp.ontap.volume.latency.total | The volume's raw latency in microseconds observed at the storage object (total) | MicroSecond |
| Volume latency (read) | netapp.ontap.volume.latency.read | The volume's raw latency in microseconds observed at the storage object (read) | MicroSecond |
| Volume latency (write) | netapp.ontap.volume.latency.write | The volume's raw latency in microseconds observed at the storage object (write) | MicroSecond |
| Volume latency (other) | netapp.ontap.volume.latency.other | The volume's raw latency in microseconds observed at the storage object (other) | MicroSecond |
| Volume size | netapp.ontap.volume.size | Total provisioned size | Byte |
| Volume space available | netapp.ontap.volume.available | The available space | Byte |
| Volume space used | netapp.ontap.volume.used | Volume space used (including data and metadata) | Byte |
| Volume space used percentage | netapp.ontap.volume.used_percent | Percentage of volume space used (including data and metadata) | Percent |
| - | netapp.ontap.volume.files.maxiumum | - | - |
| Files (inodes) | netapp.ontap.volume.files.used | Number of files (inodes) used for user-visible data permitted on the volume. | Count |
| Files (inodes) used percentage | netapp.ontap.volume.files.used_percentage | Percentage of the maximum number of files used on the volume. | Percent |
Full version history
Full version history
- Sets parameter on calls to not fail if a requested field is not present
- Fixes issue where collection on older versions of OnTap could fail if a given field were not present
- Adds credential vault support
- Handles reporting of 'offline' LUNs
- Corrects mix-up of metric metadata for 2 keys
Full version history
- new snapmirror relationship feature set
- new qos feature set
- qos metrics collected per applicable svm and volume
- inode metrics reported for volumes
- processor utilization metric added to cluster nodes
- metrics/entities reported for SnapMirror relationships
- topology rules to allow linking an OnTap volume to a VMware datastore
- Requires use of the VMware extension (3.5.1+) (not legacy integration)
- Small fixes including setting a larger resolution for 'currently monitoring' tiles on default dashboard
- resolves issue where with multiple monitoring configurations at lower frequencies inconsistent values could be displayed
Full version history
- Topology changes
- There are some significant changes in topology rules for entities and relationships in this version. These changes are made to ensure consistency in how entities detected and to avoid scenarios where a changed name or moving a volume would have resulted in new entities being detected
- Due to this change once applied you will see new entities created and relationships being formed for the following entity types:
- Nodes
- SVMs
- Aggregates
- Volumes
- It may take upwards of an hour for you to see all of the changes reflected in the UI entities and relationships due to the need for the old entities and relationships to "age out"
- If you have configurations such as metric alerts that were made for specific entity IDs as opposed to using rules around properties you will need to update these to use the new entities
- This is a one-off necessary change that was identified and similar changes that may 'break' existing configs are always avoided as much as possible
- LUN metrics are now collected
- You must enable the 'luns' feature set for any existing configurations after updating
- Bug fixes
- Properly report the configured and detected name of the cluster
- Updated rule for detecting clusters and nodes to ensure reported log entries for one type do not mistakenly create an entity of the other type
Full version history
- handle issue that would prevent volume collection caused by volumes reported with very few fields populated
- improved logging of certain errors
Full version history
No release notes
