AWS CloudWatch Agent配置日志路径插入EC2实例ID不生效问题

问题根因与解决方案 #

你使用的${aws:InstanceId}是CloudWatch Agent的官方内置变量，配置不生效通常是以下几个原因导致的，对应解决方案如下：

• 原因1：Agent版本过低
  该内置变量仅在1.247349.0及以上版本的CloudWatch Agent中支持，先执行以下命令检查版本：

  /opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent --version
  

  版本低于要求直接升级到最新版即可。
• 原因2：实例无法访问元数据服务
  CloudWatch Agent需要调用EC2实例元数据服务（IMDS）获取实例ID，如果你禁用了IMDS，或者配置了IMDS访问限制，会导致变量替换失败。可以在实例上执行以下命令验证能否正常获取实例ID：

  curl -s http://169.254.169.254/latest/meta-data/instance-id
  

  无法返回正常实例ID的话，先放开IMDS访问权限。
• 原因3：配置被转义
  如果你是通过SSM参数存储下发的配置，需要确认下发到实例本地的配置文件中${aws:InstanceId}没有被转义为\${aws:InstanceId}，转义后的写法无法被Agent识别为变量。
• 原因4：全局配置冲突
  你当前配置中存在全局的"log_stream_name": "raw_stream"配置，虽然单个收集项的配置优先级更高，建议删除无用的全局配置避免不必要的冲突。

兜底生效方案 #

如果以上方案都无法解决，可以通过实例启动脚本（UserData）动态替换配置占位符，100%兼容所有Agent版本：

1. 把配置文件中的实例ID位置改为自定义占位符：

   "log_group_name": "/asg/raw/{{INSTANCE_ID}}",
   

2. 在实例UserData中增加以下逻辑，实例启动时自动替换占位符再启动Agent：

   # 拉取实例ID
   INSTANCE_ID=$(curl -s http://169.254.169.254/latest/meta-data/instance-id)
   # 替换配置文件占位符
   sed -i "s/{{INSTANCE_ID}}/$INSTANCE_ID/g" /opt/aws/amazon-cloudwatch-agent/etc/amazon-cloudwatch-agent.json
   # 重启Agent加载配置
   systemctl restart amazon-cloudwatch-agent
   

修改完配置后可以查看Agent运行日志排查错误：

tail -f /opt/aws/amazon-cloudwatch-agent/logs/amazon-cloudwatch-agent.log

内容的提问来源于stack exchange，提问作者DirectRaw