Instale a integração do ECS

A integração do ECS da New Relic relata e exibe dados de desempenho do seu ambiente Amazon ECS.

Visão geral da instalação

Antes de instalar, pode ser útil entender em alto nível como nosso agente de infraestrutura (newrelic-infra) é implantado para estes dois tipos de lançamento:

• EC2 and EXTERNAL (ECS Anywhere) launch type: A estratégia de agendamento de daemon implanta nosso agente em um cluster ECS como um serviço (explicado aqui na documentação da AWS). Isso instala o agente em todas as instâncias do EC2 do cluster e monitora o ECS e o contêiner Docker.

• AWS Fargate launch type: Em cada tarefa a ser monitorada, nosso agente é implantado como um sidecar. Opcionalmente, é possível saber mais sobre como a AWS define um sidecar.

Opções de instalação

Escolha a instalação desejada:

• Instalar usando AWS CloudFormation
• Instalar usando script automático
• Instale manualmente

Instalar usando CloudFormation

Para ajudar na instalação usando o AWS CloudFormation, são fornecidos alguns modelos do CloudFormation que instalam a integração do ECS na conta da AWS para os tipos de lançamento EC2, EXTERNO (ECS Anywhere) e AWS Fargate.

Para instalar usando CloudFormation:

1. Para registrar a tarefa de integração do ECS, é necessário implantar esta stack. Deve-se garantir a implantação da stack em uma ou mais das regiões desejadas. Esta stack cria os seguintes recursos:

   • Um segredo que armazena a New Relic chave de licença.
   • Uma política para acessar a chave de licença.
   • Uma função de instância a ser usada como uma tarefa ECS ExecutionRole, com acesso à chave de licença.
   • Um registro da tarefa de integração do ECS da New Relic Infrastructure, para o tipo de lançamento EC2 e Externo (ECS Anywhere).

2. Siga as instruções adicionais para o seu tipo de lançamento:

   Tipo de lançamento EC2

   Para criar um serviço que execute a tarefa em cada instância do contêiner EC2, implante esta stack.

   Selecione o tipo de lançamento do EC2. Em seguida, um serviço denominado newrelic-infra será criado no cluster.

   Tipo de lançamento externo (ECS Anywhere)

   Para criar um serviço que execute a tarefa em cada instância do contêiner externo, implante esta stack.

   Selecione o tipo de lançamento EXTERNO. Em seguida, um serviço denominado newrelic-infra-external será criado no cluster.

   Tipo de lançamento AWS Fargate

   1. Baixe o exemplo de definição de tarefa com o contêiner sidecar a ser implantado:

      bash

      Copiar

      $
      curl -O https://download.newrelic.com/infrastructure_agent/integrations/ecs/newrelic-infra-ecs-fargate-example-latest.json

      Dica

      Para Graviton, substitua "cpuArchitecture": "X86_64" por "cpuArchitecture": "ARM64".

   2. Adicione o contêiner newrelic-infra nesta definição de tarefa como um arquivo secundário às definições de tarefa que você deseja monitor. Nesta tarefa de exemplo, o contêiner do seu aplicativo substitui o espaço reservado busybox contêiner.

      Configurar NRIA_IS_FORWARD_ONLY para Fargate

      Ao implantar o agente de infraestrutura da New Relic como um sidecar em ambientes Fargate, é necessário definir a variável de ambiente NRIA_IS_FORWARD_ONLY como true. Esta é uma configuração crítica para a operação adequada em implantações Fargate sem servidor.

      Por que esta configuração é necessária:

   • Evita a criação incorreta de entidade de host: o Fargate é sem servidor e a AWS gerencia os recursos de computar subjacentes. Sem esta configuração, o agente de infraestrutura pode tentar criar entidade de host para uma infraestrutura inexistente.

   • Evita discrepâncias de faturamento: a medição baseada em entidade cobra dos clientes com base no número de entidade monitorada. A criação incorreta de entidade de host causa problemas de faturamento.

   • Habilita a vinculação adequada de APM a contêiner: Essa configuração garante que os aplicativos APM sejam vinculados corretamente a entidades de contêiner, em vez de entidades de Host sintéticas.

     Este exemplo de definição de tarefa inclui a configuração necessária do Fargate:

     {
       "family": "newrelic-infra-fargate",
       "networkMode": "awsvpc",
       "requiresCompatibilities": ["FARGATE"],
       "cpu": "256",
       "memory": "512",
       "containerDefinitions": [
         {
           "name": "newrelic-infra",
           "image": "newrelic/nri-ecs:latest",
           "essential": false,
           "environment": [
             {
               "name": "NRIA_IS_FORWARD_ONLY",
               "value": "true"
             },
             {
               "name": "NRIA_LICENSE_KEY",
               "value": "your-license-key"
             },
             {
               "name": "NRIA_PASSTHROUGH_ENVIRONMENT",
               "value": "ECS_CONTAINER_METADATA_URI,ECS_CONTAINER_METADATA_URI_V4,FARGATE"
             },
             {
               "name": "FARGATE",
               "value": "true"
             }
           ]
         },
         {
           "name": "your-application",
           "image": "your-app-image:latest",
           "essential": true
         }
       ]
     }

     Copiar

     Importante

     A variável de ambiente NRIA_IS_FORWARD_ONLY=true é obrigatória para todas as implantações do Fargate. Omitir essa configuração pode resultar em:

     • Criação incorreta de entidade de host

     • Falhas de relacionamento de APM para contêiner

     • Discrepâncias de faturamento devido a contagens inesperadas de entidade

       Se o exemplo de definição de tarefa for baixado, é necessário verificar se esta variável de ambiente está presente e definida como verdadeira.

   3. Registre a definição de tarefa:

      bash

      Copiar

      $
      aws ecs register-task-definition --cli-input-json file://newrelic-infra-ecs-fargate-example-latest.json

   4. Criar um serviço ou executar uma tarefa usando esta definição de tarefa.

Quando terminar, consulte Próximas etapas.

Instalar com script automático

Uma opção de instalação é usar nosso script de instalação. Para usar o script de instalação automática:

1. Baixe o instalador de integração do ECS:

   bash

   Copiar

   $
   curl -O https://download.newrelic.com/infrastructure_agent/integrations/ecs/newrelic-infra-ecs-installer.sh

2. Adicione permissões de execução ao instalador:

   bash

   Copiar

   $
   chmod +x newrelic-infra-ecs-installer.sh

3. Execute-o com -h para ver a documentação e os requisitos:

   bash

   Copiar

   $
   ./newrelic-infra-ecs-installer.sh -h

4. Verifique se o seu perfil da AWS aponta para a mesma região onde o cluster do ECS foi criado:

   bash

   Copiar

   $
   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

5. Execute o instalador, especificando seu chave de licençae o nome do cluster.

   Tipo de lançamento EC2

   bash

   Copiar

   $
   ./newrelic-infra-ecs-installer.sh -c YOUR_CLUSTER_NAME -l YOUR_LICENSE_KEY

   Tipo de lançamento externo (ECS Anywhere)

   bash

   Copiar

   $
   ./newrelic-infra-ecs-installer.sh -c YOUR_CLUSTER_NAME -l YOUR_LICENSE_KEY -e

   Tipo de lançamento AWS Fargate

   bash

   Copiar

   $
   ./newrelic-infra-ecs-installer.sh -f -c YOUR_CLUSTER_NAME -l YOUR_LICENSE_KEY

6. Etapas adicionais para o tipo de lançamento Fargate (não para o tipo de lançamento EC2):

   • Baixe o exemplo de definição de tarefa com o contêiner sidecar a ser implantado:

     bash

     Copiar

     $
     curl -O https://download.newrelic.com/infrastructure_agent/integrations/ecs/newrelic-infra-ecs-fargate-example-latest.json

     Dica

     Para Graviton, substitua "cpuArchitecture": "X86_64" por "cpuArchitecture": "ARM64".

     Deve-se notar que é necessário usar a função recém-criada, NewRelicECSTaskExecutionRole, como a função de execução da tarefa.

     Esta função inclui as seguintes políticas para todos os tipos de lançamento:

     • NewRelicSSMLicenseKeyReadAccess que permite o acesso ao parâmetro SSM com a chave de licença.
     • AmazonECSTaskExecutionRolePolicy

   • Adicionar o contêiner que se deseja monitorar como um sidecar.

   Importante

   Ao usar o AWS Fargate, também é necessário garantir que o contêiner sidecar tenha a variável de ambiente NRIA_IS_FORWARD_ONLY definida como true dentro da definição de tarefa. Consultar as instruções de configuração do Fargate em CloudFormation para obter detalhes de configuração e o motivo pelo qual esta configuração é crítica.

Quando terminar, consulte Próximas etapas.

Instalação manual

Uma opção de instalação é executar manualmente as etapas que são feitas pelo script instalador automático. Será descrito como isso é feito usando a ferramenta awscli:

1. Verifique se o seu perfil da AWS aponta para a mesma região onde o cluster do ECS foi criado:

   bash

   Copiar

   $
   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

2. Salve seu chave de licençacomo um parâmetro do Systems Manager (SSM):

   bash

   Copiar

   $
   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"

3. Crie uma política IAM para acessar o parâmetro da chave de licença:

   bash

   Copiar

   $
   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"

4. Crie uma função do IAM para ser usada como função de execução de tarefas:

   bash

   Copiar

   $
   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"

5. Anexe as políticas NewRelicSSMLicenseKeyReadAccess e AmazonECSTaskExecutionRolePolicy à função:

   bash

   Copiar

   $
   aws iam attach-role-policy \
   >
     --role-name "NewRelicECSTaskExecutionRole" \
   >
     --policy-arn "POLICY_ARN"

6. Escolha seu tipo de lançamento para obter mais instruções:

   Tipo de lançamento EC2 e Externo (ECS Anywhere)

   Etapas adicionais para o tipo de lançamento EC2:

   1. Baixe o arquivo de modelo de definição de tarefa de integração do New Relic ECS:

      bash

      Copiar

      $
      curl -O https://download.newrelic.com/infrastructure_agent/integrations/ecs/newrelic-infra-ecs-ec2-latest.json

   2. Substitua a função de execução da tarefa no arquivo de modelo pela função recém-criada:

      "executionRoleArn": "NewRelicECSTaskExecutionRole",

      Copiar

   3. Substitua o atributo valueFrom de secret pelo nome do parâmetro do Systems Manager:

      "secrets": [
        {
          "valueFrom": "/newrelic-infra/ecs/license-key",
          "name": "NRIA_LICENSE_KEY"
        }
      ],

      Copiar

   4. Registre o arquivo de definição de tarefa:

      bash

      Copiar

      $
      aws ecs register-task-definition --cli-input-json file://newrelic-infra-ecs-ec2-latest.json

   5. Crie um serviço com a estratégia de agendamento do daemon para a tarefa registrada:

      Para tipo de lançamento EC2:

      bash

      Copiar

      $
      aws ecs create-service --cluster "YOUR_CLUSTER_NAME" --service-name "newrelic-infra" --task-definition "newrelic-infra" --scheduling-strategy DAEMON --launch-type EC2

      Para tipo de lançamento EXTERNO (ECS Anywhere):

      bash

      Copiar

      $
      aws ecs create-service --cluster "YOUR_CLUSTER_NAME" --service-name "newrelic-infra-external" --task-definition "newrelic-infra" --scheduling-strategy DAEMON --launch-type EXTERNAL

   Tipo de lançamento AWS Fargate

   Etapas adicionais para o tipo de lançamento AWS Fargate:

   1. Baixe o exemplo de definição de tarefa com o contêiner sidecar a ser implantado:

      bash

      Copiar

      $
      curl -O https://download.newrelic.com/infrastructure_agent/integrations/ecs/newrelic-infra-ecs-fargate-example-latest.json

      Dica

      Para Graviton, substitua "cpuArchitecture": "X86_64" por "cpuArchitecture": "ARM64".

   2. Adicione o contêiner newrelic-infra nesta definição de tarefa como um arquivo secundário às definições de tarefa que você deseja monitor. Nesta tarefa de exemplo, o contêiner do seu aplicativo substitui o espaço reservado busybox contêiner.

      Importante

      É necessário garantir a configuração da variável de ambiente NRIA_IS_FORWARD_ONLY para true nas configurações do contêiner sidecar da definição de tarefa editada manualmente. Consultar a seção CloudFormation Fargate para obter instruções detalhadas e um exemplo JSON completo.

Quando terminar, consulte Próximas etapas.

Próximas etapas após a instalação

Depois de instalar esta integração:

• Aguarde alguns minutos e procure seus dados na interface.
• Instale nossa integração na nuvem do ECS recomendada, que fornece outros dados do ECS, incluindo informações sobre cluster e serviços.
• Consulte condição recomendada do alerta.
• Entenda os recursos da AWS criados por esse processo.

Recursos AWS criados

Quando você instala a integração do ECS usando valores padrão/recomendados, ela faz o seguinte na AWS:

• Cria o parâmetro /newrelic-infra/ecs/license-key do Systems Manager (SSM). Este parâmetro do sistema contém a New Relic chave de licença.

• Cria a política IAM NewRelicSSMLicenseKeyReadAccess, que permite acesso ao parâmetro SSM com a chave de licença.

• Cria a função do IAM NewRelicECSTaskExecutionRole usada como a função de execução da tarefa. Esta função inclui as seguintes políticas:

  • NewRelicSSMLicenseKeyReadAccess (criado pelo instalador).
  • AmazonECSTaskExecutionRolePolicy

• Registra a definição de tarefa newrelic-infra do ECS para os tipos de lançamento EC2 e externo (ECS Anywhere).

• Cria o seguinte para o tipo de lançamento do EC2:

  • O serviço newrelic-infra para a tarefa registrada, usando uma estratégia de agendamento daemon e tipo de lançamento EC2.

• Cria o seguinte para o tipo de lançamento EXTERNAL (ECS Anywhere):

  • O serviço newrelic-infra-external para a tarefa registrada, usando uma estratégia de agendamento daemon e tipo de lançamento EXTERNO (ECS Anywhere).