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.

Sign up for GitHub

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

init: Extracts Availability Zone from ECS Task Metadata. #539

Merged
merged 2 commits into from
Mar 1, 2023
Merged

init: Extracts Availability Zone from ECS Task Metadata. #539

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d811d6a
Extracts Availability Zone from ECS Task Metadata.
johnjameswhitman Feb 4, 2023
60c7735
Fixes tests.
johnjameswhitman Feb 4, 2023
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
17 changes: 9 additions & 8 deletions init/fluent_bit_init_process.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,15 @@ type S3Downloader interface {

// all values in the structure are empty strings by default
type ECSTaskMetadata struct {
AWS_REGION string `json:"AWSRegion"`
ECS_CLUSTER string `json:"Cluster"` // Cluster name
ECS_TASK_ARN string `json:"TaskARN"`
ECS_TASK_ID string `json:"TaskID"`
ECS_FAMILY string `json:"Family"`
ECS_LAUNCH_TYPE string `json:"LaunchType"` // Task launch type will be an empty string if container agent is under version 1.45.0
ECS_REVISION string `json:"Revision"` // Revision number
ECS_TASK_DEFINITION string `json:"TaskDefinition"` // TaskDefinition = "family:revision"
AWS_REGION string `json:"AWSRegion"`
AWS_AVAILABILITY_ZONE string `json:"AvailabilityZone"`
ECS_CLUSTER string `json:"Cluster"` // Cluster name
ECS_TASK_ARN string `json:"TaskARN"`
ECS_TASK_ID string `json:"TaskID"`
ECS_FAMILY string `json:"Family"`
ECS_LAUNCH_TYPE string `json:"LaunchType"` // Task launch type will be an empty string if container agent is under version 1.45.0
ECS_REVISION string `json:"Revision"` // Revision number
ECS_TASK_DEFINITION string `json:"TaskDefinition"` // TaskDefinition = "family:revision"
}

// get ECS Task Metadata via endpoint V4
Expand Down
90 changes: 48 additions & 42 deletions init/fluent_bit_init_process_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,15 @@ func TestGetECSTaskMetadata(t *testing.T) {
actualOutput1 := getECSTaskMetadata(&client1)

expectedOutput1 := ECSTaskMetadata{
AWS_REGION: "us-west-2",
ECS_CLUSTER: "ecs-cluster",
ECS_TASK_ARN: "arn:aws:ecs:us-west-2:123456789123:task/ecs-cluster/4ca5a280e68947cd84a8357f0d008fb5",
ECS_TASK_ID: "4ca5a280e68947cd84a8357f0d008fb5",
ECS_FAMILY: "code_test_A",
ECS_LAUNCH_TYPE: "EC2",
ECS_REVISION: "35",
ECS_TASK_DEFINITION: "code_test_A:35",
AWS_REGION: "us-west-2",
AWS_AVAILABILITY_ZONE: "us-west-2a",
ECS_CLUSTER: "ecs-cluster",
ECS_TASK_ARN: "arn:aws:ecs:us-west-2:123456789123:task/ecs-cluster/4ca5a280e68947cd84a8357f0d008fb5",
ECS_TASK_ID: "4ca5a280e68947cd84a8357f0d008fb5",
ECS_FAMILY: "code_test_A",
ECS_LAUNCH_TYPE: "EC2",
ECS_REVISION: "35",
ECS_TASK_DEFINITION: "code_test_A:35",
}

assert.Equal(t, actualOutput1, expectedOutput1)
Expand All @@ -52,14 +53,15 @@ func TestGetECSTaskMetadata(t *testing.T) {
actualOutput2 := getECSTaskMetadata(&client2)

expectedOutput2 := ECSTaskMetadata{
AWS_REGION: "us-west-2",
ECS_CLUSTER: "ecs-cluster",
ECS_TASK_ARN: "arn:aws:ecs:us-west-2:123456789123:task/ecs-cluster/4ca5a280e68947cd84a8357f0d008fb5",
ECS_TASK_ID: "4ca5a280e68947cd84a8357f0d008fb5",
ECS_FAMILY: "code_test_A",
ECS_LAUNCH_TYPE: "", // empty lunch type
ECS_REVISION: "35",
ECS_TASK_DEFINITION: "code_test_A:35",
AWS_REGION: "us-west-2",
AWS_AVAILABILITY_ZONE: "us-west-2a",
ECS_CLUSTER: "ecs-cluster",
ECS_TASK_ARN: "arn:aws:ecs:us-west-2:123456789123:task/ecs-cluster/4ca5a280e68947cd84a8357f0d008fb5",
ECS_TASK_ID: "4ca5a280e68947cd84a8357f0d008fb5",
ECS_FAMILY: "code_test_A",
ECS_LAUNCH_TYPE: "", // empty lunch type
ECS_REVISION: "35",
ECS_TASK_DEFINITION: "code_test_A:35",
}

assert.Equal(t, actualOutput2, expectedOutput2)
Expand All @@ -74,14 +76,15 @@ func TestGetECSTaskMetadata(t *testing.T) {
actualOutput3 := getECSTaskMetadata(&client3)

expectedOutput3 := ECSTaskMetadata{
AWS_REGION: "",
ECS_CLUSTER: "",
ECS_TASK_ARN: "",
ECS_TASK_ID: "",
ECS_FAMILY: "",
ECS_LAUNCH_TYPE: "",
ECS_REVISION: "",
ECS_TASK_DEFINITION: "",
AWS_REGION: "",
AWS_AVAILABILITY_ZONE: "",
ECS_CLUSTER: "",
ECS_TASK_ARN: "",
ECS_TASK_ID: "",
ECS_FAMILY: "",
ECS_LAUNCH_TYPE: "",
ECS_REVISION: "",
ECS_TASK_DEFINITION: "",
}

assert.Equal(t, actualOutput3, expectedOutput3)
Expand All @@ -94,18 +97,20 @@ func TestSetECSTaskMetadata(t *testing.T) {

// Test case 1: full metadata
metadataTest1 := ECSTaskMetadata{
AWS_REGION: "us-west-2",
ECS_CLUSTER: "ecs-Test",
ECS_TASK_ARN: "arn:aws:ecs:us-west-2:111:task/ecs-local-cluster/37e8",
ECS_TASK_ID: "56461",
ECS_FAMILY: "esc-task-definition",
ECS_LAUNCH_TYPE: "EC2",
ECS_REVISION: "1",
ECS_TASK_DEFINITION: "esc-task-definition:1",
AWS_REGION: "us-west-2",
AWS_AVAILABILITY_ZONE: "us-west-2a",
ECS_CLUSTER: "ecs-Test",
ECS_TASK_ARN: "arn:aws:ecs:us-west-2:111:task/ecs-local-cluster/37e8",
ECS_TASK_ID: "56461",
ECS_FAMILY: "esc-task-definition",
ECS_LAUNCH_TYPE: "EC2",
ECS_REVISION: "1",
ECS_TASK_DEFINITION: "esc-task-definition:1",
}

expectedContent1 := "export FLB_AWS_USER_AGENT=init\n" +
expectedContent1 := "export FLB_AWS_USER_AGENT=ecs-init\n" +
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default for this value appears to have changed in db3fd7f.

"export AWS_REGION=us-west-2\n" +
"export AWS_AVAILABILITY_ZONE=us-west-2a\n" +
"export ECS_CLUSTER=ecs-Test\n" +
"export ECS_TASK_ARN=arn:aws:ecs:us-west-2:111:task/ecs-local-cluster/37e8\n" +
"export ECS_TASK_ID=56461\n" +
Expand All @@ -119,17 +124,18 @@ func TestSetECSTaskMetadata(t *testing.T) {

// Test case 2: some environment variables is empty
metadataTest2 := ECSTaskMetadata{
AWS_REGION: "us-west-1",
ECS_CLUSTER: "ecs-Test",
ECS_TASK_ARN: "",
ECS_TASK_ID: "",
ECS_FAMILY: "",
ECS_LAUNCH_TYPE: "",
ECS_REVISION: "",
ECS_TASK_DEFINITION: "",
AWS_REGION: "us-west-1",
AWS_AVAILABILITY_ZONE: "",
ECS_CLUSTER: "ecs-Test",
ECS_TASK_ARN: "",
ECS_TASK_ID: "",
ECS_FAMILY: "",
ECS_LAUNCH_TYPE: "",
ECS_REVISION: "",
ECS_TASK_DEFINITION: "",
}

expectedContent2 := "export FLB_AWS_USER_AGENT=init\n" +
expectedContent2 := "export FLB_AWS_USER_AGENT=ecs-init\n" +
"export AWS_REGION=us-west-1\n" +
"export ECS_CLUSTER=ecs-Test\n"

Expand Down
4 changes: 2 additions & 2 deletions use_cases/init-process-for-fluent-bit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,8 @@ The init process also injects ECS Task Metadata into the Fluent Bit container as
The init process injects ECS Task Metadata into the Fluent Bit container as environment variables:

```
AWS_REGION / ECS_LAUNCH_TYPE / ECS_CLUSTER / ECS_FAMILY
ECS_TASK_ARN / ECS_TASK_ID / ECS_REVISION / ECS_TASK_DEFINITION
AWS_REGION / AWS_AVAILABILITY_ZONE / ECS_LAUNCH_TYPE / ECS_CLUSTER
ECS_FAMILY / ECS_TASK_ARN / ECS_TASK_ID / ECS_REVISION / ECS_TASK_DEFINITION
```

You can use them as env vars directly in the Fluent Bit config.
Expand Down