For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/integrations/amazon-efs.md. A documentation index is available at /llms.txt.

Amazon EFS

Integration version1.0.0

To find out if this integration is available in your organization, see your Datadog Integrations page or ask your organization administrator.

To initiate an exception request to enable this integration for your organization, email [email protected].

Overview

Amazon EFS provides simple, scalable file storage for use with AWS Lambda functions or Amazon EC2 instances.

Enable this integration to collect all your EFS metrics in Datadog.

Setup

Installation

If you haven’t already, set up the Amazon Web Services integration first.

Metric collection

  1. In the AWS integration page, ensure that EFS is enabled under the Metric Collection tab.

  2. Add those permissions to your Datadog IAM policy in order to collect Amazon EFS metrics:

    • elasticfilesystem:DescribeTags: Gets custom tags applied to file systems
    • elasticfilesystem:DescribeFileSystems: Provides a list of active file systems

    For more information, see the EFS policies on the AWS website.

  3. Install the Datadog - Amazon EFS integration.

Log collection

Enable logging

Configure Amazon EFS to send logs either to a S3 bucket or to CloudWatch.

Note: If you log to a S3 bucket, make sure that amazon_efs is set as Target prefix.

Send logs to Datadog

  1. If you haven’t already, set up the Datadog Forwarder Lambda function.

  2. Once the Lambda function is installed, manually add a trigger on the S3 bucket or CloudWatch log group that contains your Amazon EFS logs in the AWS console:

Amazon EFS for Lambda

Amazon EFS for Lambda allows you to connect an EFS to your Lambda functions. Organizations can use EFS for Lambda to simplify their machine learning and data processing workloads to be entirely serverless. To divide Lambda metrics and logs by EFS:

  1. Install the AWS Lambda integration and enable metric collection.

  2. Add this permission to your Datadog IAM policy:

    • elasticfilesystem:DescribeAccessPoints: Lists active EFS connected to Lambda functions

Data Collected

Metrics

aws.efs.burst_credit_balance
(gauge)		The average burst credit balance during the period. Burst credits allow a file system to burst to throughput levels above its baseline level.
Shown as byte
aws.efs.burst_credit_balance.maximum
(gauge)		The largest burst credit balance for any minute during the period.
Shown as byte
aws.efs.burst_credit_balance.minimum
(gauge)		The smallest burst credit balance for any minute during the period.
Shown as byte
aws.efs.client_connections
(count)		The number of client connections to a file system. When using a standard client, there is one connection per mounted Amazon EC2 instance.
aws.efs.client_connections.average
(count)		The average number of client connections to a file system during the period.
aws.efs.client_connections.maximum
(count)		The maximum number of client connections to a file system during the period.
aws.efs.client_connections.minimum
(count)		The minimum number of client connections to a file system during the period.
aws.efs.client_connections.samplecount
(count)		The sample count of data points used for client connection metrics.
Shown as unit
aws.efs.data_read_iobytes
(count)		The total number of bytes for file system read operations.
Shown as byte
aws.efs.data_read_iobytes.average
(count)		The average size of read operations during the period.
Shown as byte
aws.efs.data_read_iobytes.maximum
(count)		The size of the largest read operation during the period.
Shown as byte
aws.efs.data_read_iobytes.minimum
(count)		The size of the smallest read operation during the period.
Shown as byte
aws.efs.data_read_iobytes.samplecount
(count)		The number of read operations during the period.
Shown as unit
aws.efs.data_write_iobytes
(count)		The total number of bytes for file system write operations.
Shown as byte
aws.efs.data_write_iobytes.average
(count)		The average size of write operations during the period.
Shown as byte
aws.efs.data_write_iobytes.maximum
(count)		The size of the largest write operation during the period.
Shown as byte
aws.efs.data_write_iobytes.minimum
(count)		The size of the smallest write operation during the period.
Shown as byte
aws.efs.data_write_iobytes.samplecount
(count)		The number of write operations during the period.
Shown as unit
aws.efs.metadata_iobytes
(count)		The total number of bytes for file system metadata operations.
Shown as byte
aws.efs.metadata_iobytes.average
(count)		The average size of metadata operations during the period.
Shown as byte
aws.efs.metadata_iobytes.maximum
(count)		The size of the largest metadata operation during the period.
Shown as byte
aws.efs.metadata_iobytes.minimum
(count)		The size of the smallest metadata operation during the period.
Shown as byte
aws.efs.metadata_iobytes.samplecount
(count)		The number of metadata operations during the period.
Shown as unit
aws.efs.metadata_read_iobytes
(gauge)		The average size of metadata read operations during the period.
Shown as byte
aws.efs.metadata_write_iobytes
(gauge)		The average size of metadata write operations during the period.
Shown as byte
aws.efs.metered_iobytes
(gauge)		The average number of metered bytes per file system operation, including data read, data write, and metadata operations, with read operations discounted.
Shown as byte
aws.efs.metered_iobytes.maximum
(gauge)		The size of the largest metered operation during the period.
Shown as byte
aws.efs.metered_iobytes.minimum
(gauge)		The size of the smallest metered operation during the period.
Shown as byte
aws.efs.metered_iobytes.samplecount
(gauge)		The number of all file system operations during the period.
Shown as unit
aws.efs.metered_iobytes.sum
(gauge)		The total number of metered bytes for all file system operations.
Shown as byte
aws.efs.percent_iolimit
(gauge)		How close a file system is to reaching the I/O limit of the General Purpose performance mode.
Shown as percent
aws.efs.permitted_throughput
(gauge)		The maximum amount of throughput a file system can drive during the period.
Shown as byte
aws.efs.permitted_throughput.maximum
(gauge)		The highest throughput permitted for any minute during the period.
Shown as byte
aws.efs.permitted_throughput.minimum
(gauge)		The lowest throughput permitted for any minute during the period.
Shown as byte
aws.efs.storage_bytes
(gauge)		The size of the file system in bytes, including data stored across all storage classes (Standard, IA, and Archive). Emitted every 15 minutes.
Shown as byte
aws.efs.time_since_last_sync
(gauge)		The amount of time elapsed since the last successful sync to the destination file system in a replication configuration.
Shown as second
aws.efs.total_iobytes
(count)		The total number of bytes for all file system operations processed by Amazon EFS, without read discounts.
Shown as byte
aws.efs.total_iobytes.average
(count)		The average size of all file system operations during the period.
Shown as byte
aws.efs.total_iobytes.maximum
(count)		The size of the largest file system operation during the period.
Shown as byte
aws.efs.total_iobytes.minimum
(count)		The size of the smallest file system operation during the period.
Shown as byte
aws.efs.total_iobytes.samplecount
(count)		The number of all file system operations during the period.
Shown as unit

Each of the metrics retrieved from AWS are assigned the same tags that appear in the AWS console, including but not limited to host name, security-groups, and more.

Events

The Amazon Elastic File System integration does not include any events.

Service Checks

The Amazon Elastic File System integration does not include any service checks.

Troubleshooting

Need help? Contact Datadog support.