New Relic's ECS integration reports and displays performance data from your Amazon ECS environment.
Install overview
Before you install our ECS integration, we recommend reviewing the requirements. During the install process:
For EC2 launch type: The infrastructure agent (
newrelic-infra
) gets deployed onto an ECS cluster as a service using the daemon scheduling strategy. This deployment installs the infrastructure agent in all the container instances of the cluster. The infrastructure agent then monitors ECS and Docker containers.For Fargate launch type: The infrastructure agent (
newrelic-infra
) gets deployed as a sidecar in every task to monitor. The Amazon ECS Fargate documentation defines a sidecar as a way to move part of a service's core responsibility into a containerized module that is deployed alongside the core application.
Install options:
Install using CloudFormation
One install option is using AWS CloudFormation. We provide some CloudFormation templates that install the ECS integration onto your AWS account for both EC2 and Fargate launch types:
To register the New Relic's ECS integration task, deploy this stack. Ensure you’re deploying the stack to your desired region(s). This stack creates the following resources:
- A secret that stores the license key.
- A policy to access the license key.
- An instance role to be used as an ECS task
ExecutionRole
, with access to the license key. - For EC2 launch type: Registers the New Relic Infrastructure ECS integration task.
Follow the additional instructions for your launch type:
Next steps:
- Wait a few minutes and then look for your data in the UI.
- Recommended: Install our ECS cloud integration, which gets you other ECS data, including information about clusters and services.
- See recommended alert conditions.
- Understand the AWS resources created by this process.
Install with automatic script
One install option is using our install script. To use the automatic install script:
Download the ECS integration installer:
curl -O https://download.newrelic.com/infrastructure_agent/integrations/ecs/newrelic-infra-ecs-installer.shAdd execute permissions to the installer:
chmod +x newrelic-infra-ecs-installer.shExecute it with
-h
to see the documentation and requirements:./newrelic-infra-ecs-installer.sh -hCheck that your AWS profile points to the same region where your ECS cluster was created:
$ aws configure get region us-east-1 $ aws ecs list-clusters YOUR_CLUSTER_ARNS arn:aws:ecs:us-east-1:YOUR_AWS_ACCOUNT:cluster/YOUR_CLUSTER
Execute the installer, specifying your license key and cluster name.
EC2 launch type:
./newrelic-infra-ecs-installer.sh -c YOUR_CLUSTER_NAME -l YOUR_LICENSE_KEY
Fargate launch type:
./newrelic-infra-ecs-installer.sh -fargate -c YOUR_CLUSTER_NAME -l YOUR_LICENSE_KEY
Additional steps for Fargate launch type (not EC2 launch type):
Download the task definition example with the sidecar container to be deployed:
curl -O https://download.newrelic.com/infrastructure_agent/integrations/ecs/newrelic-infra-ecs-fargate-example-latest.jsonAdd the single container in this task definition as a sidecar to the task definitions you want monitored.
Next steps:
- Wait a few minutes and then look for your data in the UI.
- Recommended: Install our ECS cloud integration, which gets you other ECS data, including information about clusters and services.
- See recommended alert conditions.
- Understand the AWS resources created by this process.
Manual install
One install option is to manually do the steps that are done by the automatic installer script. We will describe how this is done using the awscli
tool:
Check that your AWS profile points to the same region where your ECS cluster was created:
$ aws configure get region us-east-1 $ aws ecs list-clusters YOUR_CLUSTER_ARNS arn:aws:ecs:us-east-1:YOUR_AWS_ACCOUNT:cluster/YOUR_CLUSTER
Save your New Relic license key as a Systems Manager (SSM) parameter:
aws ssm put-parameter \ --name "/newrelic-infra/ecs/license-key" \ --type SecureString \ --description 'New Relic license key for ECS monitoring' \ --value "NEW_RELIC_LICENSE_KEY"
Create an IAM policy to access the license key parameter:
aws iam create-policy \ --policy-name "NewRelicSSMLicenseKeyReadAccess" \ --policy-document "{"Version"\"2012-10-17","Statement":[{"Effect":"Allow","Action":["ssm:GetParameters"],"Resource":["ARN_OF_LICENSE_KEY_PARAMETER"]}]}" --description "Provides read access to the New Relic SSM license key parameter"
Create an IAM role to be used as the task execution role:
aws iam create-role \--role-name "NewRelicECSTaskExecutionRole" \--assume-role-policy-document '{"Version":"2008-10-17","Statement":[{"Sid":"","Effect":"Allow","Principal":{"Service":"ecs-tasks.amazonaws.com"},"Action":"sts:AssumeRole"}]}' \--description "ECS task execution role for New Relic infrastructure"Attach the policies
NewRelicSSMLicenseKeyReadAccess
,AmazonEC2ContainerServiceforEC2Role
, andAmazonECSTaskExecutionRolePolicy
to the role:aws iam attach-role-policy \ --role-name "NewRelicECSTaskExecutionRole" \ --policy-arn "POLICY_ARN"
Choose your launch type for more instructions:
Next steps:
- Wait a few minutes and then look for your data in the UI.
- Recommended: Install our ECS cloud integration, a separate integration which gets you supplementary ECS data, including information about clusters and services.
- See recommended alert conditions.
- Understand the AWS resources created by this process.
AWS resources created
When you install the ECS integration using default/recommended values, it does the following in AWS:
- Creates Systems Manager (SSM) parameter
/newrelic-infra/ecs/license-key
. This system parameter contains the New Relic license key. - Creates IAM policy
NewRelicSSMLicenseKeyReadAccess
, which enables access to the SSM parameter with the license key. - Creates IAM role
NewRelicECSTaskExecutionRole
used as the task execution role. Policies attached to the role:NewRelicSSMLicenseKeyReadAccess
(created by the installer).AmazonEC2ContainerServiceforEC2Role
AmazonECSTaskExecutionRolePolicy
- For EC2 launch type, this is also done:
- Registers the
newrelic-infra
ECS task definition. - Creates the service
newrelic-infra
for the registered task using a daemon scheduling strategy.
- Registers the
For more help
If you need more help, check out these support and learning resources:
- Browse the Explorers Hub to get help from the community and join in discussions.
- Find answers on our sites and learn how to use our support portal.
- Run New Relic Diagnostics, our troubleshooting tool for Linux, Windows, and macOS.
- Review New Relic's and and documentation.