--- title: Amazon EFS description: >- Amazon EFS provides simple, scalable file storage for use with Amazon EC2 instances in the AWS Cloud. breadcrumbs: Docs > Integrations > Amazon EFS --- # Amazon EFS Integration version1.0.0 {% callout %} # Important note for users on the following Datadog sites: us2.ddog-gov.com {% alert level="info" %} To find out if this integration is available in your organization, see your [Datadog Integrations](https://app.datadoghq.com/integrations) page or ask your organization administrator. To initiate an exception request to enable this integration for your organization, email [support@ddog-gov.com](mailto:support@ddog-gov.com). {% /alert %} {% /callout %} ## Overview{% #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{% #setup %} ### Installation{% #installation %} If you haven't already, set up the [Amazon Web Services integration first](https://docs.datadoghq.com/integrations/amazon_web_services.md). ### Metric collection{% #metric-collection %} 1. In the [AWS integration page](https://app.datadoghq.com/integrations/amazon-web-services), ensure that `EFS` is enabled under the `Metric Collection` tab. 1. Add those permissions to your [Datadog IAM policy](https://docs.datadoghq.com/integrations/amazon_web_services.md#installation) 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](https://docs.aws.amazon.com/efs/latest/ug/auth-and-access-control.html) on the AWS website. 1. Install the [Datadog - Amazon EFS integration](https://app.datadoghq.com/integrations/amazon-efs). ### Log collection{% #log-collection %} #### Enable logging{% #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{% #send-logs-to-datadog %} 1. If you haven't already, set up the [Datadog Forwarder Lambda function](https://docs.datadoghq.com/logs/guide/forwarder.md). 1. 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: - [Add a manual trigger on the S3 bucket](https://docs.datadoghq.com/logs/guide/send-aws-services-logs-with-the-datadog-lambda-function.md#collecting-logs-from-s3-buckets) - [Add a manual trigger on the CloudWatch Log Group](https://docs.datadoghq.com/logs/guide/send-aws-services-logs-with-the-datadog-lambda-function.md#collecting-logs-from-cloudwatch-log-group) ### Amazon EFS for Lambda{% #amazon-efs-for-lambda %} [Amazon EFS for Lambda](https://docs.datadoghq.com/integrations/amazon_lambda.md) 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](https://docs.datadoghq.com/integrations/amazon_lambda.md#aws-lambda-metrics) and enable metric collection. 1. Add this permission to your [Datadog IAM policy](https://docs.datadoghq.com/integrations/amazon_web_services.md#installation): - `elasticfilesystem:DescribeAccessPoints`: Lists active EFS connected to Lambda functions ## Data Collected{% #data-collected %} ### Metrics{% #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{% #events %} The Amazon Elastic File System integration does not include any events. ### Service Checks{% #service-checks %} The Amazon Elastic File System integration does not include any service checks. ## Troubleshooting{% #troubleshooting %} Need help? Contact [Datadog support](https://docs.datadoghq.com/help/).