Detecting AWS Fargate in Java

Amazon Web Services (AWS) Fargate is a serverless compute engine that allows developers to run containers without managing the underlying infrastructure. This makes it a popular choice for deploying containerized applications. However, there are times when an application needs to detect whether it is running in a Fargate environment, for tasks like configuring logging, optimizing resource usage, or applying environment-specific logic.

In this blog, we will explore how to detect if your application is running on AWS Fargate using Java.

---

Understanding AWS Fargate Environment Characteristics

When running on Fargate, certain environment variables and file paths provide hints about the runtime environment. Here are some key characteristics of Fargate:

1. Environment Variable: AWS sets the AWS_EXECUTION_ENV variable for its services. On Fargate, this value typically includes a reference to Fargate.
2. Metadata File: Fargate tasks expose container metadata at /var/run/secrets/ecs/container_metadata_file. This file contains information about the container and task, which can confirm if the application is running on Fargate.
3. Absence of EC2 Indicators: Unlike ECS on EC2, Fargate does not have direct access to instance metadata endpoints (e.g., http://169.254.169.254/latest/meta-data).

---

Steps to Detect Fargate in Java

Here is a step-by-step approach to detect if your application is running on AWS Fargate:

1. Check the Environment Variable

The AWS_EXECUTION_ENV environment variable provides a basic hint. While this variable is not exclusive to Fargate, it can indicate an AWS environment.

String awsExecutionEnv = System.getenv("AWS_EXECUTION_ENV");
if (awsExecutionEnv != null && awsExecutionEnv.contains("Fargate")) {
    System.out.println("Running on AWS Fargate");
} else {
    System.out.println("Not running on AWS Fargate");
}

2. Verify the Metadata File

Check if the Fargate-specific metadata file exists at /var/run/secrets/ecs/container_metadata_file. This file is a strong indicator that the application is running on Fargate.

import java.io.File;

File fargateMetadataFile = new File("/var/run/secrets/ecs/container_metadata_file");
if (fargateMetadataFile.exists()) {
    System.out.println("Running on AWS Fargate");
} else {
    System.out.println("Not running on AWS Fargate");
}

For a more robust detection mechanism, combine both the environment variable and metadata file checks

public static boolean isRunningOnFargate() {
    // Check the AWS_EXECUTION_ENV variable
    String awsExecutionEnv = System.getenv("AWS_EXECUTION_ENV");
    boolean hasFargateEnv = awsExecutionEnv != null && awsExecutionEnv.contains("Fargate");

    // Check the Fargate-specific metadata file
    File fargateMetadataFile = new File("/var/run/secrets/ecs/container_metadata_file");
    boolean hasMetadataFile = fargateMetadataFile.exists();

    // Determine if running on Fargate
    return hasFargateEnv || hasMetadataFile;
}

public static void main(String[] args) {
    if (isRunningOnFargate()) {
        System.out.println("Application is running on AWS Fargate.");
    } else {
        System.out.println("Application is NOT running on AWS Fargate.");
    }
}