Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding content for ECS healthcheck setup instructions for collector #382

Merged
merged 4 commits into from
May 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions src/docs/setup/ecs/create-task-definition-console.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import task3 from "assets/img/docs/setup/ecs/create-task-definition/taskdefiniti
import task4 from "assets/img/docs/setup/ecs/create-task-definition/taskdefinition4.png"
import task5 from "assets/img/docs/setup/ecs/create-task-definition/taskdefinition5.png"
import task6 from "assets/img/docs/setup/ecs/create-task-definition/taskdefinition6.png"
import task_06 from "assets/img/docs/setup/ecs/create-task-definition/taskdefinition_06.png"
import task7 from "assets/img/docs/setup/ecs/create-task-definition/taskdefinition7.png"
import task8 from "assets/img/docs/setup/ecs/create-task-definition/taskdefinition8.png"
import task9 from "assets/img/docs/setup/ecs/create-task-definition/taskdefinition9.png"
Expand All @@ -33,6 +34,7 @@ import task22 from "assets/img/docs/setup/ecs/create-task-definition/taskdefinit
import task23 from "assets/img/docs/setup/ecs/create-task-definition/taskdefinition23.png"
import task24 from "assets/img/docs/setup/ecs/create-task-definition/taskdefinition24.png"


In this tutorial, we will demonstrate how to install ADOT Collector using Task Definition on the Amazon Elastic
Container Service (Amazon ECS) through AWS console.

Expand Down Expand Up @@ -61,6 +63,9 @@ Select Network Mode to `awsvpc`
Put a container name (i.e. *aws-otel-collector*) and use the *amazon/aws-otel-collector* container image.
We can keep everything else default
<img src={task6} alt="Diagram" style="margin: 30px 0;" />
[Optional] In the 'Advanced container configuration' section, let's setup the HealthCheck instructions for aws-otel-collector.
Provide the '/healthcheck' command and enter 5s as interval, 6s as Timeout, 1s as Start period, and 5 as Retries.
<img src={task_06} alt="Diagram" style="margin: 30px 0;" />
7. Set up the OpenTelemetry configuration file for AWS Observability Toolkit (AOT)
In this section we will set the OpenTelemetry configuration file for our Collector container (ADOT Collector). All the functionality
of AOC is passive, if your application doesn’t emit the data to the port (X-ray use UDP 2000, OTLP use TCP 4317 and 4318, StatsD use UDP 8125) then there will be no effect.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import task3 from "assets/img/docs/setup/ecs/create-task-definition/taskdefiniti
import task4 from "assets/img/docs/setup/ecs/create-task-definition/taskdefinition4.png"
import task5 from "assets/img/docs/setup/ecs/create-task-definition/taskdefinition5.png"
import task6 from "assets/img/docs/setup/ecs/create-task-definition/taskdefinition6.png"
import task_06 from "assets/img/docs/setup/ecs/create-task-definition/taskdefinition_06.png"
import task7 from "assets/img/docs/setup/ecs/create-task-definition/taskdefinition7.png"
import task8 from "assets/img/docs/setup/ecs/create-task-definition/taskdefinition8.png"
import task9 from "assets/img/docs/setup/ecs/create-task-definition/taskdefinition9.png"
Expand Down Expand Up @@ -68,6 +69,9 @@ Mention task memory and task cpu for your task-definition like use 2048 for mem
Put a container name (i.e. *aws-otel-collector*) and use the *amazon/aws-otel-collector* container image.
We can keep everything else default
<img src={task6} alt="Diagram" style="margin: 30px 0;" />
[Optional] In the 'Advanced container configuration' section, let's setup the HealthCheck instructions for aws-otel-collector.
Provide the '/healthcheck' command and enter 5s as interval, 6s as Timeout, 1s as Start period, and 5 as Retries.
<img src={task_06} alt="Diagram" style="margin: 30px 0;" />

8. Set up the OpenTelemetry configuration file for AWS Observability Toolkit (AOT):
In the Environment Command section add `--config=/etc/ecs/otel-instance-metrics-config.yaml` to select the ECS default configuration
Expand Down