signiant/logspout-ecs

logspout-ecs

镜像概述和主要用途

logspout-ecs是logspout容器的特化版本，针对AWS ECS（Elastic Container Service）环境优化。通过修改logspout的默认行为，该镜像能够从EC2元数据中获取实例ID，并将其附加到指定的syslog主机名中，解决了在ECS集群中难以通过日志识别容器所在节点的问题。主要用于在ECS环境中发送容器日志时，清晰标识日志来源的集群节点。

核心功能和特性

• EC2实例ID集成：运行预启动shell脚本，自动从EC2元数据服务获取当前实例ID
• 动态主机名生成：将获取的实例ID附加到SYSLOG_HOSTNAME环境变量的值后，形成包含实例标识的最终syslog主机名
• 向后兼容：未设置SYSLOG_HOSTNAME环境变量时，保持logspout默认主机名行为
• 轻量级修改：仅添加必要的实例ID获取逻辑，不影响logspout核心日志收集和转发功能

使用场景和适用范围

适用于AWS ECS集群环境中需要通过日志追踪容器运行节点的场景，特别推荐用于：

• 向外部日志管理服务（如Papertrail）发送日志时，快速定位容器所在的ECS集群节点
• 多节点ECS集群中，排查跨节点容器日志相关问题
• 需要在日志中体现基础设施层级上下文（节点标识）的监控场景

使用方法和配置说明

环境变量配置

Docker部署示例

基本运行命令

bash
docker run -e SYSLOG_HOSTNAME="ecs-container" \
  -v /var/run/docker.sock:/var/run/docker.sock \
  logspout-ecs

ECS任务定义片段

json
{
  "containerDefinitions": [
    {
      "name": "logspout-ecs",
      "image": "logspout-ecs",
      "essential": true,
      "environment": [
        {
          "name": "SYSLOG_HOSTNAME",
          "value": "my-ecs-service"
        }
      ],
      "mountPoints": [
        {
          "sourceVolume": "docker-sock",
          "containerPath": "/var/run/docker.sock"
        }
      ]
    }
  ],
  "volumes": [
    {
      "name": "docker-sock",
      "host": {
        "sourcePath": "/var/run/docker.sock"
      }
    }
  ]
}

注意事项

• 必须通过环境变量传入SYSLOG_HOSTNAME，否则实例ID附加逻辑不生效，行为与默认logspout一致
• 容器需要能够访问EC2元数据服务（通常通过http://169.254.169.254/latest/meta-data/instance-id），确保ECS任务的IAM角色或网络配置允许访问该服务
• 需挂载Docker socket（/var/run/docker.sock）以确保logspout能正常收集容器日志