making the ECS init log level configurable #4097

Yiyuanzzz · 2024-02-20T23:43:23Z

Summary

Currently, the ECS agent logging level can be configured using the ECS_LOGLEVEL option. The ECS init does not honor this option and always logs at info level only. This pr is to address this gap and make the ECS init log level configurable as well.

Implementation details

Removed scripts/bundle_log_config.sh and create logger file based on our existing logger file under ecs-init/volumes/logger
ECS init logging level can also be configured using the ECS_LOGLEVEL env variable
Example logs

level=info time=2024-02-23T03:28:11Z msg="pre-start: enabling loopback routing"
level=debug time=2024-02-23T03:28:11Z msg="testing"
level=info time=2024-02-23T03:28:11Z msg="pre-start: disabling ipv6 router advertisements"
level=debug time=2024-02-23T03:28:11Z msg="testing"
level=info time=2024-02-23T03:28:11Z msg="pre-start: creating credentials proxy route"
level=debug time=2024-02-23T03:28:11Z msg="testing"
level=info time=2024-02-23T03:28:11Z msg="pre-start: checking ecs agent container image loaded presence"
level=info time=2024-02-23T03:28:11Z msg="pre-start: ecs agent co

Testing

Launched an instance with ECS_INIT_LOGLEVEL=debug and checked ecs-init.log is expected

New tests cover the changes: yes

Description for the changelog

Enhancement - make the ECS init log level configurable

Licensing

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

prateekchaudhry · 2024-02-23T22:22:30Z

README.md

@@ -259,6 +259,7 @@ additional details on each available environment variable.
 | `ECS_DYNAMIC_HOST_PORT_RANGE` | `100-200` | This specifies the dynamic host port range that the agent uses to assign host ports from, for container ports mapping. If there are no available ports in the range for containers, including customer containers and Service Connect Agent containers (if Service Connect is enabled), service deployments would fail. | Defined by `/proc/sys/net/ipv4/ip_local_port_range` | `49152-65535` |
 | `ECS_TASK_PIDS_LIMIT` | `100` | Specifies the per-task pids limit cgroup setting for each task launched on the container instance. This setting maps to the pids.max cgroup setting at the ECS task level. See https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html#pid. If unset, pids will be unlimited. Min value is 1 and max value is 4194304 (4*1024*1024) | `unset` | Not Supported on Windows |
 | `ECS_EBSTA_SUPPORTED` | `true` | Whether to use the container instance with EBS Task Attach support. ecs-init sets this variable for the ECS Agent if the instance can support mounting EBS volumes or not. ECS only schedules EBSTA tasks if this feature is supported by the platform type | `true` | `true` |
+| `ECS_INIT_LOGLEVEL`  | &lt;crit&gt; &#124; &lt;error&gt; &#124; &lt;warn&gt; &#124; &lt;info&gt; &#124; &lt;debug&gt; | The level of detail to be logged. | info | info |


I understand this is an ecs-init config? This should probably be added to the ecs-init variables table below

I see, will move it to table below

why introduce a new var and not re-use ECS_LOGLEVEL?

good call out, re-use ECS_LOGLEVEL would be a better idea, will do

prateekchaudhry · 2024-02-23T22:26:10Z

ecs-init/logger/log.go

@@ -0,0 +1,118 @@
+// Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.


The year seems to vary with files, and many files do not have it. Can the year be removed?

sure! will remove it

prateekchaudhry · 2024-02-23T22:32:42Z

ecs-init/logger/log.go

+package logger
+
+import (
+	"fmt"


nit: maybe standard library imports can be imported together as a block first followed by other imports, following go styleguide

got it thanks!

sparrc · 2024-02-23T23:13:52Z

I am wondering why don't we just use the existing ECS_LOGLEVEL and apply it to the init process too? Doesn't seem particularly high-risk to add slightly more scope to that env var

Yiyuanzzz added the bot/test label Feb 20, 2024

Yiyuanzzz requested a review from a team as a code owner February 20, 2024 23:43

amazon-ecs-bot removed the bot/test label Feb 20, 2024

Yiyuanzzz force-pushed the ecs-init-log branch from 4066c2a to cc2a5c1 Compare February 21, 2024 00:12

Yiyuanzzz added the bot/test label Feb 22, 2024

amazon-ecs-bot removed the bot/test label Feb 22, 2024

Yiyuanzzz force-pushed the ecs-init-log branch 2 times, most recently from f88f044 to b75d09a Compare February 22, 2024 22:42

Yiyuanzzz changed the title ~~[WIP]making the ECS init log level configurable~~ making the ECS init log level configurable Feb 22, 2024

Yiyuanzzz force-pushed the ecs-init-log branch 2 times, most recently from 5842a03 to f9d4ee0 Compare February 23, 2024 03:59