Skip to content

Latest commit

 

History

History
107 lines (88 loc) · 5.45 KB

ecs-demo.md

File metadata and controls

107 lines (88 loc) · 5.45 KB
Raw

Using AWS-Observability-Collector on Amazon ECS

This example will introduce how to use AWS-Observability-Collector to send application traces and metrics on AWS ECS. This instruction provided the data emitter image that will generate OTLP format of metrics and traces data to AWS CloudWatch and X-Ray consoles. Please follow the steps below to try AWS Observability Collector Beta.

  • Install AWS-Observability-Collector via Task Definition Template
  • Install AWS-Observability-Collector via CloudFormation Template

Install AOC via Task Definition Template Steps

Create ECS-AWSObservability IAM Policy

  1. Open the IAM console at https://console.aws.amazon.com/iam/.
  2. In the navigation pane, choose Policies.
  3. Choose Create policy, JSON.
  4. Enter the following policy:
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "logs:CreateLogGroup",
                "logs:CreateLogStream",
                "logs:PutLogEvents",
                "logs:DescribeLogStreams",
                "xray:*",
                "s3:*"
            ],
            "Resource": [
                "arn:aws:logs:*:*:*"
            ]
        }
    ]
}
  1. Choose Review policy.
  2. On the Review policy page, enter ECS-AWSObservability for the Name and choose Create policy.

Create ECS-AWSObservability IAM Role

  1. Open the IAM console at https://console.aws.amazon.com/iam/.
  2. In the navigation pane, choose Roles, Create role.
  3. In the Select type of trusted entity section, choose AWS service.
  4. For Choose a use case, choose Elastic Container Service.
  5. For Select your use case, choose Elastic Container Service Task, then choose Next: Tags.
  6. Choose Next: Review.
  7. On the Review page, enter ECS-AWSObservability for the Name and choose Create role.

Install AOC on Amazon ECS as sidecar

The easiest way to deploy AOC on Amazon ECS is to run it as a sidecar, defining it in the same task definition as your application.

ECS Fargate Template
You can find ECS Fargate AOC Installing template. Instructions for setting up a service in your ECS cluster using Fargate can be found here.

ECS EC2 Template
Another example is installing AOC on ECS EC2 instance as sidecar to send telemetry data. You can find ECS EC2 AOC Installing template. Instructions for setting up a service in your ECS cluster using EC2 can be found here.

Configure The Task Definition
The two ECS task definition templates are provided to run AWS-Observability-Collector as sidecar to send application metrics and traces on Amazon ECS. Notice that in the task definition templates we provided, you have to replace {{region}} with the region your want to send the data to. Fill {{ecsTaskRoleArn}} and {{ecsExecutionRoleArn}} with the IAM role (ECS-AWSObservability) you created above.

In the task definition, we run two applications: the customer’s application (aoc-emitter) and the AOC aoc-collector. Running the AOC in the same application as the main application allows the AOC to collect the metric/trace data for the customer’s application. We also call running the AOC in this way a "Sidecar".

View Your Metrics
You should now be able to view your metrics in your CloudWatch console. In the navigation bar, click on Metrics. The collected AOC metrics can be found in the AWSObservability/CloudWatchOTService namespace. Ensure that your region is set to the region set for your cluster.

Install AOC via CloudFormation Template Steps

Prerequisite

To Install AOC Via CloudFormation, you have to manually create an ECS cluster on your AWS console first.

Install AOC on ECS EC2

Download CloudFormation template file for installing AOC on ECS EC2 mode

curl -O https://github.com/mxiamxia/aws-opentelemetry-collector/blob/master/deployment-template/ecs/aoc-ec2-sidecar-deployment-cfn.template

Run CloudFormation the following command once Cluster_Name, AWS_Region and CFN_File_Downloaded are filled.

ClusterName=<Cluster_Name>
Region=<AWS_Region>
aws cloudformation create-stack --stack-name AOCECS-${ClusterName}-${Region} \
    --template-body file:https://<CFN_File_Downloaded> \
    --parameters ParameterKey=ClusterName,ParameterValue=${ClusterName} \
                 ParameterKey=CreateIAMRoles,ParameterValue=false \
    --capabilities CAPABILITY_NAMED_IAM \
    --region ${Region}

Install AOC on ECS Fargate

Download CloudFormation template file for installing AOC on ECS Fargate mode

curl -O https://github.com/mxiamxia/aws-opentelemetry-collector/blob/master/deployment-template/ecs/aoc-fargate-sidecar-deployment-cfn.template

Run CloudFormation the following command once Cluster_Name, AWS_Region and CFN_File_Downloaded are filled.

ClusterName=<Cluster_Name>
Region=<AWS_Region>
aws cloudformation create-stack --stack-name AOCECS-${ClusterName}-${Region} \
    --template-body file:https://<CFN_File_Downloaded> \
    --parameters ParameterKey=ClusterName,ParameterValue=${ClusterName} \
                 ParameterKey=CreateIAMRoles,ParameterValue=false \
    --capabilities CAPABILITY_NAMED_IAM \
    --region ${Region}