Skip to content

Commit 73cce39

Browse files
committed
Modify CFN example
1 parent b725239 commit 73cce39

File tree

4 files changed

+24
-19
lines changed

4 files changed

+24
-19
lines changed

src/docs/setup/ecs/cfn-for-ecs-ec2-instance.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ curl -O https://raw.githubusercontent.com/aws-observability/aws-otel-collector/m
2828
* `Cluster_Name` - ECS Cluster name setup in Prerequisite step
2929
* `AWS_Region` - Region the data will be sent
3030
* `PATH_TO_CloudFormation_TEMPLATE` - CFN template path downloaded in Step 1
31-
* `command` - Assign value to the command variable to select the config file path; the AWS Collector
31+
* `command` - Assign value to the command variable to select the config file path; the ADOT Collector
3232
`--config=/etc/ecs/otel-instance-metrics-config.yaml` - To consume ECS EC2 instance metrics
3333
```console lineNumbers=true
3434
ClusterName=<Cluster_Name>

src/docs/setup/ecs/cfn-for-ecs-ec2.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ curl -O https://raw.githubusercontent.com/aws-observability/aws-otel-collector/m
3030
* `Cluster_Name` - ECS Cluster name setup in Prerequisite step
3131
* `AWS_Region` - Region the data will be sent
3232
* `PATH_TO_CloudFormation_TEMPLATE` - CFN template path downloaded in Step 1
33-
* `command` - Assign value to the command variable to select the config file path; the AWS Collector comes with
34-
two configs baked in for ECS customers (choose one of them based on your requirements):
35-
`--config=/etc/ecs/ecs-default-config.yaml` - To consume StatsD metrics, OTLP metrics/traces and X-Ray SDK traces (custom application metrics/traces)
36-
`--config=/etc/ecs/container-insights/otel-task-metrics-config.yaml` - To Use StatsD, OTLP, Xray and Container Resource utilization metrics
33+
* `command` - Assign value to the command variable to select the config file path; the ADOT Collector comes with two configs baked in for ECS customers (choose one of them based on your requirements):
34+
** `--config=/etc/ecs/ecs-default-config.yaml` - To consume StatsD metrics, OTLP metrics/traces and X-Ray SDK traces (custom application metrics/traces)
35+
** `--config=/etc/ecs/container-insights/otel-task-metrics-config.yaml` - To Use StatsD, OTLP, Xray and Container Resource utilization metrics
36+
3737
```console lineNumbers=true
3838
ClusterName=<Cluster_Name>
3939
Region=<AWS_Region>

src/docs/setup/ecs/cfn-for-ecs-fargate.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,18 @@ curl -O https://raw.githubusercontent.com/aws-observability/aws-otel-collector/m
3131
* `AWS_Region` - Region the data will be sent
3232
* `PATH_TO_CloudFormation_TEMPLATE` - CFN template path downloaded in Step 1
3333
* `Security_Groups` - the security group for your ECS Fargate Task
34-
* `Subnets` - the subnet your ECS Fargate task is running (*ex: Subnets=SubnetID1\\\,SubnetID2*)
35-
* `command` - Assign value to the command variable to select the config file path; the AWS Collector comes with
36-
two configs baked in for ECS customers (choose one of them based on your purpose):
37-
`--config=/etc/ecs/ecs-default-config.yaml` - To consume StatsD metrics, OTLP metrics/traces and X-Ray SDK traces (custom application metrics/traces)
38-
`--config=/etc/ecs/container-insights/otel-task-metrics-config.yaml` - To Use StatsD, OTLP, Xray and Container Resource utilization metrics
34+
* `Subnets` - the subnet your ECS Fargate task is running (Ex: Subnets=SubnetID1\\\\,SubnetID2)
35+
* `command` - Assign value to the command variable to select the config file path; the ADOT Collector comes with two configs baked in for ECS customers (choose one of them based on your purpose):
36+
* `--config=/etc/ecs/ecs-default-config.yaml` - To consume StatsD metrics, OTLP metrics/traces and X-Ray SDK traces (custom application metrics/traces)
37+
* `--config=/etc/ecs/container-insights/otel-task-metrics-config.yaml` - To Use StatsD, OTLP, Xray and Container Resource utilization metrics
38+
3939
```console lineNumbers=true
4040
ClusterName=<Cluster_Name>
4141
Region=<AWS_Region>
4242
SecurityGroups=<Security_Groups>
4343
Subnets=<Subnets>
4444
command=<command>
45-
aws cloudformation create-stack --stack-name AOCECS-${ClusterName}-${Region} \
45+
aws cloudformation create-stack --stack-name ADOTECS-${ClusterName}-${Region} \
4646
--template-body file://<PATH_TO_CloudFormation_TEMPLATE> \
4747
--parameters ParameterKey=ClusterName,ParameterValue=${ClusterName} \
4848
ParameterKey=CreateIAMRoles,ParameterValue=True \

src/docs/setup/eks.mdx

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import img11 from "assets/img/docs/img11.png"
1515
import img12 from "assets/img/docs/img12.png"
1616
import img13 from "assets/img/docs/img13.png"
1717

18-
In this tutorial, we will demonstrate how to run the AWS Distro for OpenTelemetry(ADOT Collector) Collector as
18+
In this tutorial, we will demonstrate how to run the AWS Distro for OpenTelemetry(ADOT) Collector as
1919
sidecar on the Amazon Elastic Kubernetes Service (Amazon EKS).
2020

2121
<SectionSeparator />
@@ -40,15 +40,17 @@ Sidecar is a microservice design pattern where a companion service runs next to
4040
abilities or intercepting resources it is utilizing. We recommend deploying ADOT Collector on Amazon EKS as a sidecar,
4141
defining it in the same task definition as your application. This allows the ADOT Collector to collect the metric and
4242
trace data for the application.
43+
4344
1. Create a Kubernetes namespace.
4445
```
4546
kubectl create namespace aws-otel-eks
4647
```
47-
2. An example configuration template can be
48-
found [under examples in the AWS Distro for OpenTelemetry Collector GitHub](https://github.com/aws-observability/aws-otel-collector/blob/main/examples/eks/aws-cloudwatch/otel-sidecar.yaml).
49-
Replace `{{aws-otelImage}}` with the name of the ADOT Collector Docker image you built
50-
(For example, `aottestbed/awscollector:v0.1.12`), and `{{region}}` with the name of the Region where the logs are published (For example, `us-west-2`).
48+
2. An example configuration template can be found under [examples here](https://github.com/aws-observability/aws-otel-collector/blob/main/examples/eks/aws-cloudwatch/otel-sidecar.yaml) in the AWS Distro for OpenTelemetry Collector GitHub Repo.
49+
* In this example you can replace [image](https://github.com/aws-observability/aws-otel-collector/blob/main/examples/eks/aws-cloudwatch/otel-sidecar.yaml#L41) with ADOT Collector Docker image you built
50+
(Ex:`amazon/aws-otel-collector:latest`), and `AWS_REGION` with the name of the region where the logs are published (Ex: `us-west-2`).
51+
5152
3. Deploy the application.
53+
5254
```
5355
kubectl apply -f https://raw.githubusercontent.com/aws-observability/aws-otel-collector/main/examples/eks/aws-cloudwatch/otel-sidecar.yaml
5456
```
@@ -57,17 +59,20 @@ kubectl apply -f https://raw.githubusercontent.com/aws-observability/aws-otel-co
5759
kubectl get all -n aws-otel-eks
5860
```
5961
<img src={img11} alt="Diagram" style="margin: 30px 0;" />
62+
6063
5. View the details of the deployed deployment.
64+
6165
```
6266
kubectl -n aws-otel-eks describe deployment aws-otel-eks-sidecar
6367
```
68+
6469
<img src={img12} alt="Diagram" style="margin: 30px 0;" />
65-
The example template runs the AWS-OTel-Collector as a sidecar to send application metrics and traces on Amazon EKS.
70+
71+
The example template runs the ADOT Collector as a sidecar to send application metrics and traces on Amazon EKS.
6672
We run two applications: the main application (`aws-otel-emitter`) and the ADOT Collector (`aws-otel-collector`).
6773
After the setup is finished, we should see the following sample metrics in Amazon CloudWatch console.
6874
<img src={img13} alt="Diagram" style="margin: 30px 0;" />
6975

70-
<div style="height: 40px" />
7176

72-
**Notes**
77+
**Note** :
7378
After you’ve finished the tutorial, remember to shut down the new EKS cluster created in the tutorial in order to avoid additional charges.

0 commit comments

Comments
 (0)