File System Metrics
You can monitor the health, capacity, and performance of your file systems and mount targets by using metrics , alarms , and notifications.
oci_filestorage
(the File Storage service).Overview of Metrics for oci_filestorage
File Storage service metrics help you measure operations and throughput related to file systems and mount targets. The available metrics help you determine quickly if your file system is accessible, how much data is flowing through its associated mount target, and if operations are producing unexpected errors. You can get visibility into your workload IOPs and latency, and set up alarms to receive notifications if tolerance thresholds are exceeded.
File Storage metrics include these resources:
- File system: A high-performance shared storage entity made available to a network by an associated mount target.
- Mount target: An NFS endpoint that lives in a VCN subnet of your choice and provides network access for file systems.
Metrics provided for file systems can be filtered or grouped by their associated mount target.
Raw Data Point Frequency
For every 1-minute interval, the File Storage service posts one raw data point to the Monitoring service. The Monitoring service charts show data points at 1-minute, 5-minute, 1-hour (60-minute), and 1-day intervals. Supported values for interval depend on the specified time range in the metric query (not applicable to alarm queries). More interval values are supported for smaller time ranges. For example, if you select one hour for the time range, then all interval values are supported. If you select 90 days for the time range, then only the 1h or 1d interval values are supported. The available statistics are calculated by using the count of 1-minute data points in the select interval. For example, for a given metric:
- The mean for each 5-minute interval is calculated over 5 raw data points.
- The mean for each 60-minute interval is calculated over 60 raw data points.
Required IAM Policy
To monitor resources, you must be given the required type of access in a policy written by an administrator, whether you're using the Console or the REST API with an SDK, CLI, or other tool. The policy must give you access to the monitoring services as well as the resources being monitored. If you try to perform an action and get a message that you don’t have permission or are unauthorized, confirm with your administrator the type of access you've been granted and which compartment you should work in. For more information on user authorizations for monitoring, see the Authentication and Authorization section for the related service: Monitoring or Notifications.
Available Metrics: oci_filestorage
The metrics listed in the following table are automatically available for any file system or mount target. You do not need to enable monitoring on the resource to get these metrics.
You also can use the Monitoring service to create custom queries.
- RESOURCEID
- The OCID of the file system or mount target.
- MOUNTTARGETID
- The OCID of the mount target exporting an associated file system.
- THROUGHPUT
- The type of request throughput:
- SIZE
- The request size range:
- HEALTHITEM
- The type of health rate item:
File System Metrics
Metric | Metric Display Name | Unit | Description | Dimensions |
---|---|---|---|---|
FileSystemReadThroughput
|
Read Throughput | bytes | Read throughput for the file system. If the file system is exported through multiple mount targets, total throughput for all mount targets is displayed. Expressed as bytes read per second. |
|
FileSystemWriteThroughput
|
Write Throughput | bytes | Write throughput for the file system. If the file system is exported through multiple mount targets, total throughput for all mount targets is displayed. Expressed as bytes written per second. | |
FileSystemReadRequestsbySize
|
Read Requests |
operation |
Read requests by size: 0-8 KiB , 8-64 KiB , 64 KiB - 1 MiB . Expressed as operation per second, grouped by size. |
resourceId
|
FileSystemWriteRequestsbySize
|
Write Requests |
operation | Write requests by size: 0-8 KiB , 8-64 KiB , 64 KiB - 1 MiB . Expressed as operation per second, grouped by size. |
|
FileSystemReadAverageLatencybySize
|
Read Latency | second | Read latency by size: 0-8 KiB , 8-64 KiB , 64 KiB - 1 MiB . Expressed as average read latency per second, grouped by size. |
|
FileSystemWriteAverageLatencybySize
|
Write Latency | second | Write latency by size: 0-8 KiB , 8-64 KiB , 64 KiB - 1 MiB . Expressed as average write latency per second, grouped by size. |
|
MetadataRequestAverageLatency
|
Metadata Latency | second |
Average metadata request latency for the following NFS operations: |
resourceId
|
MetadataIOPS
|
Metadata IOPs | operation | IOPs (Input/Output Operations Per Second) for the following NFS operations: CREATE , GETATTR , SETATTR , ACCESS , LOOKUP , READLINK , and REMOVE . Expressed as operations per second. |
|
FileSystemUsage
|
Usage | bytes | Total space utilization for a file system. Expressed as GiB consumed per second. |
resourceId
|
Mount Target Metrics
Metric | Metric Display Name | Unit | Description | Dimensions |
---|---|---|---|---|
MountTargetReadThroughput
|
Read Throughput |
bytes | Read throughput for the mount target. If the mount target exports multiple file systems, total throughput for all file systems is displayed. Expressed as bytes read per interval. |
|
MountTargetWriteThroughput
|
Write Throughput | bytes | Write throughput for the mount target. If the mount target exports multiple file systems, total throughput for all file systems is displayed. Expressed as bytes written per interval. | |
MountTargetConnections
|
Connections |
count |
Number of client connections for the mount target. Expressed as total connection count at the interval. | resourceId
|
MountTargetHealth
|
Health |
percent |
Number of successfully executed NFS API requests. Expressed as a percentage of total requests per interval. | resourceId
|
Tips for Working with File Storage Metrics
You can use the tables below to help interpret the data you see in File Storage metric charts. You can familiarize yourself with the typical metrics emitted by the File Storage service using the chart defaults.
File System Charts
This chart... | shows this information... | using these defaults.... | that you can use to... |
---|---|---|---|
Read Throughput/ Write Throughput |
The read or write throughput of your file system in bytes per second. Read/write throughput is averaged across all mount targets that export the file system. Only the default mean statistic is meaningful. |
|
|
Read Requests/ Write Requests |
Read or write operation requests processed by your file systems in bytes per second. Each operation is placed in one of these three size groups:
Only the default mean statistic is meaningful. |
|
|
Read Latency/ Write Latency |
Average latency of read or write operation requests processed by your file systems in bytes per second. Each operation is placed in one of these three size groups:
These charts don't report zero latentcy, or periods when there are no read/write operations happening. Information is presented in the charts as individual data points. |
|
|
Metadata Latency |
Average latency of read or write metadata operation requests processed by your file systems in bytes per second. Each operation is placed in one of these three size groups:
|
|
|
Metadata IOPs |
IOPs per second of read or write metadata operation requests processed by your file systems. |
|
|
Usage |
The total space utilization for each file system per hour. The data in this chart is presented differently than the utilization value shown in the Details tab of the file system:
|
|
|
Mount Target Charts
This chart... | shows this information... | using these defaults.... | that you can use to... |
---|---|---|---|
Read Throughput/ Write Throughput |
The read or write throughput of your mount target in bytes per second. Read/write throughput is averaged across all file systems exported by the mount target. Only the default mean statistic is meaningful. |
|
|
Connections |
The number of active connections for each mount target. Typically, one connection represents one NFS client. |
|
|
Health |
The percentage of requests processed successfully by the mount target. |
|
|
Using the Console
-
Open the navigation menu. Under Core Infrastructure, click File Storage and then click File Systems.
- Click the file system to view its details.
- Under Resources, click Metrics.
For more information about monitoring metrics and using alarms, see Monitoring Overview. For information about notifications for alarms, see Notifications Overview.
-
Open the navigation menu. Under Core Infrastructure, click File Storage and then click Mount Targets.
- Click the mount target to view its details.
- Under Resources, click Metrics.
For more information about monitoring metrics and using alarms, see Monitoring Overview. For information about notifications for alarms, see Notifications Overview.
- Open the navigation menu. Under Solutions and Platform, go to Monitoring and click Service Metrics.
- For Compartment, select the compartment that contains the file storage resource you're interested in.
-
For Metric Namespace, select oci_filestorage.
The Service Metrics page dynamically updates the page to show charts for each metric that is emitted by the selected metric namespace.
For more information about monitoring metrics and using alarms, see Monitoring Overview. For information about notifications for alarms, see Notifications Overview.
Using the API
For information about using the API and signing requests, see REST APIs and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.
Use the following APIs for monitoring:
- Monitoring API for metrics and alarms
- Notifications API for notifications (used with alarms)