Module netapp_ontap.resources.top_metrics_directory

Copyright © 2024 NetApp Inc. All rights reserved.

This file has been automatically generated based on the ONTAP REST API documentation.

Overview

You can use this API to retrieve a list of directories with the greatest value performance metric or capacity metric for a specified volume. Use the top_metric parameter to specify which type of metric to filter for. This API is used to provide insight into performance metrics, namely iops and throughput, or capacity metrics such as non_recursive_bytes_used. This API only supports returning one metric per request.

Retrieve a list of the directories with the most I/O activity

For a report on the directories with the most I/O activity in the past several seconds returned in descending order, specify the performance metric type you want to filter for by passing the iops or throughput property into the top_metric parameter. If the metric type is not specified, by default the API returns a list of the directories with the greatest number of the average read operations per second. The current maximum number of directories returned by the API for a metric type is 25.

Approximate accounting and error bars for the list of directories with the most I/O activity

When too many directories have recent activity, some directories might be dropped from the list. In this situation, the spread of values in the error field increases, indicating that there are larger error bars on the value for iops or throughput. As the list becomes increasingly more approximate due to dropped entries, some of the directories that would have otherwise been included might not be present in the final list returned by the API.

Retrieve a list of the largest directories

For a report on the largest directories returned in descending order, specify the capacity metric by passing the non_recursive_bytes_used property into the top_metric parameter. If the metric type is not specified, by default the API returns a list of directories with the greatest number of average read operations per second. The current maximum number of directories returned by the API for a metric type is 25.

Failure to return list of directories with most I/O activity

The API can sometimes fail to return the list of directories with the most I/O activity, due to the following reasons:

  • The volume does not have the activity tracking feature enabled.
  • The volume has not had any recent NFS/CIFS client traffic.
  • The NFS/CIFS client operations are being served by the client-side filesystem cache.
  • The NFS/CIFS client operations are being buffered by the client operating system.
  • On rare occasions, the incoming traffic pattern is not suitable to obtain the list of directories with the most I/O activity.

Failure to return list of largest directories

The API can sometimes fail to return the list of largest directories, due to the following reasons:

  • The volume does not have file system analytics enabled.
  • The volume's file system analytics database version doesn't support this report.

Failure to return pathnames

The API can sometimes fail to obtain filesystem pathnames for certain directories, either due to internal transient errors or if those directories have been recently deleted. In such cases, instead of the pathname, the API will return "{.}" for that directory.

Examples

Retrieving a list of the directories with the greatest average number of read operations per second

from netapp_ontap import HostConnection
from netapp_ontap.resources import TopMetricsDirectory

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(
        list(
            TopMetricsDirectory.get_collection("{volume.uuid}", top_metric="iops.read")
        )
    )

[
    TopMetricsDirectory(
        {
            "path": "/dir1/dir2",
            "svm": {
                "name": "vs1",
                "_links": {
                    "self": {
                        "href": "/api/svm/svms/572361f3-e769-439d-9c04-2ba48a08ff43"
                    }
                },
                "uuid": "572361f3-e769-439d-9c04-2ba48a08ff43",
            },
            "volume": {"name": "vol1"},
            "_links": {
                "metadata": {
                    "href": "/api/storage/volumes/73b293df-e9d7-46cc-a9ce-2df8e52ef864/files/dir1%2Fdir2?return_metadata=true"
                }
            },
            "iops": {"read": 1495, "error": {"upper_bound": 1505, "lower_bound": 1495}},
        }
    ),
    TopMetricsDirectory(
        {
            "path": "/dir3/dir4",
            "svm": {
                "name": "vs1",
                "_links": {
                    "self": {
                        "href": "/api/svm/svms/572361f3-e769-439d-9c04-2ba48a08ff43"
                    }
                },
                "uuid": "572361f3-e769-439d-9c04-2ba48a08ff43",
            },
            "volume": {"name": "vol1"},
            "_links": {
                "metadata": {
                    "href": "/api/storage/volumes/73b293df-e9d7-46cc-a9ce-2df8e52ef864/files/dir3%2Fdir4?return_metadata=true"
                }
            },
            "iops": {"read": 1022, "error": {"upper_bound": 1032, "lower_bound": 1022}},
        }
    ),
    TopMetricsDirectory(
        {
            "path": "/dir12",
            "svm": {
                "name": "vs1",
                "_links": {
                    "self": {
                        "href": "/api/svm/svms/572361f3-e769-439d-9c04-2ba48a08ff43"
                    }
                },
                "uuid": "572361f3-e769-439d-9c04-2ba48a08ff43",
            },
            "volume": {
                "name": "vol1",
                "_links": {
                    "self": {
                        "href": "/api/storage/volumes/73b293df-e9d7-46cc-a9ce-2df8e52ef864"
                    }
                },
                "uuid": "73b293df-e9d7-46cc-a9ce-2df8e52ef864",
            },
            "_links": {
                "metadata": {
                    "href": "/api/storage/volumes/73b293df-e9d7-46cc-a9ce-2df8e52ef864/files/dir12?return_metadata=true"
                }
            },
            "iops": {"read": 345, "error": {"upper_bound": 355, "lower_bound": 345}},
        }
    ),
]

Retrieving a list of the directories with the most traffic with failure in obtaining the pathnames for the directories:

from netapp_ontap import HostConnection
from netapp_ontap.resources import TopMetricsDirectory

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(
        list(
            TopMetricsDirectory.get_collection(
                "{volume.uuid}", top_metric="throughput.write"
            )
        )
    )

[
    TopMetricsDirectory(
        {
            "path": "{4ec6d1ea-d5da-11eb-a25f-005056ac0f77:1232}",
            "svm": {
                "name": "vs0",
                "_links": {
                    "self": {
                        "href": "/api/svm/svms/0ba74c3e-d5ca-11eb-8fbb-005056ac0f77"
                    }
                },
                "uuid": "0ba74c3e-d5ca-11eb-8fbb-005056ac0f77",
            },
            "volume": {"name": "fv"},
            "throughput": {
                "error": {"upper_bound": 29, "lower_bound": 24},
                "write": 24,
            },
        }
    ),
    TopMetricsDirectory(
        {
            "path": "{4ec6d1ea-d5da-11eb-a25f-005056ac0f77:6754}",
            "svm": {
                "name": "vs0",
                "_links": {
                    "self": {
                        "href": "/api/svm/svms/0ba74c3e-d5ca-11eb-8fbb-005056ac0f77"
                    }
                },
                "uuid": "0ba74c3e-d5ca-11eb-8fbb-005056ac0f77",
            },
            "volume": {"name": "fv"},
            "throughput": {
                "error": {"upper_bound": 22, "lower_bound": 12},
                "write": 12,
            },
        }
    ),
    TopMetricsDirectory(
        {
            "path": "{4ec6d1ea-d5da-11eb-a25f-005056ac0f77:8654}",
            "svm": {
                "name": "vs0",
                "_links": {
                    "self": {
                        "href": "/api/svm/svms/0ba74c3e-d5ca-11eb-8fbb-005056ac0f77"
                    }
                },
                "uuid": "0ba74c3e-d5ca-11eb-8fbb-005056ac0f77",
            },
            "volume": {"name": "fv"},
            "throughput": {"error": {"upper_bound": 10, "lower_bound": 8}, "write": 8},
        }
    ),
]

Retrieving a list of the largest directories

The following example shows how to retrieve a list of the largest directories based on the non-recursive bytes used by the contents of a directory.

from netapp_ontap import HostConnection
from netapp_ontap.resources import TopMetricsDirectory

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(
        list(
            TopMetricsDirectory.get_collection(
                "{volume.uuid}", top_metric="non_recursive_bytes_used"
            )
        )
    )

[
    TopMetricsDirectory(
        {
            "path": "/dir1/dir2",
            "svm": {
                "name": "vs1",
                "_links": {
                    "self": {
                        "href": "/api/svm/svms/572361f3-e769-439d-9c04-2ba48a08ff43"
                    }
                },
                "uuid": "572361f3-e769-439d-9c04-2ba48a08ff43",
            },
            "volume": {"name": "vol1"},
            "_links": {
                "metadata": {
                    "href": "/api/storage/volumes/73b293df-e9d7-46cc-a9ce-2df8e52ef864/files/dir1%2Fdir2?return_metadata=true"
                }
            },
            "non_recursive_bytes_used": 345,
        }
    ),
    TopMetricsDirectory(
        {
            "path": "/dir3/dir4",
            "svm": {
                "name": "vs1",
                "_links": {
                    "self": {
                        "href": "/api/svm/svms/572361f3-e769-439d-9c04-2ba48a08ff43"
                    }
                },
                "uuid": "572361f3-e769-439d-9c04-2ba48a08ff43",
            },
            "volume": {"name": "vol1"},
            "_links": {
                "metadata": {
                    "href": "/api/storage/volumes/73b293df-e9d7-46cc-a9ce-2df8e52ef864/files/dir3%2Fdir4?return_metadata=true"
                }
            },
            "non_recursive_bytes_used": 345,
        }
    ),
    TopMetricsDirectory(
        {
            "path": "/dir12",
            "svm": {
                "name": "vs1",
                "_links": {
                    "self": {
                        "href": "/api/svm/svms/572361f3-e769-439d-9c04-2ba48a08ff43"
                    }
                },
                "uuid": "572361f3-e769-439d-9c04-2ba48a08ff43",
            },
            "volume": {"name": "vol1"},
            "_links": {
                "metadata": {
                    "href": "/api/storage/volumes/73b293df-e9d7-46cc-a9ce-2df8e52ef864/files/dir12?return_metadata=true"
                }
            },
            "non_recursive_bytes_used": 345,
        }
    ),
]

Retrieving a list of the largest directories where incomplete data is reported

The following example retrieves a list of the largest directories when partial data is returned.

from netapp_ontap import HostConnection
from netapp_ontap.resources import TopMetricsDirectory

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(
        list(
            TopMetricsDirectory.get_collection(
                "{volume.uuid}", top_metric="non_recursive_bytes_used"
            )
        )
    )

[
    TopMetricsDirectory(
        {
            "path": "/dir1/dir2",
            "svm": {
                "name": "vs1",
                "_links": {
                    "self": {
                        "href": "/api/svm/svms/572361f3-e769-439d-9c04-2ba48a08ff43"
                    }
                },
                "uuid": "572361f3-e769-439d-9c04-2ba48a08ff43",
            },
            "volume": {"name": "vol1"},
            "_links": {
                "metadata": {
                    "href": "/api/storage/volumes/73b293df-e9d7-46cc-a9ce-2df8e52ef864/files/dir1%2Fdir2?return_metadata=true"
                }
            },
            "non_recursive_bytes_used": 1022,
        }
    ),
    TopMetricsDirectory(
        {
            "path": "/dir12",
            "svm": {
                "name": "vs1",
                "_links": {
                    "self": {
                        "href": "/api/svm/svms/572361f3-e769-439d-9c04-2ba48a08ff43"
                    }
                },
                "uuid": "572361f3-e769-439d-9c04-2ba48a08ff43",
            },
            "volume": {"name": "vol1"},
            "_links": {
                "metadata": {
                    "href": "/api/storage/volumes/73b293df-e9d7-46cc-a9ce-2df8e52ef864/files/dir12?return_metadata=true"
                }
            },
            "non_recursive_bytes_used": 261,
        }
    ),
]

Retrieving a list of the largest directories when the file system analytics database version doesn't support this report

The following example shows the behavior of the API when the file system analytics database version doesn't support the large directory report.

from netapp_ontap import HostConnection
from netapp_ontap.resources import TopMetricsDirectory

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(
        list(
            TopMetricsDirectory.get_collection(
                "{volume.uuid}", top_metric="non_recursive_bytes_used"
            )
        )
    )

[]

Example showing the behavior of the API when there is no read/write traffic:

from netapp_ontap import HostConnection
from netapp_ontap.resources import TopMetricsDirectory

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(
        list(
            TopMetricsDirectory.get_collection(
                "{volume.uuid}", top_metric="throughput.write"
            )
        )
    )

[]

Classes

class TopMetricsDirectory (*args, **kwargs)

Information about a directory's IO metrics.

Initialize the instance of the resource.

Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:

MyResource(name='foo').name == 'foo'

Args

*args
Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
**kwargs
each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.

Ancestors

Static methods

def count_collection (*args, connection: HostConnection = None, **kwargs) -> int

Returns a count of all TopMetricsDirectory resources that match the provided query


This calls GET on the object to determine the number of records. It is more efficient than calling get_collection() because it will not construct any objects. Query parameters can be passed in as kwargs to determine a count of objects that match some filtered criteria.

Args

*args
Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the count of bars for a particular foo, the foo.name value should be passed.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host. These query parameters can affect the count. A return_records query param will be ignored.

Returns

On success, returns an integer count of the objects of this type. On failure, returns -1.

Raises

NetAppRestError: If the API call returned a status code >= 400, or if there is no connection available to use either passed in or on the library.

def fast_get_collection (*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[RawResource]

Returns a list of RawResources that represent TopMetricsDirectory resources that match the provided query


Fetch a list of all objects of this type from the host.

This is a lazy fetch, making API calls only as necessary when the result
of this call is iterated over. For instance, if max_records is set to 5,
then iterating over the collection causes an API call to be sent to the
server once for every 5 records. If the client stops iterating before
getting to the 6th record, then no additional API calls are made.

Args

*args
Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
max_records
The maximum number of records to return per call
raw
return a list of netapp_ontap.resource.RawResource objects that require to be promoted before any RESTful operations can be used on them. Setting this argument to True makes get_collection substantially quicker when many records are returned from the server.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host.

Returns

A list of Resource objects

Raises

NetAppRestError: If there is no connection available to use either passed in or on the library. This would be not be raised when get_collection() is called, but rather when the result is iterated.

def find (*args, connection: HostConnection = None, **kwargs) -> Resource

Retrieves a list of directories with the greatest value performance metric or capacity metric.

Learn more


Find an instance of an object on the host given a query.

The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found, None will be returned. If more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.

Args

*args
Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host.

Returns

A Resource object containing the details of the object or None if no matches were found.

Raises

NetAppRestError: If the API call returned more than 1 matching resource.

def get_collection (*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[Resource]

Retrieves a list of directories with the greatest value performance metric or capacity metric.

Learn more


Fetch a list of all objects of this type from the host.

This is a lazy fetch, making API calls only as necessary when the result
of this call is iterated over. For instance, if max_records is set to 5,
then iterating over the collection causes an API call to be sent to the
server once for every 5 records. If the client stops iterating before
getting to the 6th record, then no additional API calls are made.

Args

*args
Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
max_records
The maximum number of records to return per call
raw
return a list of netapp_ontap.resource.RawResource objects that require to be promoted before any RESTful operations can be used on them. Setting this argument to True makes get_collection substantially quicker when many records are returned from the server.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host.

Returns

A list of Resource objects

Raises

NetAppRestError: If there is no connection available to use either passed in or on the library. This would be not be raised when get_collection() is called, but rather when the result is iterated.

Inherited members

class TopMetricsDirectorySchema (*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)

The fields of the TopMetricsDirectory object

Ancestors

  • netapp_ontap.resource.ResourceSchema
  • marshmallow.schema.Schema
  • marshmallow.base.SchemaABC

Class variables

iops: TopMetricsDirectoryIops GET POST PATCH

The iops field of the top_metrics_directory.

The links field of the top_metrics_directory.

non_recursive_bytes_used: Size GET

Non-recursive bytes used by the contents of a directory.

Example: 300

path: str GET

Path of the directory.

Example: /dir_abc/dir_123/dir_20

svm: Svm GET

The svm field of the top_metrics_directory.

throughput: TopMetricsDirectoryThroughput GET POST PATCH

The throughput field of the top_metrics_directory.

volume: Volume GET

The volume field of the top_metrics_directory.